APIs.io Engineering Platform Comments API

openapi: 3.2.0
info:
  title: APIs.io Engineering Platform Postman Comments API
  description: "The Postman API enables you to programmatically access data stored in your Postman account.\n\n> Certain endpoints may be unavailable depending on your region and/or Postman plan.\n\nFor a comprehensive set of examples of requests and responses, see the [**Postman API** collection](https://www.postman.com/postman/workspace/postman-public-workspace/documentation/12959542-c8142d51-e97c-46b6-bd77-52bb66712c9a).\n\n## Getting started\n\nYou can get started with the Postman API by creating a copy of this definition in your workspace.\n\n### EU users\n\nFor users in the EU with [**Enterprise** plans](https://www.postman.com/pricing/), the Postman API uses the `http://api.eu.postman.com` subdomain. This is available in the definition's list of servers. You can change this by selecting the `http://api.eu.postman.com` subdomain in the **Server** dropdown list below.\n\n## About the Postman API\n\n- You must use a valid API Key to send requests to the API endpoints.\n- The API has [rate and usage limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/).\n- The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP `301` redirect to the corresponding HTTPS resources.\n- The API returns requests responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.\n- The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman. The `POST` method implies you want to save something new to Postman.\n- For all requests, API calls respond with their corresponding [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). In the Postman client, the status code also provides help text that details the possible meaning of the response code.\n- When calling the API Builder endpoints, you must send an `Accept` header with the `application/vnd.api.v10+json` value.\n\n### IDs and UIDs\n\nAll items in Postman, such as collections, workspaces, and APIs, have IDs and UIDs:\n\n- An ID is the unique ID assigned to a Postman item. For example, `ec29121c-5203-409f-9e84-e83ffc10f226`.\n- The UID is the **full** ID of a Postman item. This value is the item's unique ID concatenated with the user ID. For example, in the `12345678-ec29121c-5203-409f-9e84-e83ffc10f226` UID:\n    - `12345678` is the user's ID.\n    - `ec29121c-5203-409f-9e84-e83ffc10f226` is the item's ID.\n\n### Enum values\n\nAny documented enum values should be considered partial lists and may change over time.\n\n### 403 response for unavailable features\n\nDepending on your region and/or Postman [plan](https://www.postman.com/pricing/), some endpoints will return an HTTP `403 Forbidden` response with the \"This feature isn't available in your region.\" detail.\n\n### 503 response\n\nAn HTTP `503 Service Unavailable` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes.\n\nIf the outage persists or you receive any other form of an HTTP `5XX` error, [contact support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Authentication\n\nPostman uses API keys for authentication. The API key tells the API server that the request came from you. Everything that you have access to in Postman is accessible with your API key. You can [generate](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-postman-api-key) a Postman API key in the [**API keys**](https://postman.postman.co/settings/me/api-keys) section of your Postman account settings.\n\nYou must include an API key in each request to the Postman API with the `X-API-Key` request header. In Postman, you can store your API key as a [vault secret](https://learning.postman.com/docs/sending-requests/postman-vault/postman-vault-secrets/) or an [environment variable](https://www.getpostman.com/docs/environments). The Postman API [collection](https://www.getpostman.com/docs/collections) will use it to make API calls.\n\n### SCIM authentication\n\nWhile all other endpoints in this collection require a Postman API key, the SCIM endpoints require a [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key).\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP `401 Unauthorized` response code.\n\n## Rate and usage limits\n\nAPI access [rate limits](https://learning.postman.com/docs/developer/postman-api/postman-api-rate-limits/) apply at a per-user basis in unit time. The limit is **300 requests per minute**. Postman Monitors, the GET `/collections`, and the GET `/workspaces` endpoint have a rate limit of **10 calls in 10 seconds**. Depending on your [plan](https://www.postman.com/pricing/), you may also have [usage limits](https://learning.postman.com/docs/billing/resource-usage/).\n\nWhen you reach your rate or usage limits, the API returns the following HTTP `429 Too Many Requests` status code with one of the following error responses:\n\n- `rateLimited` — Rate limits reached. The response returns the time after which you can resume calls to the Postman API.\n- `serviceLimitExhausted` — Postman API service limits reached. You will need to contact your Postman Team Admin for assistance.\n\n## Support\n\nFor help regarding accessing the Postman API, you can:\n\n- Visit [Postman Support](https://support.postman.com/hc/en-us) or our [Community and Support](https://www.postman.com/community/) sites.\n- Reach out to the [Postman community](https://community.postman.com/).\n- Submit a help request to [Postman support](https://support.postman.com/hc/en-us/requests/new/).\n\n## Policies\n\n- [Postman Terms of Service](http://www.postman.com/legal/terms/)\n- [Postman Privacy Policy](https://www.postman.com/legal/privacy-policy/)\n"
  version: '1.0'
  termsOfService: https://www.postman.com/legal/terms/
  contact:
    name: Postman Support
    email: help@postman.com
    url: https://www.postman.com/community/
servers:
- url: https://api.getpostman.com
- url: https://api.eu.postman.com
security:
- PostmanApiKey: []
- scimApiKey: []
tags:
- name: Comments
  description: The **Comments** endpoints enable you to manage comments on an API element. You can use [comments](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/discussing-your-work/) to collaborate and discuss your work with your teammates in Postman.
paths:
  /apis/{apiId}/comments:
    parameters:
    - $ref: '#/components/parameters/apiId'
    get:
      summary: APIs.io Engineering Platform Get an API's comments
      description: Gets all comments left by users in an API.
      operationId: getApiComments
      tags:
      - Comments
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create an API comment
      description: 'Creates a comment on an API.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Comments
      operationId: createApiComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /apis/{apiId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/apiId'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update an API's comment
      description: 'Updates a comment on an API.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateApiComment
      tags:
      - Comments
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete an API's comment
      description: 'Deletes a comment from an API. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteApiComment
      tags:
      - Comments
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/v10HeaderMissing'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403ErrorAndFeatureUnavailable'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    get:
      summary: APIs.io Engineering Platform Get a collection's comments
      description: Gets all comments left by users in a collection.
      operationId: getCollectionComments
      tags:
      - Comments
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a collection comment
      description: 'Creates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Comments
      operationId: createCollectionComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a collection's comment
      description: 'Updates a comment on a collection.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateCollectionComment
      tags:
      - Comments
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a collection's comment
      description: 'Deletes a comment from a collection. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteCollectionComment
      tags:
      - Comments
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/folders/{folderId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionFolderUid'
    get:
      summary: APIs.io Engineering Platform Get a folder's comments
      description: Gets all comments left by users in a folder.
      operationId: getFolderComments
      tags:
      - Comments
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a folder comment
      description: 'Creates a comment on a folder.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Comments
      operationId: createFolderComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/folders/{folderId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionFolderUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a folder's comment
      description: 'Updates a comment on a folder.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateFolderComment
      tags:
      - Comments
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a folder's comment
      description: 'Deletes a comment from a folder. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteFolderComment
      tags:
      - Comments
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/requests/{requestId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    get:
      summary: APIs.io Engineering Platform Get a request's comments
      description: Gets all comments left by users in a request.
      operationId: getRequestComments
      tags:
      - Comments
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a request comment
      description: 'Creates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Comments
      operationId: createRequestComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/requests/{requestId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionRequestUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a request's comment
      description: 'Updates a comment on a request.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateRequestComment
      tags:
      - Comments
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a request's comment
      description: 'Deletes a comment from a request. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteRequestComment
      tags:
      - Comments
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/responses/{responseId}/comments:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionResponseUid'
    get:
      summary: APIs.io Engineering Platform Get a response's comments
      description: Gets all comments left by users in a response.
      operationId: getResponseComments
      tags:
      - Comments
      responses:
        '200':
          $ref: '#/components/responses/commentGet'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    post:
      summary: APIs.io Engineering Platform Create a response comment
      description: 'Creates a comment on a response.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      tags:
      - Comments
      operationId: createResponseComment
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '201':
          $ref: '#/components/responses/commentCreated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /collections/{collectionId}/responses/{responseId}/comments/{commentId}:
    parameters:
    - $ref: '#/components/parameters/collectionUid'
    - $ref: '#/components/parameters/collectionResponseUid'
    - $ref: '#/components/parameters/commentId'
    put:
      summary: APIs.io Engineering Platform Update a response's comment
      description: 'Updates a comment on a response.


        **Note:**


        This endpoint accepts a max of 10,000 characters.

        '
      operationId: updateResponseComment
      tags:
      - Comments
      requestBody:
        $ref: '#/components/requestBodies/commentCreateUpdate'
      responses:
        '200':
          $ref: '#/components/responses/commentUpdated'
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
    delete:
      summary: APIs.io Engineering Platform Delete a response's comment
      description: 'Deletes a comment from a response. On success, this returns an HTTP `204 No Content` response.


        **Note:**


        Deleting the first comment of a thread deletes all the comments in the thread.

        '
      operationId: deleteResponseComment
      tags:
      - Comments
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/comment401Error'
        '403':
          $ref: '#/components/responses/comment403Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
  /comments-resolutions/{threadId}:
    post:
      summary: APIs.io Engineering Platform Resolve a comment thread
      description: 'Resolves a comment and any associated replies. On success, this returns an HTTP `204 No Content` response.


        Comment thread IDs return in the GET comments response for [APIs](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-2103ea20-f7de-4628-90e6-b823b3084a52), [collections](https://www.postman.com/postman/workspace/postman-public-workspace/request/12959542-a6582e0a-9382-4760-8b91-53a8aa6cb8d7), and [collection items](https://www.postman.com/postman/workspace/postman-public-workspace/folder/12959542-efeda219-66e1-474c-a83b-253d15723bf7).

        '
      operationId: resolveCommentThread
      tags:
      - Comments
      responses:
        '204':
          description: Successful Response
        '401':
          $ref: '#/components/responses/comment401Error'
        '404':
          $ref: '#/components/responses/comment404Error'
        '500':
          $ref: '#/components/responses/comment500Error'
      parameters:
      - $ref: '#/components/parameters/threadId'
components:
  requestBodies:
    commentCreateUpdate:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreateUpdate'
          examples:
            Create Comment:
              value:
                body: This is an example.
            Tag User in Comment:
              value:
                body: This is an example. @alex-cruz
                tags:
                  '@alex-cruz':
                    type: user
                    id: 12345678
  responses:
    comment403ErrorAndFeatureUnavailable:
      description: Forbidden
      content:
        application/json:
          schema:
            anyOf:
            - $ref: '#/components/schemas/comment403Error'
            - $ref: '#/components/schemas/featureUnavailable403Error'
          examples:
            Forbidden:
              $ref: '#/components/examples/comment403Error'
            Feature Unavailable:
              $ref: '#/components/examples/featureUnavailable403Error'
    v10HeaderMissing:
      description: Missing v10 Accept Header
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/v10HeaderMissing'
          examples:
            Missing v10 Accept Header:
              $ref: '#/components/examples/v10HeaderMissing'
    commentGet:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentResponse'
          example:
            data:
            - id: 46818
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T12:00:54.000Z'
              updatedAt: '2024-01-18T12:00:54.000Z'
              body: This is also an example.
            - id: 46817
              threadId: 67890
              createdBy: 87654321
              createdAt: '2024-01-18T11:48:01.000Z'
              updatedAt: '2024-01-18T11:48:01.000Z'
              body: Another example.
            - id: 46814
              threadId: 23456
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
    commentUpdated:
      description: Successful Response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              threadId: 12345
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an updated example.
    comment401Error:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/unauthorized
              title:
                type: string
                description: A short summary of the problem.
                example: Unauthorized
              detail:
                type: string
                description: Information about the error.
                example: Unauthorized
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 401
          example:
            type: https://api.postman.com/problems/unauthorized
            title: Unauthorized
            detail: Unauthorized
            status: 401
    commentCreated:
      description: Created
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/commentCreatedUpdated'
          example:
            data:
              id: 46814
              createdBy: 12345678
              createdAt: '2024-01-18T11:30:40.000Z'
              updatedAt: '2024-01-18T11:30:40.000Z'
              body: This is an example.
    comment500Error:
      description: Internal Server Error
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/internal-server-error
              title:
                type: string
                description: A short summary of the problem.
                example: Internal Server Error
              detail:
                type: string
                description: Information about the error.
                example: Internal Server Error
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 500
          example:
            type: https://api.postman.com/problems/internal-server-error
            title: Internal Server Error
            detail: Internal Server Error
            status: 500
    comment403Error:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/comment403Error'
          example:
            type: https://api.postman.com/problems/forbidden
            title: Forbidden
            detail: Forbidden
            status: 403
    comment404Error:
      description: Not Found
      content:
        application/problem+json:
          schema:
            type: object
            properties:
              type:
                type: string
                format: uri-reference
                description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
                example: https://api.postman.com/problems/not-found
              title:
                type: string
                description: A short summary of the problem.
                example: Not Found
              detail:
                type: string
                description: Information about the error.
                example: Not Found
              status:
                type: integer
                format: http-status-code
                description: The error's HTTP status code.
                example: 404
          example:
            type: https://api.postman.com/problems/not-found
            title: Not Found
            detail: Not Found
            status: 404
  parameters:
    threadId:
      name: threadId
      in: path
      required: true
      description: The comment's thread ID.
      schema:
        type: integer
        example: 34567
    collectionRequestUid:
      name: requestId
      in: path
      required: true
      description: The request's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-c82dd02c-4870-4907-8fcb-593a876cf05b
    collectionFolderUid:
      name: folderId
      in: path
      required: true
      description: The folder's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-65a99e60-8e0a-4b6e-b79c-7d8264cc5caa
    apiId:
      name: apiId
      in: path
      required: true
      description: The API's ID.
      schema:
        type: string
        example: 90ca9f5a-c4c4-11ed-afa1-0242ac120002
    collectionResponseUid:
      name: responseId
      in: path
      required: true
      description: The response's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-cc364734-7dfd-4bfc-897d-be763dcdbb07
    commentId:
      name: commentId
      in: path
      required: true
      description: The comment's ID.
      schema:
        type: integer
        example: 46814
    collectionUid:
      name: collectionId
      in: path
      required: true
      description: The collection's unique ID.
      schema:
        type: string
        format: uid
        example: 12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2
  examples:
    comment403Error:
      value:
        type: https://api.postman.com/problems/forbidden
        title: Forbidden
        detail: Forbidden
        status: 403
    v10HeaderMissing:
      value:
        name: instanceNotFoundError
       

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/engineering-platform/refs/heads/main/openapi/engineering-platform-comments-api-openapi.yml