{
  "opencollection": "1.0.0",
  "info": {
    "name": "ChartHop access comment API",
    "version": "V1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "comment",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Post a comment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/org/:orgId/comment",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              }
            ]
          },
          "docs": "Post a comment"
        },
        {
          "info": {
            "name": "Return comments on changes within a comp review, paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/comp-review/:compReviewId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "compReviewId",
                "value": "",
                "type": "path",
                "description": "Comp review id"
              },
              {
                "name": "approvalRequestId",
                "value": "",
                "type": "query",
                "description": "Approval request id"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Comment id to start paginating from"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              },
              {
                "name": "desc",
                "value": "",
                "type": "query",
                "description": "Descending (default false)"
              },
              {
                "name": "isPreview",
                "value": "",
                "type": "query",
                "description": "Whether comments are viewed in preview mode, defaults false"
              },
              {
                "name": "jobId",
                "value": "",
                "type": "query",
                "description": "Optional preview user jobId"
              },
              {
                "name": "returnAccess",
                "value": "",
                "type": "query",
                "description": "Return access information -- pass a list of actions to check, for example: create,update,delete"
              }
            ]
          },
          "docs": "Return comments on changes within a comp review, paginated"
        },
        {
          "info": {
            "name": "Return comments on a particular entity paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/entity/:entityId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "path",
                "description": "Entity id"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Comment id to start paginating from"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              },
              {
                "name": "desc",
                "value": "",
                "type": "query",
                "description": "Descending (default false)"
              },
              {
                "name": "returnAccess",
                "value": "",
                "type": "query",
                "description": "Return access information -- pass a list of actions to check, for example: create,update,delete"
              }
            ]
          },
          "docs": "Return comments on a particular entity paginated"
        },
        {
          "info": {
            "name": "Return comments on a scenario and the changes within, paginated",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/scenario/:scenarioId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "scenarioId",
                "value": "",
                "type": "path",
                "description": "Scenario id"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Comment id to start paginating from"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Number of results to return"
              },
              {
                "name": "desc",
                "value": "",
                "type": "query",
                "description": "Descending (default false)"
              },
              {
                "name": "includeChangeComments",
                "value": "",
                "type": "query",
                "description": "Whether to also include comments on changes within the scenario (default false)"
              },
              {
                "name": "returnAccess",
                "value": "",
                "type": "query",
                "description": "Return access information -- pass a list of actions to check, for example: create,update,delete"
              }
            ]
          },
          "docs": "Return comments on a scenario and the changes within, paginated"
        },
        {
          "info": {
            "name": "Return a particular comment by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/:commentId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "Comment id"
              }
            ]
          },
          "docs": "Return a particular comment by id"
        },
        {
          "info": {
            "name": "Update a comment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/:commentId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "Comment id"
              }
            ]
          },
          "docs": "Update a comment"
        },
        {
          "info": {
            "name": "Delete a comment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/org/:orgId/comment/:commentId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Org identifier (either id or slug)"
              },
              {
                "name": "commentId",
                "value": "",
                "type": "path",
                "description": "Comment id"
              }
            ]
          },
          "docs": "Delete a comment"
        }
      ]
    }
  ],
  "bundled": true
}