{
  "opencollection": "1.0.0",
  "info": {
    "name": "Process Street Public Attachments Comments API",
    "version": "1.1"
  },
  "items": [
    {
      "info": {
        "name": "Comments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all comments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.process.st/api/v1.1/comments",
            "params": [
              {
                "name": "workflowId",
                "value": "",
                "type": "query",
                "description": "Filter by workflow."
              },
              {
                "name": "workflowRunId",
                "value": "",
                "type": "query",
                "description": "Filter by workflow run."
              },
              {
                "name": "taskId",
                "value": "",
                "type": "query",
                "description": "Filter by task."
              },
              {
                "name": "_",
                "value": "",
                "type": "query",
                "description": "Opaque pagination cursor. Take this value from the previous response's `links[]` entry whose `name`\nis `\"next\"` (typically just follow that link's `href` instead of reading this value).\nOmit on the first page. If the previous response had no `next` link, there are no more pages."
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a paginated list of comments sorted by creation date (newest first). Provide either `workflowId`, or `workflowRunId` with optional `taskId`."
        },
        {
          "info": {
            "name": "Create a comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://public-api.process.st/api/v1.1/comments",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Creates a comment on a task within a workflow run."
        },
        {
          "info": {
            "name": "Get a comment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://public-api.process.st/api/v1.1/comments/:commentId",
            "params": [
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "The ID of the Comment"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns a comment by its ID."
        },
        {
          "info": {
            "name": "Update a comment",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://public-api.process.st/api/v1.1/comments/:commentId",
            "params": [
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "The ID of the Comment"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Updates the text of an existing comment."
        },
        {
          "info": {
            "name": "Delete a comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://public-api.process.st/api/v1.1/comments/:commentId",
            "params": [
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "The ID of the Comment"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-API-Key",
              "value": "{{X-API-Key}}",
              "placement": "header"
            }
          },
          "docs": "Deletes an existing comment."
        }
      ]
    }
  ],
  "bundled": true
}