openapi: 3.1.0
info:
  title: API Reference
  version: 1.0.0
paths:
  /analytics:
    get:
      operationId: getAnalyticsData
      summary: Get analytics data
      description: >
        Gets analytics data based on the specified resource, metrics, and given filters for team, internal, and public
        workspaces, as well as Partner Workspaces.


        **Note:**


        This endpoint only accepts the following resource:metric query parameter combinations:

        - `user` — `workspace_active_users`, `active_users`

        - `workspace` — `elements_in_workspace`, `active_workspaces`, `api_calls`, `active_collections`,
        `response_status`, `pending_invites`, `needs_attention`, `success_rate`, `user_requests`,
        `collection_error_aggregate`

        - `team` — `user_api_journey`, `workspace_distribution`, `internal_workspace_distribution`,
        `license_consumption`, `members`, `last_autoflex_cycle`, `partner_engagement_funnel` `members_overtime` ,
        `member_invites`, `invites_sent` , `invites_accepted`

        - `ai` — `top_agent_models_by_usage`, `activity_distribution`, `peak_activity`, `usage_leaderboard`,
        `credit_usage_by_model`, `messages_sent`, `credit_usage`, `agent_mode_sessions`, `new_vs_returning_users`,
        `agent_mode_users`

        - `api_development` — `active_workspaces`, `entity_activity`, `top_entities`

        - `api_testing` — `runs`, `functional_test_runs`, `performance_test_runs`

        - `api_production` — `monitor_runs`, `flow_executions`

        - `api_distribution` — `active_workspaces`, `pvt_network`, `partner`, `public`

        - `api_management` — `workspace_activity`


        The `view` query parameter only accepts the following values when called with the following resource:metric
        pairs:

        `detailed` or `summary` — `user:active_users`, `workspace:active_workspaces`, `workspace:pending_invites`,
        `workspace:needs_attention`, `workspace:success_rate`, `team:partner_engagement_funnel`,
        `api_distribution:pvt_network`, `api_distribution:partner`, `api_distribution:public`

        - `detailed`, `summary`, or `trends` — `api_development:entity_activity`, `api_testing:functional_test_runs` ,
        `api_testing:performance_test_runs`, `api_production:monitor_runs`, `api_production:flow_executions`

        - `summary` or `trend` — `api_development:active_workspaces`, `api_testing:runs`,
        `api_distribution:active_workspaces`, `api_management:workspace_activity`

        - `summary` only — `workspace:elements_in_workspace`, `workspace:workspace_active_users`, `workspace:api_calls`,
        `workspace:response_status`, `team:user_api_journey`, `team:workspace_distribution`,
        `team:internal_workspace_distribution`, `team:license_consumption`

        - `detailed` only — `workspace:active_collections`, `workspace:user_requests`, `api_development:top_entities`,
        `api_management:popular_workspaces` , `team:invites_sent` , `team:invites_accepted`

        - `trend` only — `team:members_overtime`, `team:member_invites`
      tags:
        - analytics
      parameters:
        - name: resource
          in: query
          description: >
            Returns metrics and insights for API usage, success, and workspace/team trends in Postman:


            - `user` — Data related to individual user activities and engagement within Postman workspaces.

            - `team` — Team-level analytics, license consumption, and organizational trends.

            - `workspace` — Workspace-level activities, elements, and collaboration patterns.

            - `ai` — Analytics related to Agent Mode usage across workspaces, covering user activity, model usage, and
            credit consumption patterns.

            - `api_development` — API development activity metrics that include workspace counts, entity activity by
            type (collection, flow, mock, specification, sdk), and top entities.

            - `api_testing` — API testing metrics such as total test runs, functional test runs (Collection Runner), and
            performance test runs.

            - `api_production` — API production metrics, including monitor run activity and production flow execution
            activity.

            - `api_distribution` — API distribution metrics, such as active workspace counts across distribution
            channels.

            - `api_management` — API management metrics, such as workspace activity, active counts, trends, and top
            workspaces.
          required: true
          schema:
            $ref: '#/components/schemas/analyticsResource'
        - name: metrics
          in: query
          description: |
            Filters the response by only the given metrics. The metric must match the given `resource` value.

            For a list of metrics and their related `resource` value, call the GET `/analytics-metadata` endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/analyticsMetrics'
        - name: view
          in: query
          description: |
            The view type for the analytics data:
              - `detailed` — Return extensive information.
              - `summary` — Return aggregated information.
              - `trend` — Return trend information over a duration.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsView'
        - name: workspaceType
          in: query
          description: A comma-separated list of `internal`, `public`, and `partner` workspace types to filter the results by.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsWorkspaceType'
        - name: userId
          in: query
          description: >-
            A comma-separated list of user IDs to filter the results by. Only pass this parameter when calling the
            `user_requests` metric for the `workspace` resource.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsUserId'
        - name: duration
          in: query
          description: Filters the response by the given duration.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsDuration'
        - name: requestId
          in: query
          description: >-
            A comma-separated list of unique request IDs (`userId`-`requestId`) to filter the response by. Only pass
            this parameter when using the `user_requests` metric.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsRequestId'
        - name: responseStatus
          in: query
          description: >-
            A comma-separated list of HTTP response status codes to filter the results by. Accepts values `100` through
            `600`. Only pass this parameter when using the `user_requests` metric.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsResponseStatus'
        - name: attentionType
          in: query
          description: >-
            A comma-separated list of issues types to filter the results by. Attention types provide details about
            issues users or partners are facing. Accepts the `high_non_200OK_rate_for_partner` and
            `no_success_on_tried_request` values. Only pass this parameter when using the `needs_attention` metric.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsAttentionType'
        - name: period
          in: query
          description: >-
            Filters results for a given period of time (as opposed to a range) for supported views. Use a YEAR-MONTH
            value for month filtering or YEAR-MONTH-DAY day filtering.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsPeriod'
        - name: userType
          in: query
          description: Filters results by a specific user type for supported views.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsUserType'
        - name: entityType
          in: query
          description: The type of Postman entity to filter results by.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsEntityType'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault100Max10000'
            default: 100
        - name: offset
          in: query
          description: The zero-based offset of the first item to return.
          required: false
          schema:
            $ref: '#/components/schemas/offsetMax10000'
            default: 0
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAnalyticsData'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAnalyticsDataRequestInternalServerError'
  /analytics-metadata:
    get:
      operationId: getAnalyticsMetadata
      summary: Get analytics metadata
      description: >-
        Returns a catalog of analytics resources and their corresponding metrics for use with the GET /analytics
        endpoint. These metrics provide insights on API usage, success, workspace, and team trends in Postman.
      tags:
        - analytics
      parameters:
        - name: include
          in: query
          description: >
            A comma-separated list of the additional information to include in the response. Accepts the `parameters`
            and `response` values.


            When you pass this query parameter and its values, the response provides detailed information, including
            parameters and response schemas for the given metrics.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsMetadataInclude'
        - name: resources
          in: query
          description: >-
            A comma-separated list of resource types to filter the metrics by. Accepts the `user`, `workspace`, `team`,
            and `ai` values.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsMetadataResources'
        - name: metrics
          in: query
          description: |
            A comma-separated list of metrics values to use to filter the response.

            If you don't pass this query parameter, then the response returns all metadata for all available metrics.
          required: false
          schema:
            $ref: '#/components/schemas/analyticsMetrics'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAnalyticsMetadata'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAnalyticsMetadataRequestInternalServerError'
  /apis:
    get:
      operationId: getApis
      summary: Get all APIs
      description: Gets information about all APIs in a workspace.
      tags:
        - api
      parameters:
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: createdBy
          in: query
          description: Return only results created by the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/createdBy'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: description
          in: query
          description: Return only APIs whose description includes the given value. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/apiDescription'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApis'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApisRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApisRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApisRequestNotFoundError'
        '422':
          description: v9 Unsupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApisRequestInternalServerError'
      deprecated: true
    post:
      operationId: createApi
      summary: Create an API
      description: Creates an API.
      tags:
        - api
      parameters:
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createApiResponse'
        '400':
          description: Missing Workspace ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createUpdateApi'
  /apis/{apiId}:
    get:
      operationId: getApi
      summary: Get an API
      description: >
        Gets information about an API.


        **Note:**


        - Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and
        collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository
        and folder locations of the files.

        - API viewers can only use the `versions` option in the `include` query parameter.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: include
          in: query
          description: >
            An array that contains additional resources to include in the response. Use this parameter to query for
            element links to the API, such as collections and schemas:

            - `collections` — Query for linked Postman collections.

            - `versions` — Query for linked versions.

            - `schemas` — Query for linked schemas.

            - `gitInfo` — Query for information about the API's git-linked repository. This query only returns the
            linked repository and folder locations of the files. It does not return `collections` or `schemas`
            information.


            **Note:**


            API viewers can only use the `versions` option.
          required: false
          schema:
            $ref: '#/components/schemas/apiInclude'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApi'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiRequestNotFoundError'
        '422':
          description: v9 Unsupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiRequestInternalServerError'
      deprecated: true
    put:
      operationId: updateApi
      summary: Update an API
      description: Updates an API.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateApiResponse'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiRequestNotFoundError'
        '422':
          description: v9 Unsupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createUpdateApi'
    delete:
      operationId: deleteApi
      summary: Delete an API
      description: Deletes an API. On success, this returns an HTTP `204 No Content` response.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiRequestNotFoundError'
        '422':
          description: v9 Unsupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/collections:
    post:
      operationId: addApiCollection
      summary: Add a collection
      description: |
        Adds a collection to an API. To do this, use the following `operationType` values:

        - `COPY_COLLECTION` — Copies a collection from the workspace and adds it to an API.
        - `CREATE_NEW` — Creates a new collection by providing the new collection's content.
        - `GENERATE_FROM_SCHEMA` — Generates the collection from an API schema.
            - `options` — An object that contains advanced creation options and their values. You can find a complete list of properties and their values in Postman's [OpenAPI to Postman Collection Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties are case-sensitive.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addApiCollectionResponse'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiCollectionRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiCollectionRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API_addApiCollection_Request'
  /apis/{apiId}/collections/{collectionId}:
    get:
      operationId: getApiCollection
      summary: Get a collection
      description: >
        Gets a collection attached to an API. You can use the `versionId` query parameter to get a collection published
        in a version.


        **Note:**


        - You cannot use this endpoint to get a Git-linked API collection. Collections in a Git-linked API are stored in
        the linked Git repository, not in the Postman cloud. This endpoint only has access to Postman servers.

        - You can get a collection published in an API version with the `versionId` query parameter.

        - The `versionId` query parameter is a required parameter for API viewers.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: versionId
          in: query
          description: The API's version ID. This is a required parameter for API viewers.
          required: false
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCollection'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCollectionRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCollectionRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCollectionRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/collections/{collectionId}/comments:
    get:
      operationId: getApiCollectionComments
      summary: Get a collection's comments
      description: Gets all comments left by users in an API's collection.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
    post:
      operationId: createApiCollectionComment
      summary: Create a collection comment
      description: >
        Creates a comment on an API's collection. To create a reply on an existing comment, include the `threadId`
        property in the request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /apis/{apiId}/collections/{collectionId}/comments/{commentId}:
    put:
      operationId: updateApiCollectionComment
      summary: Update a collection's comment
      description: |
        Updates a comment on an API's collection.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteApiCollectionComment
      summary: Delete a collection's comment
      description: |
        Deletes a comment from an API's 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.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
  /apis/{apiId}/collections/{collectionId}/sync-with-schema-tasks:
    put:
      operationId: syncCollectionWithSchema
      summary: Sync collection with schema
      description: >
        Syncs a collection attached to an API with the API schema.


        This is an asynchronous endpoint that returns an HTTP `202 Accepted` response. The response contains a polling
        link to the `/apis/{apiId}/tasks/{taskId}` endpoint in the `Location` header.


        **Note:**


        This endpoint only supports the OpenAPI 3 schema type.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionIdApi'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/syncCollectionWithSchemaResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSchemaRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSchemaRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSchemaRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSchemaRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/comments:
    get:
      operationId: getApiComments
      summary: Get an API's comments
      description: Gets all comments left by users in an API.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
    post:
      operationId: createApiComment
      summary: Create an API comment
      description: >
        Creates a comment on an API. To create a reply on an existing comment, include the `threadId` property in the
        request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /apis/{apiId}/comments/{commentId}:
    put:
      operationId: updateApiComment
      summary: Update an API's comment
      description: |
        Updates a comment on an API.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteApiComment
      summary: 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.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      deprecated: true
  /apis/{apiId}/schemas:
    post:
      operationId: createApiSchema
      summary: Create a schema
      description: Creates a schema for an API.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createApiSchemaResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiSchemaRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiSchemaRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiSchemaRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiSchemaRequestInternalServerError'
      deprecated: true
      requestBody:
        description: The request body to create an API schema.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createApiSchema'
  /apis/{apiId}/schemas/{schemaId}:
    get:
      operationId: getApiSchema
      summary: Get a schema
      description: >
        Gets information about API schema. You can use the `versionId` query parameter to get a schema published in an
        API version.


        You can use this API to do the following:


        - Get a schema's metadata.

        - Get all the files in a schema. This only returns the first file in the schema. The endpoint response contains
        a link to the next set of response results.

        - Get a schema's contents in multi-file or bundled format.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: schemaId
          in: path
          description: The API schema's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiSchemaId'
        - name: versionId
          in: query
          description: The API's version ID. This is a required parameter for API viewers.
          required: false
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: bundled
          in: query
          description: If true, return the schema in a bundled format.
          required: false
          schema:
            $ref: '#/components/schemas/apiSchemaOutput'
            default: false
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiSchema'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/schemas/{schemaId}/files:
    get:
      operationId: getApiSchemaFiles
      summary: Get schema files
      description: >
        Gets the files in an API schema. You can use the `versionId` query parameter to get schema files published in an
        API version.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: schemaId
          in: path
          description: The API schema's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiSchemaId'
        - name: versionId
          in: query
          description: The API's version ID. This is a required parameter for API viewers.
          required: false
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiSchemaFiles'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFilesRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFilesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFilesRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFilesRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/schemas/{schemaId}/files/{file-path}:
    get:
      operationId: getApiSchemaFileContents
      summary: Get schema file contents
      description: >
        Gets an API schema file contents at the defined path. You can use the `versionId` query parameter to get schema
        file contents published in an API version.


        **Note:**


        The `versionId` query parameter is a required parameter for API viewers.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: schemaId
          in: path
          description: The API schema's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiSchemaId'
        - name: file-path
          in: path
          description: The path to the schema file.
          required: true
          schema:
            $ref: '#/components/schemas/file-path'
        - name: versionId
          in: query
          description: The API's version ID. This is a required parameter for API viewers.
          required: false
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiSchemaFileContents'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFileContentsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFileContentsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFileContentsRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiSchemaFileContentsRequestInternalServerError'
      deprecated: true
    put:
      operationId: createUpdateApiSchemaFile
      summary: Create or update a schema file
      description: >
        Creates or updates an API schema file.


        **Note:**


        - If the provided file path exists, the file is updated with the new contents.

        - If the provided file path does not exist, then a new schema file is created.

        - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the file
        path is the `dir/schema.json` value, then a `dir` folder is created with the `schema.json` file inside.

        - You can only update the `root` tag for protobuf specifications.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: schemaId
          in: path
          description: The API schema's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiSchemaId'
        - name: file-path
          in: path
          description: The path to the schema file.
          required: true
          schema:
            $ref: '#/components/schemas/file-path'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUpdateApiSchemaFileResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUpdateApiSchemaFileRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUpdateApiSchemaFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUpdateApiSchemaFileRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUpdateApiSchemaFileRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createUpdateApiSchemaFile'
    delete:
      operationId: deleteApiSchemaFile
      summary: Delete a schema file
      description: Deletes a file in an API schema. On success, this returns an HTTP `204 No Content` response.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: schemaId
          in: path
          description: The API schema's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiSchemaId'
        - name: file-path
          in: path
          description: The path to the schema file.
          required: true
          schema:
            $ref: '#/components/schemas/file-path'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '204':
          description: Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiSchemaFileRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiSchemaFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiSchemaFileRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiSchemaFileRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/tasks/{taskId}:
    get:
      operationId: getStatusOfAnAsyncApiTask
      summary: Get status of an asynchronous task
      description: Gets the status of an asynchronous task.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: taskId
          in: path
          description: The task's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiTaskId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getStatusOfAnAsyncApiTask'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskRequestForbiddenError'
        '404':
          description: Task Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskRequestInternalServerError'
      deprecated: true
  /apis/{apiId}/versions:
    get:
      operationId: getApiVersions
      summary: Get all versions
      description: Gets all the published versions of an API.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiVersions'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionsRequestNotFoundError'
        '422':
          description: v9 Unsupported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionsRequestInternalServerError'
      deprecated: true
    post:
      operationId: createApiVersion
      summary: Create a version
      description: >
        Creates a new API version asynchronously and immediately returns an HTTP `202 Accepted` response. The response
        contains a polling link to the task status API in the `Location` header.


        This endpoint is equivalent to publishing a version in Postman app, which is the snapshot of API collections and
        schema at a given point in time.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createApiVersionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiVersionRequestNotFoundError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiVersionRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/API_createApiVersion_Request'
  /apis/{apiId}/versions/{versionId}:
    get:
      operationId: getApiVersion
      summary: Get a version
      description: >
        Gets information about an API version.


        **Note:**


        - For API editors, this endpoint returns an HTTP `302 Found` status code when the version status is pending. It
        also returns the `/apis/{apiId}/tasks/{taskId}` task status response header.

        - For API viewers, this endpoint returns an HTTP `404 Not Found` when the version status is pending.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: versionId
          in: path
          description: The API's version ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiVersion'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiVersionRequestInternalServerError'
      deprecated: true
    put:
      operationId: updateApiVersion
      summary: Update a version
      description: |
        Updates an API version.

        **Note:**

        This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: versionId
          in: path
          description: The API's version ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateApiVersionResponse'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiVersionRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiVersionRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateApiVersion'
    delete:
      operationId: deleteApiVersion
      summary: Delete a version
      description: |
        Deletes an API version. On success, this returns an HTTP `204 No Content` response.

        **Note:**

        This endpoint returns an HTTP `404 Not Found` response when an API version is pending publication.
      tags:
        - api
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: versionId
          in: path
          description: The API's version ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiVersionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiVersionRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiVersionRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiVersionRequestInternalServerError'
      deprecated: true
  /api-catalog/discovery-services:
    get:
      operationId: getApiCatalogDiscoveryServices
      summary: Get discovered services
      description: >-
        Gets a list of all [discovered
        services](https://learning.postman.com/docs/api-catalog/overview#discover-apis-and-services) in the API Catalog.
      tags:
        - apiCatalog
      parameters:
        - name: discoverySource
          in: query
          description: |
            Filter results by the given discovery source type:
            - `api_gateway_app` — API Gateway integrations.
            - `insights_project` — Postman Insights.
            - `infra_watcher` — Cluster Watcher.
            - `public_api` — Services manually added using the POST `/api-catalog/discovery-services` endpoint.
          required: false
          schema:
            $ref: '#/components/schemas/discoveryServicesSource'
        - name: status
          in: query
          description: >-
            A comma-separated list of statuses to filter the results by. Accepts the `discovered`, `integrated`, and
            `archived` values.
          required: false
          schema:
            $ref: '#/components/schemas/discoveryServicesStatus'
        - name: search
          in: query
          description: Filter results by the given value that match a service's name. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/discoveryServicesSearch'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogDiscoveryServices'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogDiscoveryServicesRequestInternalServerError'
    post:
      operationId: postApiCatalogDiscoveryServices
      summary: Add discovered services to the API Catalog
      description: Adds discovered services to the API Catalog. Accepts up to 20 services in a single call.
      tags:
        - apiCatalog
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postApiCatalogDiscoveryServicesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiCatalogDiscoveryServicesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiCatalogDiscoveryServices'
  /api-catalog/discovery-services/{serviceId}:
    get:
      operationId: getApiCatalogDiscoveryService
      summary: Get a discovered service's information
      description: >-
        Gets detailed information about a discovered service, including a base64-encoded OpenAPI specification and an
        array of endpoints.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The discovered service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogDiscoveryService'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogDiscoveryServiceRequestInternalServerError'
  /api-catalog/services:
    get:
      operationId: getApiCatalogServices
      summary: Get all services
      description: >-
        Gets a list of services in a system environment. The response includes details about analytics, compliance, and
        governance metadata.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: query
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: name
          in: query
          description: Filter results to the given the service name. This is case-insensitive.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceNameFilter'
        - name: tags
          in: query
          description: A comma-separated list of tag names to filter by.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceTagsFilter'
        - name: governanceGroupId
          in: query
          description: Filter results to only services that belong to the given governance group ID.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceGovernanceGroupIdFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogServices'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServicesRequestInternalServerError'
  /api-catalog/services/{serviceId}:
    get:
      operationId: getApiCatalogService
      summary: Get a service by ID
      description: Gets information about a service, including its health, traffic, compliance, ownership, and dependencies.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: systemEnvironmentId
          in: query
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogService'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServiceRequestInternalServerError'
  /api-catalog/services/{serviceId}/endpoints:
    get:
      operationId: getApiCatalogServiceEndpoints
      summary: Get a service's endpoints
      description: Get a list of observed API endpoints for a service and its performance metrics.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: systemEnvironmentId
          in: query
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: httpMethods
          in: query
          description: A.comma-separated list of HTTP methods to filter the results by.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceHttpMethodFilter'
        - name: hosts
          in: query
          description: A comma-separated list of hostnames to filter the results by.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceHostsFilter'
        - name: responseCodes
          in: query
          description: A comma-separated list of HTTP status codes to filter the results by.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceResponseCodeFilter'
        - name: search
          in: query
          description: Filter results to the search filter given on the endpoint's path.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSearchFilter'
        - name: sort
          in: query
          description: >-
            Sort the results in field:direction order format. Accepts the `count`, `endpoint`, `p95LatencyMs`, and
            `errorRate` fields. Supports the `asc` and `desc` directions.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSortEndpointsFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogServiceEndpoints'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServiceEndpointsRequestInternalServerError'
  /api-catalog/services/{serviceId}/monitor-runs:
    get:
      operationId: getApiCatalogServiceMonitorRuns
      summary: Get a service's monitor runs
      description: Gets a list of scheduled monitor runs for a service that includes summary statistics.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: systemEnvironmentId
          in: query
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: collectionId
          in: query
          description: Filter results to only the given collection ID's runs.
          required: false
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: sort
          in: query
          description: >-
            Sort the results in field:direction order format. Accepts the `timestamp`, `duration`, and
            `failedAssertions` fields. Supports the `asc` and `desc` directions.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSortMonitorRun'
        - name: environmentId
          in: query
          description: Filter results to only the given environment ID runs.
          required: false
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: status
          in: query
          description: Filter results by run status.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceStatusFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogServiceMonitorRuns'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServiceMonitorRunsRequestInternalServerError'
  /api-catalog/services/{serviceId}/spec-lints:
    get:
      operationId: getApiCatalogServiceSpecificationLints
      summary: Get a service's specification lints
      description: >-
        Gets a list of API specification lint runs for a service that includes summary statistics and per-severity issue
        counts.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: specId
          in: query
          description: Filter results to the given API specification ID.
          required: false
          schema:
            $ref: '#/components/schemas/specId'
        - name: severity
          in: query
          description: >-
            Filter results to runs with issues at or above the given severity threshold. Higher severities are always
            included.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSpecLintSeverityFilter'
        - name: status
          in: query
          description: Filter results to the given spec lint outcome.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceStatusFilter'
        - name: sort
          in: query
          description: >-
            Sort the results in field:direction order format. Accepts the `timestamp` and `errorCount` fields. Supports
            the `asc` and `desc` directions.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSortSpecLintFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogServiceSpecificationLints'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServiceSpecificationLintsRequestInternalServerError'
  /api-catalog/services/{serviceId}/ci-runs:
    get:
      operationId: getApiCatalogServiceCiRuns
      summary: Get a service's CI runs
      description: >-
        Gets a paginated list of CI collection runs for a service that includes summary statistics, pipeline details,
        and Git metadata.
      tags:
        - apiCatalog
      parameters:
        - name: serviceId
          in: path
          description: The service's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serviceId'
        - name: systemEnvironmentId
          in: query
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: collectionId
          in: query
          description: Filter results to only the given collection ID's runs.
          required: false
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: environmentId
          in: query
          description: Filter results to only the given environment ID runs.
          required: false
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: status
          in: query
          description: Filter results by run status.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceStatusFilter'
        - name: branch
          in: query
          description: Filter results by the given Git branch name.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceBranchFilter'
        - name: workflowName
          in: query
          description: Filter results by the given CI workflow name.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceWorkflowNameFilter'
        - name: actor
          in: query
          description: Filter results by the given CI user that triggered the run.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceActorFilter'
        - name: repoName
          in: query
          description: Filter results by the given repository name.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceRepoNameFilter'
        - name: repoOwner
          in: query
          description: Filter results by the given repository owner.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceRepoOwnerFilter'
        - name: sort
          in: query
          description: >-
            Sort the results in field:direction order format. Accepts the `timestamp` and `duration` fields. Supports
            the `asc` and `desc` directions.
          required: false
          schema:
            $ref: '#/components/schemas/apiCatalogServiceSortCiFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogServiceCiRuns'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiCatalogError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogServiceCiRunsRequestInternalServerError'
  /api-catalog/system-environments:
    get:
      operationId: getApiCatalogSystemEnvironments
      summary: Get all system environments
      description: Gets all of the authenticated team's system environments.
      tags:
        - apiCatalog
      parameters:
        - name: isProduction
          in: query
          description: If true, filters the response results to return only system environments marked as production.
          required: false
          schema:
            $ref: '#/components/schemas/systemEnvironmentProductionFilter'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogSystemEnvironments'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentsRequestInternalServerError'
    post:
      operationId: createApiCatalogSystemEnvironment
      summary: Create a system environment
      description: Creates a system environment for the authenticated team.
      tags:
        - apiCatalog
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createApiCatalogSystemEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiCatalogSystemEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateApiCatalogSystemEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createApiCatalogSystemEnvironment'
  /api-catalog/system-environments/{systemEnvironmentId}:
    get:
      operationId: getApiCatalogSystemEnvironment
      summary: Get a system environment
      description: Gets information about a system environment.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: path
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogSystemEnvironment'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentRequestInternalServerError'
    patch:
      operationId: updateApiCatalogSystemEnvironment
      summary: Update a system environment
      description: |
        Updates a system environment's information. You can update one or more fields in a single call.

        **Note:**

        If you update the name, it must be unique within the team.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: path
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateApiCatalogSystemEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiCatalogSystemEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiCatalogSystemEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateApiCatalogSystemEnvironment'
  /api-catalog/system-environments/{systemEnvironmentId}/associations:
    get:
      operationId: getApiCatalogSystemEnvironmentAssociations
      summary: Get a system environment's associations
      description: Gets the workspace-environment associations for a system environment.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: path
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: workspaceId
          in: query
          description: The workspace's ID to which the environments in the association belong to.
          required: false
          schema:
            $ref: '#/components/schemas/systemEnvironmentWorkspaceId'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault20'
            default: 20
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getApiCatalogSystemEnvironmentAssociations'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentAssociationsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiCatalogSystemEnvironmentAssociationsRequestInternalServerError'
    post:
      operationId: addApiCatalogSystemEnvironmentAssociations
      summary: Add system environment associations
      description: Adds workspace-environment associations to a system environment.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: path
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: allowPartial
          in: query
          description: >-
            If false, the system only adds associations when there are no status errors. If true, the system skips any
            ineligible associations and adds eligible associations.
          required: false
          schema:
            $ref: '#/components/schemas/systemEnvironmentAllowPartial'
            default: false
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiCatalogSystemEnvironmentAssociationsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddApiCatalogSystemEnvironmentAssociationsRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociations'
    delete:
      operationId: removeApiCatalogSystemEnvironmentAssociations
      summary: Remove system environment associations
      description: Removes workspace-environment associations from a system environment.
      tags:
        - apiCatalog
      parameters:
        - name: systemEnvironmentId
          in: path
          description: The system environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/systemEnvironmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveApiCatalogSystemEnvironmentAssociationsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveApiCatalogSystemEnvironmentAssociationsRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociations'
  /security/api-validation:
    post:
      operationId: schemaSecurityValidation
      summary: API definition security validation
      description: >
        Performs an analysis on the given definition and returns any issues based on your [predefined
        rulesets](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/).
        This endpoint can help you understand the violations' impact and offers solutions to help you resolve any
        errors. You can include this endpoint to your CI/CD process to automate schema validation.


        **Note:**


        - The maximum allowed size of the definition is 10 MB.

        - You must [import and
        enable](https://learning.postman.com/docs/api-governance/configurable-rules/configuring-api-governance-rules/)
        Postman's [OWASP security rules](https://postman.postman.co/api-governance/libraries/postman_owasp/view) for
        this endpoint to return any security rule violations.
      tags:
        - apiSecurity
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemaSecurityValidationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameObjectNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaSecurityValidationRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaSecurityValidationRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaSecurityValidationRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemaSecurityValidationRequest'
  /audit/logs:
    get:
      operationId: getAuditLogs
      summary: Get team audit logs
      description: >-
        Gets a list of your team's generated audit events. For a complete list of all audit events, see [Audit
        logs](https://learning.postman.com/docs/administration/audit-logs/).
      tags:
        - auditLogs
      parameters:
        - name: userId
          in: query
          description: Return only results that match the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/auditLogsUserIdQuery'
        - name: action
          in: query
          description: Filter results by an audit log action.
          required: false
          schema:
            $ref: '#/components/schemas/auditLogsActionQuery'
        - name: since
          in: query
          description: Return logs created after the given time, in `YYYY-MM-DD` format.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateQuery'
        - name: until
          in: query
          description: Return logs created before the given time, in `YYYY-MM-DD` format.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateQuery'
        - name: limit
          in: query
          description: The maximum number of audit events to return at once.
          required: false
          schema:
            $ref: '#/components/schemas/auditLogsLimitQuery'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: orderBy
          in: query
          description: Return the records in ascending (`asc`) or descending (`desc`) order.
          required: false
          schema:
            $ref: '#/components/schemas/ascDescDefaultDesc'
            default: desc
        - name: order_by
          in: query
          description: Return the records in ascending (`asc`) or descending (`desc`) order.
          required: false
          schema:
            $ref: '#/components/schemas/ascDescDefaultDesc'
            default: desc
          deprecated: true
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAuditLogs'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditLogsRequestUnauthorizedError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditLogsRequestInternalServerError'
  /audit-actions:
    get:
      operationId: getAuditLogEventActions
      summary: Get all audit log event actions
      description: Gets a complete list of all available audit log event actions.
      tags:
        - auditLogs
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAuditLogEventActions'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuditLogEventActionsRequestInternalServerError'
  /accounts:
    get:
      operationId: getAccounts
      summary: Get accounts
      description: Gets Postman billing account details for the given team.
      tags:
        - billing
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/invoicesAccountInfo'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountsRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountsRequestInternalServerError'
  /accounts/{accountId}/invoices:
    get:
      operationId: getAccountInvoices
      summary: List account invoices
      description: Gets all invoices for a Postman billing account filtered by the status of the invoice.
      tags:
        - billing
      parameters:
        - name: accountId
          in: path
          description: The account's ID.
          required: true
          schema:
            $ref: '#/components/schemas/billingAccountId'
        - name: status
          in: query
          description: The account's status.
          required: true
          schema:
            $ref: '#/components/schemas/billingAccountStatus'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAccountInvoices'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInvoicesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInvoicesRequestInternalServerError'
  /collection-access-keys:
    get:
      operationId: getCollectionAccessKeys
      summary: Get collection access keys
      description: >
        Gets the authenticated user's personal and team [collection access
        keys](https://learning.postman.com/docs/developer/postman-api/authentication/#generate-a-collection-access-key).


        **Note:**


        - The `expiresAfter` property in the response represents the date and time at which the access key expires.
        Collection access keys are valid for 60 days. If unused, the access key expires after 60 days. If someone uses
        the access key, then its expiration date increases by another 60 days.

        - If the collection key is unused, the `lastUsedAt` property in the response returns an empty string.
      tags:
        - collectionAccessKeys
      parameters:
        - name: collectionId
          in: query
          description: Filter the results by a collection's unique ID.
          required: false
          schema:
            $ref: '#/components/schemas/collectionUidQuery'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionAccessKeys'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionAccessKeysRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionAccessKeysRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionAccessKeysRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionAccessKeysRequestInternalServerError'
  /collection-access-keys/{keyId}:
    delete:
      operationId: deleteCollectionAccessKey
      summary: Delete a collection access key
      description: >
        Deletes a collection access key. To get a collection access key's ID, use the GET `/collection-access-key`
        endpoint.


        On success, this returns an HTTP `204 No Content` response.
      tags:
        - collectionAccessKeys
      parameters:
        - name: keyId
          in: path
          description: The collection access key's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionAccessKeyId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionAccessKeyRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionAccessKeyRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/common404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionAccessKeyRequestInternalServerError'
  /collections/{collectionId}/folders/{folderId}/comments:
    get:
      operationId: getFolderComments
      summary: Get a folder's comments
      description: Gets all comments left by users in a folder.
      tags:
        - collectionFolders
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: folderId
          in: path
          description: The folder's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
    post:
      operationId: createFolderComment
      summary: Create a folder comment
      description: >
        Creates a comment on a folder. To create a reply on an existing comment, include the `threadId` property in the
        request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionFolders
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: folderId
          in: path
          description: The folder's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /collections/{collectionId}/folders/{folderId}/comments/{commentId}:
    put:
      operationId: updateFolderComment
      summary: Update a folder's comment
      description: |
        Updates a comment on a folder.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionFolders
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: folderId
          in: path
          description: The folder's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteFolderComment
      summary: 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.
      tags:
        - collectionFolders
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: folderId
          in: path
          description: The folder's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /collections/{collectionId}/folders:
    post:
      operationId: createCollectionFolder
      summary: Create a folder
      description: >
        Creates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        You can use this endpoint to to import requests and responses into a newly-created folder. To do this, include
        the `requests` field and the list of request objects in the request body. For more information, see the provided
        example.


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a folder with a blank name.
      tags:
        - collectionItems
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionFolderResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionFolderRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionFolder'
  /collections/{collectionId}/requests:
    post:
      operationId: createCollectionRequest
      summary: Create a request
      description: >
        Creates a request in a collection. For a complete list of properties, refer to the **Request** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a request with a blank name.
      tags:
        - collectionItems
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: folder
          in: query
          description: >-
            The folder ID in which to create the request. By default, the system creates the request at the collection
            level.
          required: false
          schema:
            $ref: '#/components/schemas/collectionFolderId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionRequest'
  /collections/{collectionId}/responses:
    post:
      operationId: createCollectionResponse
      summary: Create a response
      description: >
        Creates a request response in a collection. For a complete list of request body properties, refer to the
        **Response** entry in the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a response with a blank name.
      tags:
        - collectionItems
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: request
          in: query
          description: The parent request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionResponseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionResponse'
  /collections/{collectionId}/folders/{folderId}:
    get:
      operationId: getCollectionFolder
      summary: Get a folder
      description: Gets information about a folder in a collection.
      tags:
        - collectionItems
      parameters:
        - name: folderId
          in: path
          description: The folder's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: ids
          in: query
          description: If true, returns only properties that contain ID values in the response.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: uid
          in: query
          description: If true, returns all IDs in UID format (`userId`-`id`).
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: populate
          in: query
          description: If true, returns all of the collection item's contents.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionFolder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionFolderRequestInternalServerError'
    put:
      operationId: updateCollectionFolder
      summary: Update a folder
      description: >
        Updates a folder in a collection. For a complete list of properties, refer to the **Folder** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for
        example, the `name` property). The endpoint does not update the entire resource.
      tags:
        - collectionItems
      parameters:
        - name: folderId
          in: path
          description: The folder's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionFolderResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionFolderRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionFolder'
    delete:
      operationId: deleteCollectionFolder
      summary: Delete a folder
      description: Deletes a folder in a collection.
      tags:
        - collectionItems
      parameters:
        - name: folderId
          in: path
          description: The folder's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionFolderId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionFolder'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionFolderRequestInternalServerError'
  /collections/{collectionId}/requests/{requestId}:
    get:
      operationId: getCollectionRequest
      summary: Get a request
      description: Gets information about a request in a collection.
      tags:
        - collectionItems
      parameters:
        - name: requestId
          in: path
          description: The request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: ids
          in: query
          description: If true, returns only properties that contain ID values in the response.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: uid
          in: query
          description: If true, returns all IDs in UID format (`userId`-`id`).
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: populate
          in: query
          description: If true, returns all of the collection item's contents.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRequestRequestInternalServerError'
    put:
      operationId: updateCollectionRequest
      summary: Update a request
      description: >
        Updates a request in a collection. For a complete list of properties, refer to the **Request** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a
        collection(`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint does not support changing the folder of a request.
      tags:
        - collectionItems
      parameters:
        - name: requestId
          in: path
          description: The request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionRequest'
    delete:
      operationId: deleteCollectionRequest
      summary: Delete a request
      description: Deletes a request in a collection.
      tags:
        - collectionItems
      parameters:
        - name: requestId
          in: path
          description: The request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionRequest'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionRequestRequestInternalServerError'
  /collections/{collectionId}/responses/{responseId}:
    get:
      operationId: getCollectionResponse
      summary: Get a response
      description: Gets information about a response in a collection.
      tags:
        - collectionItems
      parameters:
        - name: responseId
          in: path
          description: The response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: ids
          in: query
          description: If true, returns only properties that contain ID values in the response.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: uid
          in: query
          description: If true, returns all IDs in UID format (`userId`-`id`).
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: populate
          in: query
          description: If true, returns all of the collection item's contents.
          required: false
          schema:
            $ref: '#/components/schemas/booleanQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionResponseRequestInternalServerError'
    put:
      operationId: updateCollectionResponse
      summary: Update a response
      description: >
        Updates a response in a collection. For a complete list of properties, see the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        - You must pass a collection ID (`12ece9e1-2abf-4edc-8e34-de66e74114d2`), not a collection UID
        (`12345678-12ece9e1-2abf-4edc-8e34-de66e74114d2`), in this endpoint.

        - This endpoint acts like a PATCH method. It only updates the values that you pass in the request body (for
        example, the `name` property). The endpoint does not update the entire resource.
      tags:
        - collectionItems
      parameters:
        - name: responseId
          in: path
          description: The response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateCollectionResponseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionResponse'
    delete:
      operationId: deleteCollectionResponse
      summary: Delete a response
      description: Deletes a response in a collection.
      tags:
        - collectionItems
      parameters:
        - name: responseId
          in: path
          description: The response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollectionResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionResponseRequestInternalServerError'
  /collections/{collectionId}/requests/{requestId}/comments:
    get:
      operationId: getRequestComments
      summary: Get a request's comments
      description: Gets all comments left by users in a request.
      tags:
        - collectionRequests
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: requestId
          in: path
          description: The request's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
    post:
      operationId: createRequestComment
      summary: Create a request comment
      description: >
        Creates a comment on a request. To create a reply on an existing comment, include the `threadId` property in the
        request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionRequests
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: requestId
          in: path
          description: The request's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /collections/{collectionId}/requests/{requestId}/comments/{commentId}:
    put:
      operationId: updateRequestComment
      summary: Update a request's comment
      description: |
        Updates a comment on a request.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionRequests
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: requestId
          in: path
          description: The request's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteRequestComment
      summary: 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.
      tags:
        - collectionRequests
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: requestId
          in: path
          description: The request's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionRequestUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /collections/{collectionId}/responses/{responseId}/comments:
    get:
      operationId: getResponseComments
      summary: Get a response's comments
      description: Gets all comments left by users in a response.
      tags:
        - collectionResponses
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: responseId
          in: path
          description: The response's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
    post:
      operationId: createResponseComment
      summary: Create a response comment
      description: >
        Creates a comment on a response. To create a reply on an existing comment, include the `threadId` property in
        the request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionResponses
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: responseId
          in: path
          description: The response's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /collections/{collectionId}/responses/{responseId}/comments/{commentId}:
    put:
      operationId: updateResponseComment
      summary: Update a response's comment
      description: |
        Updates a comment on a response.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - collectionResponses
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: responseId
          in: path
          description: The response's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteResponseComment
      summary: 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.
      tags:
        - collectionResponses
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: responseId
          in: path
          description: The response's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionResponseUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /collection-merges:
    put:
      operationId: asyncMergePullCollectionFork
      summary: Merge or pull changes into a collection fork
      description: >
        [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork)
        a forked (source) collection and its parent (destination) collection asynchronously. To pull changes into a
        fork, pass the forked collection's ID as the `destination` value and the parent collection ID as the `source`
        value.


        The response returns a task `id` value, which you can use to track the merge's status with the GET
        `/collection-merges-tasks/{taskId}` endpoint.
      tags:
        - collections
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/asyncMergeCollectionFork'
        '400':
          description: Malformed Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncMergePullCollectionForkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncMergePullCollectionForkRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/asyncCollectionForkMerge'
  /collection-merges-tasks/{taskId}:
    get:
      operationId: asyncMergePullCollectionTaskStatus
      summary: Get merge or pull task status
      description: >
        Gets the status of a collection's merge or a pull changes task.


        **Note:**


        After a merge's success or failure, the task's status is only available for a period of 24 hours. Afterwards,
        this endpoint returns an HTTP `404 Not Found` response.
      tags:
        - collections
      parameters:
        - name: taskId
          in: path
          description: The task's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionForkTaskId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Task Status Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/asyncMergePullCollectionTaskStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncMergePullCollectionTaskStatusRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Task Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncMergePullCollectionTaskStatusRequestInternalServerError'
  /collections:
    get:
      operationId: getCollections
      summary: Get all collections
      description: >
        Gets all of your [collections](https://www.postman.com/docs/collections). The response includes all of your
        subscribed collections.


        **Note:**


        - It's recommended that you use pagination with this endpoint. Pagination improves endpoint performance.
        Unpaginated calls are considered deprecated and are subject to change.

        - Filtering with the `name` parameter when you also pass the `limit` and `offset` parameters is not supported.

        - If you pass an invalid workspace ID for the `workspace` query parameter, this endpoint returns an HTTP `200
        OK` response with an empty array.
      tags:
        - collections
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: name
          in: query
          description: >-
            Filter results by collections whose name exactly matches the given value. Partial or substring matches are
            not supported.
          required: false
          schema:
            $ref: '#/components/schemas/collectionNameQuery'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitNoDefault'
        - name: offset
          in: query
          description: The zero-based offset of the first item to return.
          required: false
          schema:
            $ref: '#/components/schemas/offsetNoDefault'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollections'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionsRequestUnauthorizedError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionsRequestInternalServerError'
    post:
      operationId: createCollection
      summary: Create a collection
      description: >
        Creates a collection using the [Postman Collection v2.1.0 schema
        format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        If you do not include the `workspace` query parameter, the system creates the collection in the oldest personal
        Internal workspace you own.
      tags:
        - collections
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collectionCreated'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionRequestUnauthorizedError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollection'
  /collections/collection-forks:
    get:
      operationId: getCollectionsForkedByUser
      summary: Get all forked collections
      description: Gets a list of all the authenticated user's forked collections.
      tags:
        - collections
      parameters:
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: direction
          in: query
          description: Sort the results by creation date in ascending (`asc`) or descending (`desc`) order.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionsForkedByUser'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fork400ErrorNoUserFound'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionsForkedByUserRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionsForkedByUserRequestInternalServerError'
  /collections/fork/{collectionId}:
    post:
      operationId: createCollectionFork
      summary: Create a fork
      description: >-
        Creates a [fork](https://learning.postman.com/docs/collaborating-in-postman/version-control/#creating-a-fork)
        from an existing collection into a workspace.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: workspace
          in: query
          description: The workspace ID in which to create the fork.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createCollectionForkResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionForkRequestUnauthorizedError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionForkRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createCollectionFork'
  /collections/merge:
    post:
      operationId: mergeCollectionFork
      summary: Merge a fork
      description: >
        **This endpoint is deprecated.**


        Merges a forked collection back into its parent collection. You must have the [Editor
        role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) for
        the collection to merge a fork.
      tags:
        - collections
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mergeCollectionForkResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeCollectionForkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeCollectionForkRequestForbiddenError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeCollectionForkRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mergeCollectionFork'
  /collections/{collectionId}:
    get:
      operationId: getCollection
      summary: Get a collection
      description: >-
        Gets information about a collection. For a complete list of this endpoint's possible values, refer to the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: access_key
          in: query
          description: >-
            A collection's read-only access key. Using this query parameter does not require an API key to call the
            endpoint.
          required: false
          schema:
            $ref: '#/components/schemas/collectionAccessKeyQuery'
        - name: model
          in: query
          description: >-
            Return a list of only the collection's root-level request (`rootLevelRequests`) and folder
            (`rootLevelFolders`) IDs instead of the full collection element data.
          required: false
          schema:
            $ref: '#/components/schemas/collectionModelQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollection'
        '400':
          description: Collection Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRequestUnauthorizedError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRequestInternalServerError'
    put:
      operationId: putCollection
      summary: Replace a collection's data
      description: >
        Replaces the contents of a collection using the [Postman Collection v2.1.0 schema
        format](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html). Include the collection's ID
        values in the request body. If you do not, the endpoint removes the existing items and creates new items.


        - To perform an update asynchronously, use the `Prefer` header with the `respond-async` value. When performing
        an async update, this endpoint returns a HTTP `202 Accepted` response.

        - For a complete list of properties and information, see the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).

        - For protocol profile behavior, refer to Postman's [Protocol Profile Behavior
        documentation](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md).


        **Note:**


        - The maximum collection size this endpoint accepts cannot exceed 100 MB.

        - Use the GET `/collection-updates-tasks/{taskId}` endpoint to get the collection's update status when
        performing an asynchronous update.

        - If you don't include the collection items' ID values from the request body, the endpoint **removes** the
        existing items and recreates the items with new ID values.

        - To copy another collection's contents to the given collection, remove all ID values before you pass it in this
        endpoint. If you do not, this endpoint returns an error. These values include the `id`, `uid`, and `postman_id`
        values.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Prefer
          in: header
          description: The `respond-async` header to perform the update asynchronously.
          required: false
          schema:
            $ref: '#/components/schemas/Prefer'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/putCollectionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCollectionRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCollectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCollectionRequestNotFoundError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putCollection'
    delete:
      operationId: deleteCollection
      summary: Delete a collection
      description: Deletes a collection.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteCollection'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionRequestUnauthorizedError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCollectionRequestInternalServerError'
    patch:
      operationId: patchCollection
      summary: Update part of a collection
      description: >
        Updates specific collection information, such as its name, events, or its variables. For more information, see
        the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchCollectionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchCollectionRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchCollectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchCollectionRequestForbiddenError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patchCollection'
  /collections/{collectionId}/comments:
    get:
      operationId: getCollectionComments
      summary: Get a collection's comments
      description: Gets all comments left by users in a collection.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
    post:
      operationId: createCollectionComment
      summary: Create a collection comment
      description: >
        Creates a comment on a collection. To create a reply on an existing comment, include the `threadId` property in
        the request body.


        **Note:**


        This endpoint accepts a max of 10,000 characters.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentCreate'
  /collections/{collectionId}/comments/{commentId}:
    put:
      operationId: updateCollectionComment
      summary: Update a collection's comment
      description: |
        Updates a comment on a collection.

        **Note:**

        This endpoint accepts a max of 10,000 characters.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commentCreatedUpdated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/commentUpdate'
    delete:
      operationId: deleteCollectionComment
      summary: 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.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: commentId
          in: path
          description: The comment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/commentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /collections/{collectionId}/duplicates:
    post:
      operationId: duplicateCollection
      summary: Duplicate a collection
      description: |
        Creates a duplicate of the given collection in another workspace.

        Use the GET `/collection-duplicate-tasks/{taskId}` endpoint to get the duplication task's current status.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/duplicateCollectionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateCollectionRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateCollectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateCollectionRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DuplicateCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/duplicateCollection'
  /collections/{collectionId}/forks:
    get:
      operationId: getCollectionForks
      summary: Get a collection's forks
      description: >-
        Gets a collection's forked collections. The response returns data for each fork, such as the fork's ID, the user
        who forked it, and the fork's creation date.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: direction
          in: query
          description: Sort the results by creation date in ascending (`asc`) or descending (`desc`) order.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionForks'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fork404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionForksRequestInternalServerError'
  /collections/{collectionId}/public-documentations:
    put:
      operationId: publishDocumentation
      summary: Publish documentation
      description: >
        Publishes a collection's documentation. This makes it publicly available to anyone with the link to the
        documentation.


        **Note:**


        - Your [Postman plan](https://www.postman.com/pricing/) impacts your use of these endpoints:
          - For **Free** and **Solo** users, you must have permissions to edit the collection.
          - If [API Governance and Security](https://learning.postman.com/docs/api-governance/configurable-rules/configurable-rules-overview/) is enabled for your [**Enterprise**](https://www.postman.com/pricing/) team, only users with the [Community Manager role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can publish documentation.
        - Publishing is only supported for collections with HTTP requests.

        - You cannot publish a collection added to an API.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publishDocumentationResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/publishDocumentation'
    delete:
      operationId: unpublishDocumentation
      summary: Unpublish documentation
      description: Unpublishes a collection's documentation. On success, this returns an HTTP `204 No Content` response.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /collections/{collectionId}/pulls:
    put:
      operationId: pullCollectionChanges
      summary: Pull source changes
      description: |
        Pulls the changes from a parent (source) collection into the forked collection. In the endpoint's response:

        - The `destinationId` is the ID of the forked collection.
        - The `sourceId` is the ID of the source collection.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The forked collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullCollectionChangesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullCollectionChangesRequestInternalServerError'
  /collections/{collectionId}/pull-requests:
    get:
      operationId: getCollectionPullRequests
      summary: Get a collection's pull requests
      description: >-
        Gets information about a collection's pull requests, such as the source and destination IDs, status of the pull
        requests, and a URL link to the pull requests.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionPullRequests'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionPullRequestsRequestInternalServerError'
    post:
      operationId: createCollectionPullRequest
      summary: Create a pull request
      description: Creates a pull request for a forked collection into its parent collection.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullRequestCreated'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCollectionPullRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullRequestCreate'
  /collections/{collectionId}/roles:
    get:
      operationId: getCollectionRoles
      summary: Get a collection's roles
      description: >-
        Gets information about all roles in a collection. The response returns the IDs of all users, teams, and groups
        with access to view or edit the collection.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionRoles'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRolesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRolesRequestForbiddenError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitle'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionRolesRequestInternalServerError'
    patch:
      operationId: updateCollectionRoles
      summary: Update a collection's roles
      description: >
        Updates the roles of users, groups, or teams in a collection. On success, this returns an HTTP `204 No Content`
        response.


        **Note:**


        - Only users assigned the Editor
        [role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#collection-roles) in
        the collection can use this endpoint.

        - This endpoint does not support the external [Partner or Guest
        roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionRolesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionRolesRequestForbiddenError'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitle'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionRolesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateCollectionRoles'
  /collections/{collectionId}/source-status:
    get:
      operationId: getSourceCollectionStatus
      summary: Get source collection's status
      description: >
        Checks whether there is a change between the forked collection and its parent (source) collection.


        If the value of the `isSourceAhead` property is `true` in the response, then there is a difference between the
        forked collection and its source collection.


        **Note:**


        This endpoint may take a few minutes to return an updated `isSourceAhead` status.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSourceCollectionStatus'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forkCollection400Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceCollectionStatusRequestInternalServerError'
  /collections/{collectionId}/transformations:
    get:
      operationId: transformCollectionToOpenAPI
      summary: Transform collection to OpenAPI
      description: |
        Transforms an existing Postman Collection into a stringified OpenAPI definition.

        **Note:**

        This does not create an API.
      tags:
        - collections
      parameters:
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: format
          in: query
          description: Return the OpenAPI definition in the given format.
          required: false
          schema:
            $ref: '#/components/schemas/collectionTransformFormat'
            default: json
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transformCollectionToOpenAPI'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
  /collection-folders-transfers:
    post:
      operationId: transferCollectionFolders
      summary: Transfer folders
      description: Copies or moves folders into a collection or folder.
      tags:
        - collections
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transferCollectionItemsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferCollectionFoldersRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferCollectionItems'
  /collection-requests-transfers:
    post:
      operationId: transferCollectionRequests
      summary: Transfer requests
      description: Copies or moves requests into a collection or folder.
      tags:
        - collections
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transferCollectionItemsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferCollectionRequestsRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferCollectionItems'
  /collection-responses-transfers:
    post:
      operationId: transferCollectionResponses
      summary: Transfer responses
      description: Copies or moves responses into a request.
      tags:
        - collections
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transferCollectionItemsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferCollectionResponsesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferCollectionItems'
  /collection-duplicate-tasks/{taskId}:
    get:
      operationId: getDuplicateCollectionTaskStatus
      summary: Get duplication task status
      description: Gets the status of a collection duplication task.
      tags:
        - collections
      parameters:
        - name: taskId
          in: path
          description: The task's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/taskUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/duplicateCollectionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDuplicateCollectionTaskStatusRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDuplicateCollectionTaskStatusRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDuplicateCollectionTaskStatusRequestInternalServerError'
  /collection-updates-tasks/{taskId}:
    get:
      operationId: getCollectionUpdatesTasks
      summary: Get async collection update status
      description: Gets the status of an asynchronous collection update task.
      tags:
        - collections
      parameters:
        - name: taskId
          in: path
          description: The task's ID.
          required: true
          schema:
            $ref: '#/components/schemas/taskId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCollectionUpdatesTasks'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionUpdatesTasksRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionUpdatesTasksRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCollectionUpdatesTasksRequestInternalServerError'
  /comments-resolutions/{threadId}:
    post:
      operationId: resolveCommentThread
      summary: 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
        [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).
      tags:
        - comments
      parameters:
        - name: threadId
          in: path
          description: The comment's thread ID.
          required: true
          schema:
            $ref: '#/components/schemas/threadId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
  /components:
    get:
      operationId: getAllComponents
      summary: Get all components
      description: Gets a list of all components in the team's component library.
      tags:
        - components
      parameters:
        - name: type
          in: query
          description: Filter results by component type.
          required: false
          schema:
            $ref: '#/components/schemas/componentType'
        - name: status
          in: query
          description: Filter results by the component's status.
          required: false
          schema:
            $ref: '#/components/schemas/componentStatus'
        - name: hasVersions
          in: query
          description: If true, return only components with published versions.
          required: false
          schema:
            $ref: '#/components/schemas/componentHasVersions'
        - name: include
          in: query
          description: >-
            A comma-separated list of additional fields to include. Accepts the `hasVersions`, `latestVersion`,
            `latestVersion.content` values.
          required: false
          schema:
            $ref: '#/components/schemas/componentIncludeFields'
        - name: expand
          in: query
          description: A comma-separated list of fields to expand. Accepts the `latestVersion` value.
          required: false
          schema:
            $ref: '#/components/schemas/componentExpandLatestVersion'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAllComponents'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllComponentsRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllComponentsRequestInternalServerError'
    post:
      operationId: createComponent
      summary: Create a component
      description: >-
        Creates a new component. The component is created in an active state with an initial draft. Use the POST
        `/components/{componentId}/versions` endpoint to publish a version.
      tags:
        - components
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Component Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createComponentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentRequestForbiddenError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createComponent'
  /components/{componentId}:
    get:
      operationId: getComponent
      summary: Get a component
      description: >-
        Gets information about a component. Use the `include` and `expand` query parameters to return additional
        information, such as `hasVersions` and the latest published version.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: include
          in: query
          description: >-
            A comma-separated list of additional fields to include. Accepts the `hasVersions`, `latestVersion`,
            `latestVersion.content` values.
          required: false
          schema:
            $ref: '#/components/schemas/componentIncludeFields'
        - name: expand
          in: query
          description: A comma-separated list of fields to expand. Accepts the `latestVersion` value.
          required: false
          schema:
            $ref: '#/components/schemas/componentExpandLatestVersion'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getComponent'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentRequestInternalServerError'
    patch:
      operationId: updateComponent
      summary: Update a component
      description: >
        Updates a component:
          - `name` — Rename the component. The new name must be unique within the team. Archived components can't be renamed.
          - `status` — Changes the component's lifecycle state:
            - `archive` — Marks the component as read-only. Archived components aren't deleted and can't be edited or published, but their existing versions remain accessible.
            - `active` — Restores the component. Only active components can be edited and published.

        **Note:**


        You can't update a name and archived state in a single call. To change both properties, make separate calls to
        update the name and status.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Component Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateComponentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateComponent'
  /components/{componentId}/drafts:
    get:
      operationId: getComponentDraft
      summary: Get a component draft
      description: >-
        Gets information about the current working draft of a component, including its content and format. Drafts
        represent the latest unpublished edits of a component, which may be different from the most recently published
        version.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getComponentDraft'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentDraftRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentDraftRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentDraftRequestInternalServerError'
    patch:
      operationId: updateComponentDraft
      summary: Update a component draft
      description: >
        Updates a component's draft. Component drafts contain unpublished edits to a component, which may be different
        from a recently published version.


        **Note:**


        You can't update archived components.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateComponentDraftResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentDraftRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentDraftRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComponentDraftRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateComponentDraft'
  /components/{componentId}/versions:
    get:
      operationId: getComponentVersions
      summary: Get all component versions
      description: Gets a list of a component's published versions.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: include
          in: query
          description: A comma-separated list of additional fields to include. Accepts the `content` value.
          required: false
          schema:
            $ref: '#/components/schemas/componentLibraryInclude'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getComponentVersions'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionsRequestInternalServerError'
    post:
      operationId: createComponentVersion
      summary: Create a component version
      description: >
        Publishes a new version of a component from the current draft.


        **Note:**


        You can't publish a new version of an archived component. Reactivate the component before publishing a new
        version.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Version Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createComponentVersionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentVersionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComponentVersionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createComponentVersion'
  /components/{componentId}/versions/{versionId}:
    get:
      operationId: getComponentVersion
      summary: Get a component version
      description: Gets a published version of a component.
      tags:
        - components
      parameters:
        - name: componentId
          in: path
          description: The component's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentId'
        - name: versionId
          in: path
          description: The component version's ID.
          required: true
          schema:
            $ref: '#/components/schemas/componentVersionId'
        - name: include
          in: query
          description: A comma-separated list of additional fields to include. Accepts the `content` value.
          required: false
          schema:
            $ref: '#/components/schemas/componentLibraryInclude'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/componentVersionData'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetComponentVersionRequestInternalServerError'
  /environments:
    get:
      operationId: getEnvironments
      summary: Get all environments
      description: >-
        Gets information about all of your
        [environments](https://learning.postman.com/docs/sending-requests/managing-environments/).
      tags:
        - environments
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getEnvironments'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentsRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentsRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentsRequestInternalServerError'
    post:
      operationId: createEnvironment
      summary: Create an environment
      description: >
        Creates an environment.


        **Note:**


        - The request body size cannot exceed the maximum allowed size of 30MB.

        - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its
        value in the request header.

        - If you do not include the `workspace` query parameter, the system creates the environment in the oldest
        personal Internal workspace you own.

        - Only [shared
        variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values
        can be modified through the Postman API. A shared variable is an environment variable with its value synced and
        stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.
      tags:
        - environments
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentRequestForbiddenError'
        '411':
          description: Length Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '413':
          description: Payload Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createEnvironment'
  /environments/{environmentId}:
    get:
      operationId: getEnvironment
      summary: Get an environment
      description: Gets information about an environment.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getEnvironment'
        '400':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentRequestInternalServerError'
    put:
      operationId: putEnvironment
      summary: Replace an environment's data
      description: >
        Replaces all the contents of an environment with the given information.


        **Note:**


        - The request body size cannot exceed the maximum allowed size of 30MB.

        - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its
        value in the request header.

        - Only [shared
        variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values
        can be modified through the Postman API. A shared variable is an environment variable with its value synced and
        stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/putEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutEnvironmentRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutEnvironmentRequestUnauthorizedError'
        '411':
          description: Length Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '413':
          description: Payload Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putEnvironment'
    delete:
      operationId: deleteEnvironment
      summary: Delete an environment
      description: Deletes an environment.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteEnvironment'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentRequestNotFoundError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteEnvironmentRequestInternalServerError'
    patch:
      operationId: patchEnvironment
      summary: Update an environment
      description: >
        Updates specific environment properties, such as its name and variables.


        **Note:**


        - You can only perform one type of operation at a time. For example, you cannot perform an `add` and `replace`
        operation in the same call.

        - The request body size cannot exceed the maximum allowed size of 30MB.

        - If you receive an HTTP `411 Length Required` error response, manually pass the `Content-Length` header and its
        value in the request header.

        - To add a description to an existing variable, use the `add` operation.

        - Only [shared
        variable](https://learning.postman.com/docs/use/send-requests/variables/variables/#share-variable-values) values
        can be modified through the Postman API. A shared variable is an environment variable with its value synced and
        stored in the Postman cloud, and can be accessed by your teammates in the environment's workspace.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/patchEnvironment400Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchEnvironmentRequestNotFoundError'
        '411':
          description: Length Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '413':
          description: Payload Too Large
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Environments_patchEnvironment_Request'
  /environments/{environmentId}/forks:
    get:
      operationId: getEnvironmentForks
      summary: Get an environment's forks
      description: Gets all of an environment's forked environments.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentUid'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: direction
          in: query
          description: Sort results in ascending (`asc`) or descending (`desc`) order.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: sort
          in: query
          description: Sort the results by the date and time of creation.
          required: false
          schema:
            $ref: '#/components/schemas/sortByCreatedAt'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getEnvironmentForks'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentForksRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnvironmentForksRequestInternalServerError'
    post:
      operationId: forkEnvironment
      summary: Create a fork
      description: >-
        Creates a
        [fork](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/) of an
        existing environment.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentUid'
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/forkEnvironmentResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForkEnvironmentRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForkEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/forkEnvironment'
  /environments/{environmentId}/merges:
    post:
      operationId: mergeEnvironmentFork
      summary: Merge a fork
      description: >
        [Merges](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#merge-changes-from-a-fork)
        a forked environment back into its parent environment.
      tags:
        - environments
      parameters:
        - name: environmentId
          in: path
          description: The environment's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mergeEnvironmentForkResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeEnvironmentForkRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MergeEnvironmentForkRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mergeEnvironmentFork'
  /environments/{environmentUid}/pulls:
    post:
      operationId: pullEnvironment
      summary: Pull source changes
      description: >
        [Pulls](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/forking-elements/#pull-updates-from-a-parent-element)
        the changes from a parent (source) environment into the forked environment.
      tags:
        - environments
      parameters:
        - name: environmentUid
          in: path
          description: The destination environment's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/environmentUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullEnvironmentResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullEnvironmentRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PullEnvironmentRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullEnvironment'
  /groups:
    get:
      operationId: getGroups
      summary: Get all groups
      description: Gets all of a team's Postman [groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
      tags:
        - groups
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getGroups'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupsRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupsRequestInternalServerError'
  /groups/{groupId}:
    get:
      operationId: getGroup
      summary: Get a group
      description: >-
        Gets information about a Postman [user
        group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/).
      tags:
        - groups
      parameters:
        - name: groupId
          in: path
          description: The group's ID.
          required: true
          schema:
            $ref: '#/components/schemas/groupId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getGroup'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupRequestInternalServerError'
  /import/openapi:
    post:
      operationId: openApiDefinition
      summary: Import an OpenAPI definition
      description: >
        Imports an OpenAPI definition into Postman as a new [Postman
        Collection](https://learning.postman.com/docs/getting-started/creating-the-first-collection/).


        **Note:**


        - This endpoint has a rate limit of **10 requests per 10 seconds**.

        - The Postman web app does not support the `file` input method type.

        - If you do not include the `workspace` query parameter, the system imports the definition into the oldest
        personal Internal workspace you own.

        - For an example of importing a file, see the [Postman API
        collection](https://www.postman.com/postman/postman-public-workspace/example/12959542-08d74ce2-8150-4f72-99a7-11e60492eb47).
      tags:
        - import
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/importOpenApiDefinition'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/import400Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportOpenApiDefinitionRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportOpenApiDefinitionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Import_openApiDefinition_Request'
  /mocks:
    get:
      operationId: getMocks
      summary: Get all mock servers
      description: >
        Gets all active mock servers. By default, this endpoint returns only mock servers you created across all
        workspaces.


        **Note:**


        If you pass both the `teamId` and `workspace` query parameters, this endpoint only accepts the `workspace`
        query.
      tags:
        - mocks
      parameters:
        - name: teamId
          in: query
          description: Return only results that belong to the given team ID.
          required: false
          schema:
            $ref: '#/components/schemas/teamIdResultsQuery'
        - name: workspace
          in: query
          description: Return only results found in the given workspace ID.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMocks'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMocksRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
    post:
      operationId: createMock
      summary: Create a mock server
      description: >
        Creates a mock server in a collection.


        **Note:**


        - You cannot create mocks for collections added to an API definition.

        - If you do not include the `workspaceId` query parameter, the system creates the mock server in the oldest
        personal Internal workspace you own.
      tags:
        - mocks
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockCreateUpdateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMockRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMockRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMock'
  /mocks/{mockId}:
    get:
      operationId: getMock
      summary: Get a mock server
      description: Gets information about a mock server.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMock'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
    put:
      operationId: updateMock
      summary: Update a mock server
      description: Updates a mock server's properties, such as its name or collection.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockCreateUpdateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMockRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMockRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateMock'
    delete:
      operationId: deleteMock
      summary: Delete a mock server
      description: Deletes a mock server.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteMock'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMockRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
  /mocks/{mockId}/call-logs:
    get:
      operationId: getMockCallLogs
      summary: Get a mock server's call logs
      description: >
        Gets a mock server's call logs. You can get a maximum of 6.5MB of call logs or a total of 100 call logs,
        whichever limit is met first in one API call.


        Call logs contain exchanged request and response data made to mock servers. The logs provide visibility into how
        the mock servers are being used. You can log data to debug, test, analyze, and more, depending upon the use
        case.


        **Note:**


        Call logs have a retention period based on your [Postman plan](https://www.postman.com/pricing/#mock-calls). For
        more information, see [this
        article](https://support.postman.com/hc/en-us/articles/21219973964951-I-can-t-see-my-mock-server-logs-history)
        in the [Postman Support Center](https://support.postman.com/).
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault100'
            default: 100
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: until
          in: query
          description: >-
            Return only results created until this given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than
            the `since` value.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateTime'
        - name: since
          in: query
          description: >-
            Return only results created since the given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the
            `until` value.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateTime'
        - name: responseStatusCode
          in: query
          description: Return only call logs that match the given HTTP response status code.
          required: false
          schema:
            $ref: '#/components/schemas/mockResponseStatusCode'
        - name: responseType
          in: query
          description: Return only call logs that match the given response type. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/mockResponseType'
        - name: requestMethod
          in: query
          description: Return only call logs that match the given HTTP method. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/mockRequestMethod'
        - name: requestPath
          in: query
          description: Return only call logs that match the given request path. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/mockRequestPath'
        - name: sort
          in: query
          description: >-
            Sort the results by the given value. If you use this query parameter, you must also use the `direction`
            parameter.
          required: false
          schema:
            $ref: '#/components/schemas/mockSortServedAt'
        - name: direction
          in: query
          description: >-
            Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this
            query parameter, you must also use the `sort` parameter.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: include
          in: query
          description: >-
            Include call log records with header and body data. This query parameter accepts the `request.headers`,
            `request.body`, `response.headers`, and `response.body` values. For multiple include types, comma-separate
            each value.
          required: false
          schema:
            $ref: '#/components/schemas/mockInclude'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMockCallLogs'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockCallLogsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockCallLogsRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockCallLogsRequestInternalServerError'
  /mocks/{mockId}/publish:
    post:
      operationId: publishMock
      summary: Publish a mock server
      description: Publishes a mock server. Publishing a mock server sets its **Access Control** configuration setting to public.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publishUnpublishMockResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishMockRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishMockRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
  /mocks/{mockId}/unpublish:
    delete:
      operationId: unpublishMock
      summary: Unpublish a mock server
      description: >-
        Unpublishes a mock server. Unpublishing a mock server sets its **Access Control** configuration setting to
        private.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/publishUnpublishMockResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnpublishMockRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnpublishMockRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mock500Error'
  /mocks/{mockId}/server-responses:
    get:
      operationId: getMockServerResponses
      summary: Get all server responses
      description: Gets all of a mock server's server responses.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMockServerResponses'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockServerResponsesRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockServerResponsesRequestInternalServerError'
    post:
      operationId: createMockServerResponse
      summary: Create a server response
      description: >
        Creates a server response. Server responses let you simulate 5xx server-level responses, such as 500 or 503.


        Server-level responses are agnostic to application-level logic. Server responses let you simulate this behavior
        on a mock server. You do not need to define each error for all exposed paths on the mock server.


        If you set a server response as active, then all the calls to the mock server return with that active server
        response.


        **Note:**


        You can create multiple server responses for a mock server, but only one mock server can be set as active.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMockServerResponseRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMockServerResponseRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMockServerResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMockServerResponse'
  /mocks/{mockId}/server-responses/{serverResponseId}:
    get:
      operationId: getMockServerResponse
      summary: Get a server response
      description: Gets information about a server response.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: serverResponseId
          in: path
          description: The server response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serverResponseId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockServerResponseRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMockServerResponseRequestInternalServerError'
    put:
      operationId: updateMockServerResponse
      summary: Update a server response
      description: Updates a server response.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: serverResponseId
          in: path
          description: The server response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serverResponseId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMockServerResponseRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMockServerResponseRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMockServerResponseRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateMockServerResponse'
    delete:
      operationId: deleteMockServerResponse
      summary: Delete a server response
      description: Deletes a mock server's server response.
      tags:
        - mocks
      parameters:
        - name: mockId
          in: path
          description: The mock's ID.
          required: true
          schema:
            $ref: '#/components/schemas/mockId'
        - name: serverResponseId
          in: path
          description: The server response's ID.
          required: true
          schema:
            $ref: '#/components/schemas/serverResponseId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteMockServerResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMockServerResponseRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mockServerResponse404Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMockServerResponseRequestInternalServerError'
  /monitors:
    get:
      operationId: getMonitors
      summary: Get all monitors
      description: Gets all monitors.
      tags:
        - monitors
      parameters:
        - name: workspace
          in: query
          description: Return only results found in the given workspace ID.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: active
          in: query
          description: If true, return only active monitors.
          required: false
          schema:
            $ref: '#/components/schemas/active'
            default: false
        - name: owner
          in: query
          description: Return only results that belong to the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/owner'
        - name: collectionUid
          in: query
          description: Filter the results by a collection's unique ID.
          required: false
          schema:
            $ref: '#/components/schemas/collectionUidQuery'
        - name: environmentUid
          in: query
          description: Filter the results by an environment's unique ID.
          required: false
          schema:
            $ref: '#/components/schemas/environmentUid'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25
            returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault25'
            default: 25
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMonitors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorsRequestInternalServerError'
    post:
      operationId: createMonitor
      summary: Create a monitor
      description: >
        Creates a monitor.


        **Note:**


        - You cannot create monitors for collections added to an API definition.

        - If you do not pass the `workspace` query parameter, the system creates the monitor in the oldest personal
        Internal workspace you own.
      tags:
        - monitors
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUpdateMonitorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMonitorRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMonitorRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMonitorRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMonitorRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createMonitor'
  /monitors/{monitorId}:
    get:
      operationId: getMonitor
      summary: Get a monitor
      description: Gets information about a monitor.
      tags:
        - monitors
      parameters:
        - name: monitorId
          in: path
          description: The monitor's ID.
          required: true
          schema:
            $ref: '#/components/schemas/monitorId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMonitor'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMonitorRequestInternalServerError'
    put:
      operationId: updateMonitor
      summary: Update a monitor
      description: >-
        Updates a monitor's
        [configurations](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#configure-a-monitor).
      tags:
        - monitors
      parameters:
        - name: monitorId
          in: path
          description: The monitor's ID.
          required: true
          schema:
            $ref: '#/components/schemas/monitorId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUpdateMonitorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMonitorRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateMonitor'
    delete:
      operationId: deleteMonitor
      summary: Delete a monitor
      description: Deletes a monitor.
      tags:
        - monitors
      parameters:
        - name: monitorId
          in: path
          description: The monitor's ID.
          required: true
          schema:
            $ref: '#/components/schemas/monitorId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteMonitor'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMonitorRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMonitorRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteMonitorRequestInternalServerError'
  /monitors/{monitorId}/run:
    post:
      operationId: runMonitor
      summary: Run a monitor
      description: >
        Runs a monitor and returns its run results.


        **Note:**


        - If you pass the `async=true` query parameter, the response does not return the `stats`, `executions`, and
        `failures` responses. To get this information for an asynchronous run, call the GET `/monitors/{id}` endpoint.

        - If the call exceeds 300 seconds, the endpoint returns an HTTP `202 Accepted` response. Use the GET
        `/monitors/{id}` endpoint to check the run's status in the response's `lastRun` property. To avoid this, it is
        recommended that you include the `async=true` query parameter when using this endpoint.
      tags:
        - monitors
      parameters:
        - name: monitorId
          in: path
          description: The monitor's ID.
          required: true
          schema:
            $ref: '#/components/schemas/monitorId'
        - name: async
          in: query
          description: >-
            If true, runs the monitor asynchronously from the created monitor run task. By default, the server will not
            respond until the task finishes (`false`).
          required: false
          schema:
            $ref: '#/components/schemas/async'
            default: false
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runMonitor'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMonitorRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMonitorRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunMonitorRequestInternalServerError'
  /runners/{runnerId}/instances:
    get:
      operationId: getRunnerInstances
      summary: Get all runner instances
      description: >
        Gets all instances of the runner polling Postman for upcoming monitor runs. Instances are runner executions that
        share the same runner ID and key.


        **Note:**


        You can get a runner's ID in the Postman UI if you have an Admin or Super Admin role. To do this, click **Team >
        Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then copy its ID
        from the URL.
      tags:
        - monitors
      parameters:
        - name: runnerId
          in: path
          description: The runner's ID.
          required: true
          schema:
            $ref: '#/components/schemas/runnerId'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25
            returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault25'
            default: 25
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRunnerInstances'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runnerErrorTypeTitleDetailCreatedAt'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerInstancesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerInstancesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runnerErrorTypeTitleDetailCreatedAt'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerInstancesRequestInternalServerError'
  /runners/{runnerId}/metrics:
    get:
      operationId: getRunnerMetrics
      summary: Get runner metrics
      description: >
        Gets the Postman server-side metrics for a runner instance. Metrics include information such as monitor run
        queues and last polling date.


        **Note:**


        You can get a runner's ID in the Postman UI if you have a Team Admin or Super Admin role. To do this, click
        **Team > Team Settings** in Postman, then click **Runners**. Click the runner you want to get the ID of, then
        copy its ID from the URL.
      tags:
        - monitors
      parameters:
        - name: runnerId
          in: path
          description: The runner's ID.
          required: true
          schema:
            $ref: '#/components/schemas/runnerId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getRunnerMetrics'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerMetricsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerMetricsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runnerErrorTypeTitleDetailCreatedAt'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRunnerMetricsRequestInternalServerError'
  /oauth2/token:
    post:
      operationId: generateOauthToken
      summary: Generate an OAuth Token
      description: >
        Generates an OAuth 2.0 access token for a client application using the `client_credentials` grant type. Use this
        endpoint with backend services or bots to authenticate and authorize API requests without user interaction.


        **Note:**


        This endpoint uses Basic Auth. You must pass a valid client ID and client secret for the username and password,
        respectively.
      tags:
        - oAuth20
      parameters:
        - name: Authorization
          in: header
          description: Basic authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateOauthTokenResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oauthTokenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oauthTokenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateOauthTokenRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateOauthToken'
  /oauth2/token/revoke:
    post:
      operationId: revokeOauthToken
      summary: Revoke an OAuth Token
      description: >
        Revokes an active OAuth 2.0 access token and prevents further use of it for authentication. Once revoked, the
        token can't be used for any API requests.


        **Note:**


        - Revocation of an OAuth token is immediate and can't be undone.

        - This request does not use any authorization.
      tags:
        - oAuth20
      responses:
        '200':
          description: Token Revoked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/revokeOauthTokenResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/oauthTokenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevokeOauthTokenRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/revokeOauthToken'
  /postbot/generations/tool:
    post:
      operationId: generateTool
      summary: Generate a tool
      description: >
        **This endpoint is deprecated**


        Generates code for an AI agent tool using a collection and request from the Public API Network. For more
        information, see [**Tool Generation Demo**](http://postman.com/explore/toolgen) in Postman's Public API Network.


        ### Important


        - This endpoint has a rate limit of **300 calls every 3 hours**. This does not accrue Postbot usage.

        - This endpoint only supports public Postman Collections and requests.
      tags:
        - postbot
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateToolResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/postbot400Error'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateToolRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateTool'
  /network/private:
    get:
      operationId: listPrivateNetworkWorkspaces
      summary: Get all workspaces
      description: >-
        Gets information workspaces added to your team's [Private API
        Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
      tags:
        - privateApiNetwork
      parameters:
        - name: type
          in: query
          description: The `workspace` value.
          required: false
          schema:
            $ref: '#/components/schemas/elementTypeQuery'
        - name: name
          in: query
          description: Return only workspaces whose name includes the given value. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/panElementName'
        - name: summary
          in: query
          description: Return only workspaces whose summary includes the given value. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/panSummary'
        - name: description
          in: query
          description: Return only workspaces whose description includes the given value. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/panElementDescription'
        - name: since
          in: query
          description: >-
            Return only results created since the given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the
            `until` value.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateTime'
        - name: until
          in: query
          description: >-
            Return only results created until this given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than
            the `since` value.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateTime'
        - name: addedBy
          in: query
          description: Return only workspaces published by the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/panAddedBy'
        - name: sort
          in: query
          description: >-
            Sort the results by the given value. If you use this query parameter, you must also use the `direction`
            parameter.
          required: false
          schema:
            $ref: '#/components/schemas/sortCreatedUpdatedAt'
        - name: direction
          in: query
          description: >-
            Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this
            query parameter, you must also use the `sort` parameter.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: createdBy
          in: query
          description: Return only results created by the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/createdBy'
        - name: offset
          in: query
          description: The zero-based offset of the first item to return.
          required: false
          schema:
            $ref: '#/components/schemas/offset'
            default: 0
        - name: limit
          in: query
          description: >-
            The maximum number of results to return. If the value exceeds the maximum value of `1000`, then the system
            uses the `1000` value.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault1000'
            default: 1000
        - name: parentFolderId
          in: query
          description: This parameter is deprecated.
          required: false
          schema:
            $ref: '#/components/schemas/panParentFolderId'
            default: 0
          deprecated: true
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPanElements'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkWorkspacesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkWorkspacesRequestForbiddenError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkWorkspacesRequestInternalServerError'
    post:
      operationId: addWorkspaceToPrivateNetwork
      summary: Add a workspace
      description: >-
        Publishes a workspace in your team's [Private API
        Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
      tags:
        - privateApiNetwork
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/panElementCreated'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddWorkspaceToPrivateNetworkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddWorkspaceToPrivateNetworkRequestForbiddenError'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/panError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddWorkspaceToPrivateNetworkRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/panCreateWorkspace'
  /network/private/workspace/{workspaceId}:
    put:
      operationId: updatePanElementOrFolder
      summary: Update an element or folder
      description: |
        **This endpoint is deprecated.**
      tags:
        - privateApiNetwork
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Private API Network_updatePanElementOrFolder_Response_200'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePanElementOrFolderRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePanElementOrFolderRequestForbiddenError'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/panError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePanElementOrFolderRequestInternalServerError'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatePanWorkspace'
    delete:
      operationId: removeWorkspaceFromPrivateNetwork
      summary: Remove a workspace
      description: >
        Removes a workspace from your team's [Private API
        Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).


        **Note:**


        Removing a workspace does not delete it. It only removes it from the Private API Network folder.
      tags:
        - privateApiNetwork
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deletePanElement'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveWorkspaceFromPrivateNetworkRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveWorkspaceFromPrivateNetworkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveWorkspaceFromPrivateNetworkRequestForbiddenError'
        '404':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/panError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveWorkspaceFromPrivateNetworkRequestInternalServerError'
  /network/private/network-entity/request/all:
    get:
      operationId: listPrivateNetworkAddRequests
      summary: Get all add requests
      description: >-
        Gets all requests to add workspaces to your team's [Private API
        Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/).
      tags:
        - privateApiNetwork
      parameters:
        - name: since
          in: query
          description: >-
            Return only results created since the given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the
            `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateTime'
        - name: until
          in: query
          description: >-
            Return only results created until this given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than
            the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateTime'
        - name: requestedBy
          in: query
          description: Return a user's requests by their user ID.
          required: false
          schema:
            $ref: '#/components/schemas/panRequestedBy'
        - name: type
          in: query
          description: The `workspace` value.
          required: false
          schema:
            $ref: '#/components/schemas/elementTypeQuery'
        - name: status
          in: query
          description: Filter by the request status.
          required: false
          schema:
            $ref: '#/components/schemas/panRequestStatus'
        - name: name
          in: query
          description: Return only workspaces whose name includes the given value. Matching is not case-sensitive.
          required: false
          schema:
            $ref: '#/components/schemas/panElementName'
        - name: sort
          in: query
          description: >-
            Sort the results by the given value. If you use this query parameter, you must also use the `direction`
            parameter.
          required: false
          schema:
            $ref: '#/components/schemas/sortCreatedUpdatedAt'
        - name: direction
          in: query
          description: >-
            Sort in ascending (`asc`) or descending (`desc`) order. Matching is not case-sensitive. If you use this
            query parameter, you must also use the `sort` parameter.
          required: false
          schema:
            $ref: '#/components/schemas/ascDesc'
        - name: offset
          in: query
          description: The zero-based offset of the first item to return.
          required: false
          schema:
            $ref: '#/components/schemas/offset'
            default: 0
        - name: limit
          in: query
          description: >-
            The maximum number of results to return. If the value exceeds the maximum value of `1000`, then the system
            uses the `1000` value.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault1000'
            default: 1000
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAllPanAddElementRequests'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkAddRequestsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkAddRequestsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkAddRequestsRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPrivateNetworkAddRequestsRequestInternalServerError'
  /network/private/network-entity/request/{requestId}:
    put:
      operationId: respondPrivateNetworkAddRequest
      summary: Respond to an add request
      description: >-
        Responds to a user's request to add a workspace to your team's [Private API
        Network](https://learning.postman.com/docs/collaborating-in-postman/adding-private-network/). Only managers can
        approve or deny a request. Once approved, the workspace will appear in the team's Private API Network.
      tags:
        - privateApiNetwork
      parameters:
        - name: requestId
          in: path
          description: The request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/panRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Private API Network_respondPrivateNetworkAddRequest_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespondPrivateNetworkAddRequestRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespondPrivateNetworkAddRequestRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespondPrivateNetworkAddRequestRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RespondPrivateNetworkAddRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/respondPanElementAddRequestBody'
  /pull-requests/{pullRequestId}:
    get:
      operationId: getPullRequest
      summary: Get a pull request
      description: >-
        Gets information about a pull request, such as the source and destination details, who reviewed the pull
        request, the merge's current status, and whether the element is accessible.
      tags:
        - pullRequests
      parameters:
        - name: pullRequestId
          in: path
          description: The pull request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/pullRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullRequestGet'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPullRequestRequestInternalServerError'
    put:
      operationId: updatePullRequest
      summary: Update a pull request
      description: Updates an open pull request.
      tags:
        - pullRequests
      parameters:
        - name: pullRequestId
          in: path
          description: The pull request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/pullRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullRequestUpdated'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePullRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullRequestUpdate'
  /pull-requests/{pullRequestId}/tasks:
    post:
      operationId: reviewPullRequest
      summary: Review a pull request
      description: >-
        Updates the
        [review](https://learning.postman.com/docs/collaborating-in-postman/using-version-control/reviewing-pull-requests/)
        status of a pull request.
      tags:
        - pullRequests
      parameters:
        - name: pullRequestId
          in: path
          description: The pull request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/pullRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pullRequestReviewReponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReviewPullRequestRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pullRequestReview'
  /scim/v2/Groups:
    get:
      operationId: getScimGroupResources
      summary: Get all groups
      description: Gets information about all Postman team members.
      tags:
        - scim
      parameters:
        - name: startIndex
          in: query
          description: The index entry by which to begin the list of returned results. Must be a value of `1` or greater.
          required: false
          schema:
            $ref: '#/components/schemas/startIndex'
            default: 1
        - name: count
          in: query
          description: Limit the number of results returned in a single response.
          required: false
          schema:
            $ref: '#/components/schemas/count'
            default: 100
        - name: filter
          in: query
          description: >
            Filter results by a specific word or phrase. This query parameter only supports the `displayName` filter and
            has the following requirements:

            - Filter values are case-sensitive.

            - Special characters and spaces must be URL encoded.
          required: false
          schema:
            $ref: '#/components/schemas/scimGroupFilter'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimGroupResources'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    post:
      operationId: createScimGroup
      summary: Create a group
      description: >
        Creates a new user group in Postman and creates a new account for each group member.


        Each account is added to your Postman team and authentication is activated for each user. If an existing Postman
        account uses an email that matches a group member's email ID, an [email
        invite](https://postman.postman.co/docs/administration/managing-your-team/managing-your-team/#invites) to join
        your Postman team is sent to that user. Once the user accepts the invite, they'll be added to your team.


        By default, the system assigns new users the developer role. You can [update user roles in
        Postman](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/#managing-team-roles).
      tags:
        - scim
      parameters:
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createScimGroupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScimGroupRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createScimGroup'
  /scim/v2/Groups/{groupId}:
    get:
      operationId: getScimGroupResource
      summary: Get a group
      description: Gets information about a Postman group within the team.
      tags:
        - scim
      parameters:
        - name: groupId
          in: path
          description: The group's ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimGroupResource'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    delete:
      operationId: deleteScimGroup
      summary: Delete a group
      description: >
        Deletes a group in Postman. On success, this returns an HTTP `204 No Content` response.


        User accounts that were in the deleted group are deactivated in Postman if the app is assigned to the user only
        with the deleted group.


        User accounts and the data corresponding to them are not deleted. To permanently delete user accounts and their
        data, [contact Postman support](https://www.postman.com/support/).
      tags:
        - scim
      parameters:
        - name: groupId
          in: path
          description: The group's ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Group Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    patch:
      operationId: updateGroup
      summary: Update a group
      description: |
        Updates a group's information. Using this endpoint you can:

        - Update a group's name.
        - Add or remove members from a Postman group.
      tags:
        - scim
      parameters:
        - name: groupId
          in: path
          description: The group's ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUpdateGroupResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScimUpdateGroupRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/scimUpdateGroup'
  /scim/v2/ResourceTypes:
    get:
      operationId: getScimResourceTypes
      summary: Get resource types
      description: Gets all the resource types supported by Postman's SCIM API.
      tags:
        - scim
      parameters:
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimResourceTypes'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetScimResourceTypesRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
  /scim/v2/ServiceProviderConfig:
    get:
      operationId: getScimServiceProviderConfig
      summary: Get service provider configuration
      description: Gets the Postman SCIM API configuration information. This includes a list of supported operations.
      tags:
        - scim
      parameters:
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getScimServiceProviderConfig'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
  /scim/v2/Users:
    get:
      operationId: getScimUserResources
      summary: Get all users
      description: Gets information about all Postman team members.
      tags:
        - scim
      parameters:
        - name: startIndex
          in: query
          description: The index entry by which to begin the list of returned results. Must be a value of `1` or greater.
          required: false
          schema:
            $ref: '#/components/schemas/startIndex'
            default: 1
        - name: count
          in: query
          description: Limit the number of results returned in a single response.
          required: false
          schema:
            $ref: '#/components/schemas/count'
            default: 100
        - name: filter
          in: query
          description: |
            Filter results by a specific word or phrase. This query parameter accepts the following:
            - `userName` — Filter values are case-sensitive, and special characters and spaces must be URL encoded.
            - `active` — Return only users who are active (`true`) or inactive (`false`).
          required: false
          schema:
            $ref: '#/components/schemas/scimUserFilter'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResources'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    post:
      operationId: createScimUser
      summary: Create a user
      description: >
        Creates a new user account in Postman and adds the user to your organization's Postman team.

        - If the account does not exist, this also activates the user so they can authenticate in to your Postman team.

        - If an account matching the email ID exists, the user receives [email
        invite](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-invites)
        to join the Postman team. The user joins the team when they accept the invite.

        - If the user's email domain matches your team's verified domains, the user is immediately added to the team.


        By default, the system assigns new users the developer role. You can [update user roles in
        Postman](https://learning.postman.com/docs/administration/managing-your-team/manage-team-members/#manage-team-roles).


        **Note:**


        - Users must join the team before you can assign them to any groups.

        - If the user is a member of a different team during SCIM provisioning and their email domain is **not**
        verified with your Postman team, then the user is **not** provisioned. The endpoint returns an HTTP `409
        Conflict` response.
      tags:
        - scim
      parameters:
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createScimUserResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateScimUserRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimErrorScimType'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createScimUser'
  /scim/v2/Users/{userId}:
    get:
      operationId: getScimUserResource
      summary: Get a user
      description: Gets information about a Postman team member.
      tags:
        - scim
      parameters:
        - name: userId
          in: path
          description: The user's SCIM ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
    put:
      operationId: updateScimUser
      summary: Update a user
      description: >
        Updates a user in Postman.


        **Reactivating a user**


        By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to
        authenticate in to Postman and adds the account back on to your Postman team.
      tags:
        - scim
      parameters:
        - name: userId
          in: path
          description: The user's SCIM ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScimUserRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateScimUser'
    patch:
      operationId: updateScimUserPatch
      summary: Update a user
      description: >
        Updates a user in Postman.


        **Reactivating a user**


        By setting the `active` property from `false` to `true`, this reactivates an account. This allows the account to
        authenticate in to Postman and adds the account back on to your Postman team.
      tags:
        - scim
      parameters:
        - name: userId
          in: path
          description: The user's SCIM ID.
          required: true
          schema:
            $ref: '#/components/schemas/scimId'
        - name: Authorization
          in: header
          description: >-
            A valid [SCIM API
            key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
            for calls to SCIM endpoints.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimUserResourceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateScimUserPatchRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/scimError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateScimUserPatch'
  /sdks:
    get:
      operationId: getSdks
      summary: Get all SDKs
      description: >
        Lists all SDKs the authenticated user has access to.


        **Note:**


        - Use the `sdkIds` parameter to get the generation build status of multiple SDKs in a single call.

        - When you pass the `sdkIds` value, other filters are ignored and the response contains only the accessible SDKs
        from this list.
      tags:
        - sdKs
      parameters:
        - name: workspaceId
          in: query
          description: The ID of the workspace that contains the SDK.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: sdkIds
          in: query
          description: >-
            A comma-separated list of SDK IDs to return in the response. If you pass this query parameter with other
            filters, the other filters are ignored.
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/sdkId'
        - name: buildStatus
          in: query
          description: Filter results by build status.
          required: false
          schema:
            $ref: '#/components/schemas/sdkBuildStatus'
        - name: language
          in: query
          description: Filter results by SDK language.
          required: false
          schema:
            $ref: '#/components/schemas/sdkLanguage'
        - name: sourceId
          in: query
          description: Filter results by the originating Postman Collection or specification ID.
          required: false
          schema:
            $ref: '#/components/schemas/sdkSourceId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25
            returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault25'
            default: 25
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SDKs_getSdks_Response_200'
        '400':
          description: Invalid Query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdksRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdksRequestForbiddenError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdksRequestInternalServerError'
    post:
      operationId: createSdk
      summary: Generate an SDK
      description: >
        Creates an asynchronous generation job for a single SDK (in one language) from a collection or specification.


        To get the status of an SDK's generation, use the GET `/sdks/{sdkId}` endpoint and track its `buildStatus`. When
        the status is the `succeeded` value, the SDK is ready to download. You can also use the URL in the POST
        response's `Location` header.


        **Note:**


        The request body is determined by the given `language` value, so only provide the properties relevant to that
        language's SDK.
      tags:
        - sdKs
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SDKs_createSdk_Response_202'
        '400':
          description: Malformed Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkRequestForbiddenError'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSdk'
  /sdks/{sdkId}:
    get:
      operationId: getSdk
      summary: Get an SDK
      description: Returns information about the SDK, including the current build job status.
      tags:
        - sdKs
      parameters:
        - name: sdkId
          in: path
          description: The SDK's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdk'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkRequestInternalServerError'
    delete:
      operationId: deleteSdk
      summary: Delete an SDK
      description: |
        Deletes an SDK record and its stored archive. On success, this returns a `204 No Content` response.

        **Note:**

        You can't use this endpoint to cancel a generation job that's still in progress.
      tags:
        - sdKs
      parameters:
        - name: sdkId
          in: path
          description: The SDK's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSdkRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSdkRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSdkRequestInternalServerError'
  /sdks/{sdkId}/downloads:
    get:
      operationId: getSdkDownloadUrl
      summary: Get an SDK's download URL
      description: >
        Gets a short-lived signed URL for the generated SDK archive (zip). The generated URL is created on demand and
        expires within a few minutes.


        **Note:**


        The API doesn't stream the archive directly to keep responses small and predictable. Use the returned URL to
        download the SDK zip file.
      tags:
        - sdKs
      parameters:
        - name: sdkId
          in: path
          description: The SDK's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkDownload'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkDownloadUrlRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkDownloadUrlRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkDownloadUrlRequestInternalServerError'
  /sdk-git-connections:
    get:
      operationId: getSdkGitConnections
      summary: Get all SDK Git connections
      description: >-
        Gets all Git repository connections the authenticated user has access to in the given workspace. Each connection
        links one Postman Collection or specification and one SDK language to a target Git repository.
      tags:
        - sdKs
      parameters:
        - name: workspaceId
          in: query
          description: The ID of the workspace that owns the source entities.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: sourceId
          in: query
          description: Filter results by the originating Postman Collection or specification ID.
          required: false
          schema:
            $ref: '#/components/schemas/sdkSourceId'
        - name: language
          in: query
          description: Filter results by SDK language.
          required: false
          schema:
            $ref: '#/components/schemas/sdkLanguage'
        - name: status
          in: query
          description: Filter results by connection status.
          required: false
          schema:
            $ref: '#/components/schemas/sdkGitConnectionStatus'
        - name: repositoryUrl
          in: query
          description: Filter results by the canonical URL of the target Git repository.
          required: false
          schema:
            $ref: '#/components/schemas/sdkGitConnectionRepositoryUrl'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25
            returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault25'
            default: 25
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkGitConnectionList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionsRequestForbiddenError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionsRequestInternalServerError'
    post:
      operationId: createSdkGitConnection
      summary: Connect a Git repository to an SDK
      description: >
        Connects a Postman source element (collection or specification) to a Git repository for one SDK language. This
        creates a new connection in the

        `active` state.


        **Note:**

        - Each source and language pair maps to a single connection. If a connection already exists for the pair, this
        returns `409 Conflict` response.

        - To update an existing connection, use the PUT `/sdk-git-connections/{sdkGitConnectionId}` endpoint.

        - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users. If the user is on
        a **Team** plan, this value is always `false`.
      tags:
        - sdKs
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkGitConnection'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkGitConnectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkGitConnectionRequestForbiddenError'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSdkGitConnectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSdkGitConnection'
  /sdk-git-connections/{sdkGitConnectionId}:
    get:
      operationId: getSdkGitConnection
      summary: Get an SDK Git connection
      description: >-
        Gets information about an SDK's Git connection. The response includes the SDK currently sent to the targetBranch
        and the most recent SDK-update pull request.
      tags:
        - sdKs
      parameters:
        - name: sdkGitConnectionId
          in: path
          description: The Git connection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkGitConnectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkGitConnection'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionRequestInternalServerError'
    put:
      operationId: updateSdkGitConnection
      summary: Update an SDK Git connection
      description: >
        Updates the Git connection's lifecycle status:


        - `active` — Connects or reconnects the repository. All auto-update pull requests resume.

        - `disconnected` — Disconnects the repository, and no further auto-update pull requests are opened. The
        historical pull request record is preserved and remains queryable.


        **Note:**


        - The `autoUpdatePullRequestsEnabled` property is only available to **Enterprise** plan users and defaults to
        `true`. If the user is on a **Team** plan, this value is always `false`.

        - This action is idempotent. Setting the fields to their current values is a no-op and still returns the
        connection.

        - The `inaccessible` status is system-determined and can't be set with this endpoint.
      tags:
        - sdKs
      parameters:
        - name: sdkGitConnectionId
          in: path
          description: The Git connection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkGitConnectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkGitConnection'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSdkGitConnectionRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSdkGitConnectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSdkGitConnectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSdkGitConnection'
  /sdk-git-connections/{sdkGitConnectionId}/pull-requests:
    get:
      operationId: getSdkGitConnectionPullRequests
      summary: Get an SDK Git connection's pull requests
      description: >
        Lists all SDK update pull requests for the Git connection, in order of newest first by its `updatedAt` property.


        **Note:**


        Direct push requests to the base branch are not returned in the response if a Git connection is configured to
        push only some changes directly to a base branch.
      tags:
        - sdKs
      parameters:
        - name: sdkGitConnectionId
          in: path
          description: The Git connection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/sdkGitConnectionId'
        - name: status
          in: query
          description: Filter results by pull request status.
          required: false
          schema:
            $ref: '#/components/schemas/sdkGitConnectionPRStatus'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 25. Any value greater than 25
            returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault25'
            default: 25
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sdkGitConnectionPullRequestList'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionPullRequestsRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionPullRequestsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSdkGitConnectionPullRequestsRequestInternalServerError'
  /search:
    post:
      operationId: postmanResources
      summary: Search Postman resources
      description: >
        Searches Postman for resources such as workspaces, collections, requests, and other resource types. You can
        filter results by ownership, visibility, tags, and other criteria.


        **Note:**


        If you call this endpoint without an API key, the response only returns publicly-available resources.
      tags:
        - search
      parameters:
        - name: limit
          in: query
          description: The maximum number of results to return per page.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault10Max25'
            default: 10
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/searchPostmanResourcesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchPostmanResourcesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/searchPostmanResources'
  /detected-secrets-queries:
    post:
      operationId: detectedSecretsQueries
      summary: Search detected secrets
      description: >-
        Returns all secrets detected by Postman's [Secret
        Scanner](https://learning.postman.com/docs/administration/secret-scanner/), grouped by workspace or resource. If
        you pass an empty request body, this endpoint returns all results.
      tags:
        - secretScanner
      parameters:
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: include
          in: query
          description: |
            The additional fields to be included as a part of the request:
            - `meta.total` — Include the total records found in the `meta` response object.
          required: false
          schema:
            $ref: '#/components/schemas/include'
        - name: since
          in: query
          description: >-
            Return only results created since the given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the
            `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateTime'
        - name: until
          in: query
          description: >-
            Return only results created until this given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than
            the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateTime'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/detectedSecretsQueries'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectedSecretsQueriesRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectedSecretsQueriesRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/detectedSecretsQueriesRequest'
  /detected-secrets/{secretId}:
    put:
      operationId: updateDetectedSecretResolutions
      summary: Update detected secret resolution status
      description: Updates the resolution status of a secret detected in a workspace.
      tags:
        - secretScanner
      parameters:
        - name: secretId
          in: path
          description: The secret's ID.
          required: true
          schema:
            $ref: '#/components/schemas/secretId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateSecretResolutions'
        '400':
          description: Invalid Resolution Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDetectedSecretResolutionsRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSecretResolutionsRequest'
  /detected-secrets/{secretId}/locations:
    get:
      operationId: getDetectedSecretsLocations
      summary: Get detected secrets locations
      description: >-
        Gets the locations of secrets detected by Postman's [Secret
        Scanner](https://learning.postman.com/docs/administration/secret-scanner/).
      tags:
        - secretScanner
      parameters:
        - name: secretId
          in: path
          description: The secret's ID.
          required: true
          schema:
            $ref: '#/components/schemas/secretId'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: since
          in: query
          description: >-
            Return only results created since the given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be later than the
            `until` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/sinceDateTime'
        - name: until
          in: query
          description: >-
            Return only results created until this given time, in [ISO
            8601](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) format. This value cannot be earlier than
            the `since` value. To use `time-numoffset` format, you must use `%2B` URL-encoding for the `+` character.
          required: false
          schema:
            $ref: '#/components/schemas/untilDateTime'
        - name: resourceType
          in: query
          description: Return only results that match the given resource type.
          required: false
          schema:
            $ref: '#/components/schemas/resourceType'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSecretsLocations'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDetectedSecretsLocationsRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
  /secret-types:
    get:
      operationId: getSecretTypes
      summary: Get secret types
      description: >-
        Gets the metadata of the secret types supported by Postman's [Secret
        Scanner](https://learning.postman.com/docs/administration/secret-scanner/). You can use a secret type's ID in
        the response to query data with the POST `/detected-secrets/{secretId}` endpoint.
      tags:
        - secretScanner
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSecretTypes'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSecretTypesRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
  /service-account-tokens:
    post:
      operationId: generateServiceAccountToken
      summary: Generate a Service Account Token
      description: >
        Exchanges a service account API key for a short-lived access token. On success, the response contains an access
        token that can be used to authenticate downstream service-to-service requests on behalf of the service account.
        The token is a JWT that encodes the service account's identity and permissions, and is valid for 15 minutes.


        **Note:**


        - The API key must belong to a service account. API keys that belong to regular users aren't supported.

        - This endpoint authorizes the service account API through the `x-api-key` passed as a header.

        - This endpoint has a rate limit of 10 requests per 10 second window per user.
      tags:
        - serviceAccounts
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: x-api-key
          in: header
          description: The service account API key, in PMAK format.
          required: true
          schema:
            $ref: '#/components/schemas/serviceAccountApiKey'
      responses:
        '200':
          description: Token Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateServiceAccountTokenResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateServiceAccountTokenRequestBadRequestError'
        '401':
          description: Invalid API Key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateServiceAccountTokenRequestInternalServerError'
  /apis/{apiId}/spec-migrations:
    get:
      operationId: getMigrationStatus
      summary: Get status of API Builder to Spec Hub migration
      description: Returns the status of an API Builder definition's migration to Spec Hub.
      tags:
        - specs
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMigrationStatus'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getMigrationStatus400Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMigrationStatusRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMigrationStatusRequestInternalServerError'
    post:
      operationId: migrateApiToSpecHub
      summary: Migrate API Builder API to Spec Hub
      description: >
        Migrates an API Builder definition to a [Spec
        Hub](https://learning.postman.com/docs/design-apis/specifications/overview) specification. You can migrate the
        definition to an existing workspace, or create a new workspace to migrate the definition into. On success, this
        returns an HTTP `202 Created` response. You can use the GET `/apis/{apiId}/spec-migrations` endpoint to check
        the migration status.


        **Note:**


        - This returns an HTTP `200 OK` response if the given API ID isn't an API Builder definition.

        - To migrate a Git-linked API Builder definition to Spec Hub, you must create a new workspace. Migration to an
        existing workspace isn't supported.
      tags:
        - specs
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Empty API Migration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/migrateToSpecHubResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrateApiToSpecHubRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrateApiToSpecHubRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MigrateApiToSpecHubRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/migrateApiToSpecHub'
  /collections/{collectionUid}/generations/{elementType}:
    get:
      operationId: getGeneratedCollectionSpecs
      summary: Get generated spec
      description: Gets the API specification generated for the given collection.
      tags:
        - specs
      parameters:
        - name: collectionUid
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: elementType
          in: path
          description: The `spec` value.
          required: true
          schema:
            $ref: '#/components/schemas/elementTypeSpec'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getGeneratedCollectionSpecs'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGeneratedCollectionSpecsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGeneratedCollectionSpecsRequestInternalServerError'
    post:
      operationId: generateSpecFromCollection
      summary: Generate spec from collection
      description: >-
        Generates an OpenAPI 2.0, 3.0, or 3.1 specification for the given collection. The response contains a polling
        link to the task status.
      tags:
        - specs
      parameters:
        - name: collectionUid
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: elementType
          in: path
          description: The `spec` value.
          required: true
          schema:
            $ref: '#/components/schemas/elementTypeSpec'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateTaskResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateSpecFromCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '423':
          description: Locked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateSpecFromCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateSpecFromCollection'
  /collections/{collectionUid}/synchronizations:
    put:
      operationId: syncCollectionWithSpec
      summary: Sync collection with spec
      description: >
        Syncs a collection generated from an API specification. This is an asynchronous endpoint that returns an HTTP
        `202 Accepted` response.


        **Note:**


        - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types.

        - You can only sync collections generated from the given spec ID.
      tags:
        - specs
      parameters:
        - name: collectionUid
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: specId
          in: query
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateTaskResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSpecRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncCollectionWithSpecRequestInternalServerError'
  /{elementType}/{elementId}/tasks/{taskId}:
    get:
      operationId: getAsyncSpecTaskStatus
      summary: Get status of an async spec task
      description: Gets the status of an asynchronous API specification creation task.
      tags:
        - specs
      parameters:
        - name: elementType
          in: path
          description: The element to filter results by.
          required: true
          schema:
            $ref: '#/components/schemas/elementType'
        - name: elementId
          in: path
          description: The element's ID.
          required: true
          schema:
            $ref: '#/components/schemas/elementId'
        - name: taskId
          in: path
          description: The task's ID.
          required: true
          schema:
            $ref: '#/components/schemas/taskId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specs_getAsyncSpecTaskStatus_Response_200'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAsyncSpecTaskStatusRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAsyncSpecTaskStatusRequestInternalServerError'
  /specs:
    get:
      operationId: getAllSpecs
      summary: Get all specs
      description: Gets all API specifications in a workspace.
      tags:
        - specs
      parameters:
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAllSpecs'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllSpecsRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllSpecsRequestInternalServerError'
    post:
      operationId: createSpec
      summary: Create a spec
      description: >
        Creates an API specification in Postman's [Spec
        Hub](https://learning.postman.com/docs/design-apis/specifications/overview/). Specifications can be single or
        multi-file.


        **Note:**

        - Postman supports OpenAPI (2.0, 3.0, and 3.1), AsyncAPI (2.0 and 3.0), protobuf (2 and 3), GraphQL, and Smithy
        specifications.

        - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path
        is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file
        inside.

        - Multi-file specifications can only have one root file.

        - Files cannot exceed a maximum of 12 MB in size.
      tags:
        - specs
      parameters:
        - name: workspaceId
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createSpecResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSpec'
  /specs/{specId}:
    get:
      operationId: getSpec
      summary: Get a spec
      description: Gets information about an API specification.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/specData'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecRequestInternalServerError'
    delete:
      operationId: deleteSpec
      summary: Delete a spec
      description: Deletes an API specification. On success, this returns an HTTP `204 No Content` response.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSpecRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSpecRequestInternalServerError'
    patch:
      operationId: updateSpecProperties
      summary: Update a spec's properties
      description: Updates an API specification's properties, such as its name.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Spec Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateSpecPropertiesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecPropertiesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecPropertiesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSpecProperties'
  /specs/{specId}/collections/{collectionId}/sync-options:
    patch:
      operationId: updateSpecSyncOptions
      summary: Update spec sync options
      description: >-
        Updates the [sync
        options](https://learning.postman.com/docs/design-apis/specifications/generate-collections/#configure-sync-settings)
        for a specification's generated collection.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: collectionId
          in: path
          description: The collection's ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiSpecSyncOptions'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecSyncOptionsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecSyncOptionsRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/apiSpecSyncOptions'
  /specs/{specId}/definitions:
    get:
      operationId: getSpecDefinition
      summary: Get a spec's definition
      description: Gets the complete contents of an OpenAPI or AsyncAPI specification's definition.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Specs_getSpecDefinition_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecDefinitionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecDefinitionRequestInternalServerError'
  /specs/{specId}/files:
    get:
      operationId: getSpecFiles
      summary: Get a spec's files
      description: Gets all the files in an API specification.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSpecFiles'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecFilesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecFilesRequestInternalServerError'
    post:
      operationId: createSpecFile
      summary: Create a spec file
      description: >
        Creates a file for an OpenAPI or a protobuf 2 or 3 specification.


        **Note:**


        - If the file path contains a `/` (forward slash) character, then a folder is created. For example, if the path
        is the `components/schemas.json` value, then a `components` folder is created with the `schemas.json` file
        inside.

        - Creating a spec file assigns it the `DEFAULT` file type.

        - Multi-file specifications can only have one root file.

        - Files cannot exceed a maximum of 10 MB in size.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUpdateSpecFileResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecFileRequestInternalServerError'
      requestBody:
        description: Create Spec File
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSpecFile'
  /specs/{specId}/files/{filePath}:
    get:
      operationId: getSpecFile
      summary: Get a spec file
      description: Gets the contents of an API specification's file.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: filePath
          in: path
          description: The path to the file.
          required: true
          schema:
            $ref: '#/components/schemas/filePath'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSpecFile'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecFileRequestInternalServerError'
    delete:
      operationId: deleteSpecFile
      summary: Delete a spec file
      description: Deletes a file in an API specification. On success, this returns an HTTP `204 No Content` response.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: filePath
          in: path
          description: The path to the file.
          required: true
          schema:
            $ref: '#/components/schemas/filePath'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSpecFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSpecFileRequestInternalServerError'
    patch:
      operationId: updateSpecFile
      summary: Update a spec file
      description: >
        Updates a file for an OpenAPI or protobuf 2 or 3 specification.


        **Note:**


        - This endpoint does not accept an empty request body. You must pass one of the accepted values.

        - This endpoint does not accept multiple request body properties in a single call. For example, you cannot pass
        both the `content` and `type` property at the same time.

        - Multi-file specifications can only have one root file.

        - When updating a file type to `ROOT`, the previous root file is updated to the `DEFAULT` file type.

        - Files cannot exceed a maximum of 10 MB in size.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: filePath
          in: path
          description: The path to the file.
          required: true
          schema:
            $ref: '#/components/schemas/filePath'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createUpdateSpecFileResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecFileRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSpecFileRequestInternalServerError'
      requestBody:
        description: Update Spec File
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateSpecFile'
  /specs/{specId}/generations/{elementType}:
    get:
      operationId: getSpecCollections
      summary: Get a spec's generated collections
      description: Gets all of an API specification's generated collections.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: elementType
          in: path
          description: The `collection` element type.
          required: true
          schema:
            $ref: '#/components/schemas/elementTypeCollection'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSpecCollections'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecCollectionsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecCollectionsRequestInternalServerError'
    post:
      operationId: generateCollection
      summary: Generate a collection from spec
      description: >-
        Creates a collection from the given OpenAPI 2.0, 3.0, or 3.1 specification or Smithy specification. The response
        contains a polling link to the task status.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: elementType
          in: path
          description: The `collection` element type.
          required: true
          schema:
            $ref: '#/components/schemas/elementTypeCollection'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateTaskResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '423':
          description: Locked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateCollectionRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/generateCollection'
  /specs/{specId}/synchronizations:
    put:
      operationId: syncSpecWithCollection
      summary: Sync spec with collection
      description: >
        Syncs an API specification linked to a collection. This is an asynchronous endpoint that returns an HTTP `202
        Accepted` response.


        **Note:**


        - This endpoint only supports the OpenAPI 2.0, 3.0, and 3.1 specification types.

        - You can only sync collections generated from the given specification ID.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: collectionUid
          in: query
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/generateTaskResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncSpecWithCollectionRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncSpecWithCollectionRequestInternalServerError'
  /specs/{specId}/version-tags/{tagId}/files:
    get:
      operationId: getSpecVersionTag
      summary: Get a version tag
      description: >-
        Gets information about a specification's version tag. The response returns a snapshot of a specification at a
        point in time that lets you track changes to your specifications over time.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: tagId
          in: path
          description: The version tag's ID.
          required: true
          schema:
            $ref: '#/components/schemas/tagId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSpecVersionTag'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecVersionTagRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecVersionTagRequestInternalServerError'
  /specs/{specId}/version-tags:
    get:
      operationId: getSpecVersionTags
      summary: Get a specification's version tags
      description: Gets a list of a specification's version tags.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limit'
            default: 10
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getSpecVersionTags'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecVersionTagsRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecVersionTagsRequestInternalServerError'
    post:
      operationId: createSpecVersionTag
      summary: Create a version tag
      description: >
        Creates a version tag for a specification. Version tags are snapshots of a specification at a point in time that
        let you to track changes to your specifications over time.


        **Note:**


        Conflicts can occur if you try to create a version tag for a changelog group that already has a version tag. To
        resolve this, make new changes to the specification to create a new changelog group, then create a version tag
        on that new changelog group.
      tags:
        - specs
      parameters:
        - name: specId
          in: path
          description: The spec's ID.
          required: true
          schema:
            $ref: '#/components/schemas/specId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createSpecVersionTagResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecVersionTagRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateSpecVersionTagRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createSpecVersionTag'
  /apis/{apiId}/tags:
    get:
      operationId: getApiTags
      summary: Get an API's tags
      description: Gets all the tags associated with an API.
      tags:
        - tags
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '400':
          description: Missing v10 Accept Header
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apiErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      deprecated: true
    put:
      operationId: updateApiTags
      summary: Update an API's tags
      description: >-
        Updates an API's associated tags. This endpoint replaces all existing tags with those you pass in the request
        body.
      tags:
        - tags
      parameters:
        - name: apiId
          in: path
          description: The API's ID.
          required: true
          schema:
            $ref: '#/components/schemas/apiId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Accept
          in: header
          description: The `application/vnd.api.v10+json` request header required to use the endpoint.
          required: true
          schema:
            $ref: '#/components/schemas/v10Accept'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateApiTagsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagUpdateTags'
  /collections/{collectionId}/tags:
    get:
      operationId: getCollectionTags
      summary: Get a collection's tags
      description: Gets all the tags associated with a collection.
      tags:
        - tags
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
    put:
      operationId: updateCollectionTags
      summary: Update a collection's tags
      description: >-
        Updates a collection's associated tags. This endpoint replaces all existing tags with those you pass in the
        request body.
      tags:
        - tags
      parameters:
        - name: collectionId
          in: path
          description: The collection's unique ID.
          required: true
          schema:
            $ref: '#/components/schemas/collectionUid'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateCollectionTagsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagUpdateTags'
  /tags/{slug}/entities:
    get:
      operationId: getTaggedEntities
      summary: Get elements by tag
      description: >
        Gets Postman elements (entities) by a given tag. Tags enable you to organize and search
        [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace),
        [APIs](https://learning.postman.com/docs/designing-and-developing-your-api/managing-apis/#tagging-apis), and
        [collections](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection) that
        contain shared tags.


        **Note:**


        Tagging is available on Postman [**Solo**, **Team**, and **Enterprise**
        plans](https://www.postman.com/pricing/).
      tags:
        - tags
      parameters:
        - name: slug
          in: path
          description: The tag's ID within a team or individual (non-team) user scope.
          required: true
          schema:
            $ref: '#/components/schemas/tagsSlug'
        - name: limit
          in: query
          description: The maximum number of tagged elements to return in a single call.
          required: false
          schema:
            $ref: '#/components/schemas/tagsEntitiesLimit'
            default: 10
        - name: direction
          in: query
          description: >-
            The ascending (`asc`) or descending (`desc`) order to sort the results by, based on the time of the entity's
            tagging.
          required: false
          schema:
            $ref: '#/components/schemas/ascDescDefaultDesc'
            default: desc
        - name: cursor
          in: query
          description: >-
            The cursor to get the next set of results in the paginated response. If you pass an invalid value, the API
            only returns the first set of results.
          required: false
          schema:
            $ref: '#/components/schemas/tagsCursor'
        - name: entityType
          in: query
          description: Filter results for the given entity type.
          required: false
          schema:
            $ref: '#/components/schemas/tagsEntityType'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTaggedEntities'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagElement400Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
  /workspaces/{workspaceId}/tags:
    get:
      operationId: getWorkspaceTags
      summary: Get a workspace's tags
      description: Gets all the tags associated with a workspace.
      tags:
        - tags
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
    put:
      operationId: updateWorkspaceTags
      summary: Update a workspace's tags
      description: >-
        Updates a workspace's associated tags. This endpoint replaces all existing tags with those you pass in the
        request body.
      tags:
        - tags
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tagGetPut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceTagsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tagUpdateTags'
  /teams:
    get:
      operationId: getTeams
      summary: Get all teams
      description: Gets all Postman teams in your organization.
      tags:
        - teams
      parameters:
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault50'
            default: 50
        - name: settings
          in: query
          description: If true, returns team settings in the response.
          required: false
          schema:
            $ref: '#/components/schemas/teamSettingsQuery'
            default: false
        - name: userRoles
          in: query
          description: If true, returns the team's assigned user roles in the response.
          required: false
          schema:
            $ref: '#/components/schemas/userRolesQuery'
            default: false
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Teams_getTeams_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
    post:
      operationId: createTeam
      summary: Create a team
      description: >
        [Creates](https://learning.postman.com/docs/administration/managing-your-team/create-teams/) a Postman team in
        your organization.
      tags:
        - teams
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGetTeamResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTeamRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createTeam'
  /teams/{teamId}:
    get:
      operationId: getTeam
      summary: Get a team
      description: Gets information about a Postman team.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: include
          in: query
          description: >
            Include additional information in the request's response:

            - `members` — Include all users and groups, including groups that represent other teams or the entire
            organization, with access to the team's entities. This includes team managers, members, and persons invited
            to collaborate as guests.

            - `userRoles` — Include all the team's user roles in the response.
          required: false
          schema:
            $ref: '#/components/schemas/teamsInclude'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGetTeamResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
  /teams/{teamId}/access-requests:
    get:
      operationId: getTeamAccessRequests
      summary: Get a team's access requests
      description: Gets a team's pending access requests.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault50'
            default: 50
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTeamAccessRequests'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamAccessRequestsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
    post:
      operationId: createAccessRequest
      summary: Create an access request
      description: >
        Creates an access request for a team. Access requests include actions such as request to join a team, upgrading
        a user's role, adding members, and requesting team role access to another team.


        **Note:**


        If a team discovery is enabled, the team's access request is automatically approved.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createAccessRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAccessRequestRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAccessRequest'
  /teams/{teamId}/access-requests/{requestId}:
    post:
      operationId: approveDenyAccessRequest
      summary: Approve or deny an access request
      description: Approve or deny a team's access request.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: requestId
          in: path
          description: The access request's ID.
          required: true
          schema:
            $ref: '#/components/schemas/accessRequestId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/approveDenyAccessRequestResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApproveDenyAccessRequestRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/approveDenyAccessRequest'
  /teams/{teamId}/bulk-members:
    post:
      operationId: manageTeamMemberRoles
      summary: Manage team member roles
      description: |
        Adds or removes member roles in groups, teams, organizations, as well as individual users' roles.

        **Note:**

        If you remove a role from a group or team, then all members lose the that role's permissions.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/manageTeamMemberRolesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageTeamMemberRolesRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/manageTeamMemberRoles'
    delete:
      operationId: removeTeamMembers
      summary: Remove team members
      description: >-
        Removes entities, such as users or organizations, from your Postman team. On success, this returns an HTTP `204
        No Content` response.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user and group IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '204':
          description: Remove Team Member
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveTeamMembersRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/removeTeamMembers'
  /teams/{teamId}/settings:
    get:
      operationId: getTeamSettings
      summary: Get a team's settings
      description: Gets a team's settings.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGetTeamSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamSettingsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
    put:
      operationId: updateTeamSettings
      summary: Update team settings
      description: Updates a team's settings.
      tags:
        - teams
      parameters:
        - name: teamId
          in: path
          description: The team's ID.
          required: true
          schema:
            $ref: '#/components/schemas/teamId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createGetTeamSettingsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTeamSettingsRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamsError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateTeamSettings'
  /me:
    get:
      operationId: getAuthenticatedUser
      summary: Get authenticated user
      description: >
        Gets information about the authenticated user.


        **Note:**


        - This API returns a different response for users with the [Guest and Partner
        roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - The `flow_count` response only returns for users on [Free plans](https://www.postman.com/pricing/).
      tags:
        - users
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAuthenticatedUser'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticatedUserRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticatedUserRequestInternalServerError'
  /users:
    get:
      operationId: getTeamUsers
      summary: Get all team users
      description: >-
        Gets information about all users on the [Postman
        team](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/).
      tags:
        - users
      parameters:
        - name: groupId
          in: query
          description: >-
            Filter results by the given [group](https://learning.postman.com/docs/collaborating-in-postman/user-groups/)
            ID. To get group IDs, use the GET `/groups` endpoint.
          required: false
          schema:
            $ref: '#/components/schemas/groupId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTeamUsers'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUsersRequestInternalServerError'
  /users/{userId}:
    get:
      operationId: getTeamUser
      summary: Get a team user
      description: Gets information about a user on the Postman team.
      tags:
        - users
      parameters:
        - name: userId
          in: path
          description: The user's ID.
          required: true
          schema:
            $ref: '#/components/schemas/userId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/teamUser'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTeamUserRequestInternalServerError'
  /webhooks:
    post:
      operationId: createWebhook
      summary: Create a webhook
      description: >
        Creates a webhook that triggers a collection with a custom payload. You can get the webhook's URL from the
        `webhookUrl` property in the endpoint's response.


        **Note:**


        If you do not include the `workspace` query parameter, the system creates the webhook in the oldest personal
        Internal workspace you own.
      tags:
        - webhooks
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createWebhookResponse'
        '400':
          description: Missing Parameter
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessageDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookRequestUnauthorizedError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createWebhook'
  /invitations:
    post:
      operationId: managePartnerWorkspaceInvites
      summary: Manage Partner Workspace invites
      description: >
        Manages invitations and access to your team's [Partner
        Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/manage/).
        You can use this endpoint to:


        - Send Partner Workspace invitations to the given email addresses. Users who already exist in the partnership
        are added directly, while new users receive an invitation email.

        - Remove partners from a workspace.

        - Remove partners from a partnership and all of its workspaces.


        **Note:**


        - Partner Workspaces are available on the Postman **Team** and **Enterprise**
        [plans](https://www.postman.com/pricing/).

        - This endpoint requires the following
        [roles](https://learning.postman.com/docs/administration/roles-and-permissions/), based on your plan:
          - **Team** — Requires the **Workspace Editor** role to invite or remove partners from workspaces. The **Admin** role is required for removing partners from all workspaces.
          - **Enterprise** — The **Partner Manager** role can perform all operations. The **Workspace Editor** role and **Admin** roles have the same permissions on this plan as they do on the Team plan. It's recommended to use the **Partner Manager** role if you're on an **Enterprise** plan.
      tags:
        - workspaces
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspaces_managePartnerWorkspaceInvites_Response_200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Workspaces_managePartnerWorkspaceInvites_Request'
  /workspaces:
    get:
      operationId: getWorkspaces
      summary: Get all workspaces
      description: >
        Gets all
        [workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).
        The response includes your workspaces and any workspaces that you have access to.


        **Note:**


        This endpoint's response contains the visibility field. Visibility determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
        only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and
        [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can
        access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
      tags:
        - workspaces
      parameters:
        - name: type
          in: query
          description: The type of workspace to filter the response by.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceTypeQuery'
        - name: createdBy
          in: query
          description: >-
            Return only workspaces created by a specific user ID. For multiple users, pass this value as a
            comma-separated list of user IDs. The response only returns workspaces that you have access to.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceCreatedBy'
        - name: include
          in: query
          description: |
            Include the following information in the endpoint's response:
            - `mocks:deactivated` — Include all deactivated mock servers in the response.
            - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.
          required: false
          schema:
            $ref: '#/components/schemas/workspacesIncludeQuery'
        - name: elementType
          in: query
          description: >-
            Filter results to return the workspace where the given element type is located. If you pass this query
            parameter, you must also pass the `elementId` query parameter.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceElementTypeQuery'
        - name: elementId
          in: query
          description: >-
            Filter results to return the workspace where the given element's ID is located. When filtering by
            collection, you must use the collection's unique ID (`userId`-`collection`). If you pass this query
            parameter, you must also pass the `elementType` query parameter.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceElementIdQuery'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: limit
          in: query
          description: >-
            The maximum number of rows to return in the response, up to a maximum value of 100. Any value greater than
            100 returns a 400 Bad Request response.
          required: false
          schema:
            $ref: '#/components/schemas/limitMax100'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspaces'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspacesRequestBadRequestError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspacesRequestUnauthorizedError'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspacesRequestInternalServerError'
    post:
      operationId: createWorkspace
      summary: Create a workspace
      description: >
        Creates a new
        [workspace](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/).


        **Note:**


        - This endpoint returns a 403 `Forbidden` response if the user does not have permission to create workspaces.
        [Admins and Super
        Admins](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles) can
        configure workspace permissions to restrict users and/or user groups from creating workspaces or require
        approvals for the creation of team workspaces.

        - Private and [Partner
        Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are
        available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing).

        - There are rate limits when publishing public workspaces.

        - Public team workspace names must be unique.

        - The `teamId` property must be passed in the request body if [Postman
        Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) is enabled.
      tags:
        - workspaces
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createWorkspaceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace403Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createWorkspace'
  /workspaces-roles:
    get:
      operationId: getAllWorkspaceRoles
      summary: Get all roles
      description: Gets information about all roles in a workspace, based on the team's [plan](https://www.postman.com/pricing/).
      tags:
        - workspaces
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getAllWorkspaceRoles'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllWorkspaceRolesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllWorkspaceRolesRequestForbiddenError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllWorkspaceRolesRequestInternalServerError'
  /workspaces/{workspaceId}:
    get:
      operationId: getWorkspace
      summary: Get a workspace
      description: >
        Gets information about a workspace.


        **Note:**


        This endpoint's response contains the `visibility` field.
        [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
        determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
        only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and
        [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can
        access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: include
          in: query
          description: >
            A comma-separated list of values to include in the endpoint's response:

            - `scim` — Return the SCIM user IDs of the workspace creator and who last modified it.

            - `team` — Return the workspace's team ID. Returns a null value if the workspace isn't associated with a
            team.

            - `mocks:deactivated` — Include all deactivated mock servers in the response.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceIncludeQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspace'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRequestUnauthorizedError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspace404Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRequestInternalServerError'
    put:
      operationId: updateWorkspace
      summary: Update a workspace
      description: |
        Updates a workspace's property, such as its name or visibility.

        **Note:**

        - This endpoint does not support the following visibility changes:
          - `private` to `public`, `public` to `private`, and `private` to `personal` for **Free** and **Solo** [plans](https://www.postman.com/pricing/).
          - `public` to `personal` for team users only.
        - There are rate limits when publishing public workspaces.
        - Public team workspace names must be unique.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateWorkspaceResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '404':
          description: Instance Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateWorkspace'
    delete:
      operationId: deleteWorkspace
      summary: Delete a workspace
      description: Deletes an existing workspace.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleteWorkspace'
        '400':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorNameMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceRequestUnauthorizedError'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorErrorMessage'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceRequestInternalServerError'
  /workspaces/{workspaceId}/activities:
    get:
      operationId: getWorkspaceActivityFeed
      summary: Get a workspace's activity feed
      description: >-
        Gets a workspace's [activity
        feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/changelog-and-restoring-collections/#view-workspace-activity).
        Activity feeds return information about who added or removed collections, environments, or elements from a
        workspace, and users that join or leave a workspace.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: userId
          in: query
          description: Filter results by the given user ID.
          required: false
          schema:
            $ref: '#/components/schemas/userId-2'
        - name: elementType
          in: query
          description: A comma-separated list of elements to filter the results by.
          required: false
          schema:
            $ref: '#/components/schemas/elementType-3'
        - name: limit
          in: query
          description: The maximum number of rows to return in the response.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault15'
            default: 15
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspaceActivityFeed'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceActivityFeedRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceActivityFeedRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceActivityFeedRequestInternalServerError'
  /workspaces/{workspaceId}/element-transfers:
    post:
      operationId: transferWorkspaceElement
      summary: Transfer element to a workspace
      description: >
        Transfers a [Postman element](https://learning.postman.com/docs/getting-started/basics/postman-elements/) from
        one workspace to another workspace. Supported elements include collections, environments, mocks, monitors, and
        Flows modules and actions.


        When copying an element between workspaces, the [activity
        feed](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/workspace-activity/) for both
        workspaces update to reflect the change.


        **Note:**


        This endpoint does not support transferring elements from team workspaces to personal workspaces.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transferWorkspaceElementResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferWorkspaceElementRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferWorkspaceElement'
  /workspaces/{workspaceId}/global-variables:
    get:
      operationId: getWorkspaceGlobalVariables
      summary: Get global variables
      description: >-
        Gets a workspace's global
        [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). Global variables
        enable you to access data between collections, requests, scripts, and environments and are available throughout
        a workspace.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspaceGlobalVariables'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
    put:
      operationId: updateWorkspaceGlobalVariables
      summary: Update global variables
      description: >-
        Updates and replaces a workspace's global
        [variables](https://learning.postman.com/docs/sending-requests/variables/#variable-scopes). This endpoint
        replaces all existing global variables with the variables you pass in the request body.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateWorkspaceGlobalVariablesResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetail'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateWorkspaceGlobalVariables'
  /workspaces/{workspaceId}/roles:
    get:
      operationId: getWorkspaceRoles
      summary: Get a workspace's roles
      description: |
        Gets the roles of users, user groups, and partners in a workspace.

        **Note:**

        Partner roles don't support SCIM IDs.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: include
          in: query
          description: |
            Include the following information in the endpoint's response:
            - `scim` — Return IDs as SCIM user and group IDs.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceIncludeScimQuery'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspaceRoles'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRolesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRolesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceRolesRequestInternalServerError'
    patch:
      operationId: updateWorkspaceRoles
      summary: Update workspace roles
      description: >
        Updates the roles of users, [user
        groups](https://learning.postman.com/docs/collaborating-in-postman/user-groups/), or partners in a workspace. To
        get a list of roles, use the GET `/workspace-roles` endpoint. To get a group ID, use the GET `/groups` endpoint.


        **Note:**


        - User groups are available on Postman [**Enterprise** plans](https://www.postman.com/pricing).

        - To use SCIM IDs for users and user groups, include the `identifierType=scim` header when you call this
        endpoint. To get SCIM user IDs, include the `include=scim` query parameter when calling the GET
        `/workspaces/{workspaceId}` or GET `/workspaces` endpoints.

        - You can't set roles for users in personal workspaces.

        - This endpoint doesn't support the external [Guest
        role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).

        - The partner **Editor** and **Editor and Partner Lead** roles aren't supported in multi-partner workspaces.

        - You can't update partner and user roles in the same operation.

        - This endpoint is restricted to 50 operations per call.

        - The request body must contain one unique action per user, user group, or partner. For example, you cannot add
        and remove multiple roles for a user in the same request body.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: identifierType
          in: header
          description: Use SCIM user IDs instead of Postman user IDs.
          required: false
          schema:
            $ref: '#/components/schemas/identifierType'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateWorkspaceRolesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceRolesRequestUnauthorizedError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceRolesRequestForbiddenError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaceRoles422Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceRolesRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateWorkspaceRoles'
  /workspaces/{workspaceId}/transfers:
    patch:
      operationId: transferWorkspaceToTeam
      summary: Transfer workspace to a team
      description: >
        Transfers a workspace from one team (`source`) to another team (`destination`).


        **Note:**


        - These endpoints are only available with [Postman **Enterprise** plans](https://www.postman.com/pricing/) with
        [Postman Organizations](https://learning.postman.com/docs/administration/onboarding-checklist) enabled.

        - Team user roles are modified when workspaces are transferred. For example, if a user has the Admin role in the
        `source` team but not the `destination` team, then their role is removed from the workspace after it's
        transferred to the `destination` team.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transferWorkspaceToTeamResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transferWorkspaceToTeam'
  /workspaces/{workspaceId}/updates:
    get:
      operationId: getWorkspaceUpdates
      summary: Get all workspace updates
      description: Gets a list of workspace updates for the given workspace.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: category
          in: query
          description: >-
            A comma-separated list of categories to filter the results by. Accepts `improvement`, `bug_fix`,
            `new_feature`, `breaking_change`, `announcement`.
          required: false
          schema:
            $ref: '#/components/schemas/workspaceUpdateCategory'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getWorkspaceUpdates'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceUpdatesRequestInternalServerError'
    post:
      operationId: createWorkspaceUpdate
      summary: Create a workspace update
      description: >-
        Creates a [workspace
        update](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/internal-workspaces/workspace-updates)
        in the given workspace. Workspace updates keep workspace watchers informed about changes, such as new features,
        bug fixes, breaking changes, and announcements.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaceUpdatePostPatchResponseData'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceUpdateRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createWorkspaceUpdate'
  /workspaces/{workspaceId}/updates/{updateId}:
    get:
      operationId: getWorkspaceUpdate
      summary: Get a workspace update
      description: Gets information about a workspace update.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: updateId
          in: path
          description: The workspace update's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceUpdateId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaceUpdateData'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWorkspaceUpdateRequestInternalServerError'
    delete:
      operationId: deleteWorkspaceUpdate
      summary: Delete a workspace update
      description: Deletes a workspace update. On success, this returns an HTTP `204 No Content` response.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: updateId
          in: path
          description: The workspace update's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceUpdateId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Workspace Update Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceUpdateRequestInternalServerError'
    patch:
      operationId: patchWorkspaceUpdate
      summary: Update a workspace update
      description: |
        Updates a workspace update.

        **Note:**

        This endpoint requires the `application/merge-patch+json` Content-Type header.
      tags:
        - workspaces
      parameters:
        - name: workspaceId
          in: path
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: updateId
          in: path
          description: The workspace update's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceUpdateId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaceUpdatePostPatchResponseData'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchWorkspaceUpdateRequestInternalServerError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateWorkspaceUpdate'
  /packages:
    get:
      operationId: getPackages
      summary: Get all packages
      description: |
        Gets all active packages available to the authenticated user.

        **Note:**

        Script content isn't included in response.
      tags:
        - packages
      parameters:
        - name: limit
          in: query
          description: The maximum number of packages to return.
          required: false
          schema:
            $ref: '#/components/schemas/limitDefault100Max100'
            default: 100
        - name: cursor
          in: query
          description: >-
            The pointer to the first record of the set of paginated results. To view the next response, use the
            `nextCursor` value for this parameter.
          required: false
          schema:
            $ref: '#/components/schemas/cursor'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPackages'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
    post:
      operationId: createPackage
      summary: Create a package
      description: Creates a package and its index script as a Postman Package Library resource.
      tags:
        - packages
      parameters:
        - name: workspace
          in: query
          description: The workspace's ID.
          required: true
          schema:
            $ref: '#/components/schemas/workspaceId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '201':
          description: Package Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createPackageResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createPackage'
  /packages/{packageId}:
    get:
      operationId: getPackage
      summary: Get a package
      description: Gets an active package's metadata and its current index script content.
      tags:
        - packages
      parameters:
        - name: packageId
          in: path
          description: The package's ID.
          required: true
          schema:
            $ref: '#/components/schemas/packageId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getPackage'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
    delete:
      operationId: deletePackage
      summary: Delete a package
      description: >
        Deletes the package and its associated index script content. On success, this returns an HTTP `204 No Content`
        response.


        **Note:**


        The endpoint returns an HTTP `204 No Content` response even if the package no longer exists.
      tags:
        - packages
      parameters:
        - name: packageId
          in: path
          description: The package's ID.
          required: true
          schema:
            $ref: '#/components/schemas/packageId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Package Deleted
          content:
            application/json:
              schema:
                type: object
                properties: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
    patch:
      operationId: updatePackage
      summary: Update a package
      description: Updates a package's description and/or index script content.
      tags:
        - packages
      parameters:
        - name: packageId
          in: path
          description: The package's ID.
          required: true
          schema:
            $ref: '#/components/schemas/packageId'
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Package Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updatePackageResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updatePackage'
servers:
  - url: https://api.postman.com
    description: https://api.postman.com
  - url: https://api.eu.postman.com
    description: https://api.eu.postman.com
components:
  schemas:
    analyticsResource:
      type: string
      enum:
        - user
        - team
        - workspace
        - ai
        - api_development
        - api_testing
        - api_production
        - api_distribution
        - api_management
      title: analyticsResource
    analyticsMetrics:
      type: string
      enum:
        - active_users
        - workspace_active_users
        - elements_in_workspace
        - active_workspaces
        - api_calls
        - active_collections
        - response_status
        - pending_invites
        - needs_attention
        - success_rate
        - user_requests
        - user_api_journey
        - workspace_distribution
        - internal_workspace_distribution
        - license_consumption
        - members
        - last_autoflex_cycle
        - partner_engagement_funnel
        - collection_error_aggregate
        - agent_mode_users
        - new_vs_returning_users
        - agent_mode_sessions
        - messages_sent
        - credit_usage
        - credit_usage_by_model
        - usage_leaderboard
        - peak_activity
        - activity_distribution
        - top_agent_models_by_usage
        - entity_activity
        - top_entities
        - runs
        - functional_test_runs
        - performance_test_runs
        - monitor_runs
        - flow_executions
        - pvt_network
        - partner
        - public
        - workspace_activity
        - members_overtime
        - member_invites
        - invites_sent
        - invites_accepted
      title: analyticsMetrics
    analyticsView:
      type: string
      enum:
        - detailed
        - summary
        - trend
      title: analyticsView
    analyticsWorkspaceType:
      type: string
      title: analyticsWorkspaceType
    analyticsUserId:
      type: string
      title: analyticsUserId
    analyticsDuration:
      type: string
      enum:
        - last_30_days
        - last_180_days
        - last_month
        - last_6_months
        - last_7_days
        - last_1_year
      title: analyticsDuration
    analyticsRequestId:
      type: string
      title: analyticsRequestId
    analyticsResponseStatus:
      type: string
      title: analyticsResponseStatus
    analyticsAttentionType:
      type: string
      title: analyticsAttentionType
    analyticsPeriod:
      type: string
      title: analyticsPeriod
    analyticsUserType:
      type: string
      enum:
        - new
        - returning
      title: analyticsUserType
    analyticsEntityType:
      type: string
      enum:
        - collection
        - specification
        - mock
        - flow
        - sdk-collection
        - sdk-specification
      title: analyticsEntityType
    limitDefault100Max10000:
      type: integer
      minimum: 1
      maximum: 10000
      default: 100
      title: limitDefault100Max10000
    offsetMax10000:
      type: integer
      minimum: 0
      maximum: 10000
      default: 0
      title: offsetMax10000
    GetAnalyticsDataColumnsDataItemsType:
      type: string
      enum:
        - DATE
        - STRING
        - INTEGER
        - TIMESTAMP
        - BOOLEAN
        - NUMBER
        - FLOAT
      description: The data type of the column.
      title: GetAnalyticsDataColumnsDataItemsType
    GetAnalyticsDataColumnsDataItems:
      type: object
      properties:
        name:
          type: string
          description: The name of the column.
        type:
          $ref: '#/components/schemas/GetAnalyticsDataColumnsDataItemsType'
          description: The data type of the column.
        format:
          type: string
          description: The data type's format.
        description:
          type: string
          description: A description of what the column represents.
      title: GetAnalyticsDataColumnsDataItems
    getAnalyticsDataColumnsData:
      type: array
      items:
        $ref: '#/components/schemas/GetAnalyticsDataColumnsDataItems'
      description: A list of column entries.
      title: getAnalyticsDataColumnsData
    getAnalyticsDataSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      title: getAnalyticsDataSchema
    GetAnalyticsDataRowsDataItemsItems:
      oneOf:
        - type: string
        - type: integer
        - type: number
          format: double
        - type: boolean
      title: GetAnalyticsDataRowsDataItemsItems
    getAnalyticsDataRowsData:
      type: array
      items:
        type: array
        items:
          $ref: '#/components/schemas/GetAnalyticsDataRowsDataItemsItems'
      description: A list of data row entries. Each row is an array of values that correspond to the columns defined in the schema.
      title: getAnalyticsDataRowsData
    getAnalyticsDataPaginationData:
      type: object
      properties:
        total:
          type: integer
          description: The total number of records available.
        limit:
          type: integer
          description: The maximum number of records returned in the response.
        offset:
          type: integer
          description: The number of records skipped.
        has_more:
          type: boolean
          description: Indicates whether more are records available.
      description: Information about the response pagination.
      title: getAnalyticsDataPaginationData
    getAnalyticsDataObject:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/getAnalyticsDataSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Data analytics information.
      title: getAnalyticsDataObject
    getAnalyticsDataSummary:
      type: object
      properties:
        summary:
          $ref: '#/components/schemas/getAnalyticsDataObject'
      required:
        - summary
      title: getAnalyticsDataSummary
    getAnalyticsDataAllPartners:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/getAnalyticsDataSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Information about partner users and their activity.
      title: getAnalyticsDataAllPartners
    getAnalyticsDataPartnerWorkspaceVisited:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/getAnalyticsDataSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Information about partner users' workspace visits.
      title: getAnalyticsDataPartnerWorkspaceVisited
    GetAnalyticsDataPartnersViewedCollectionSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      title: GetAnalyticsDataPartnersViewedCollectionSchema
    getAnalyticsDataPartnersViewedCollection:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/GetAnalyticsDataPartnersViewedCollectionSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Information about partner users' views of collections in a workspace.
      title: getAnalyticsDataPartnersViewedCollection
    GetAnalyticsDataPartnerRequestSentSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      title: GetAnalyticsDataPartnerRequestSentSchema
    getAnalyticsDataPartnerRequestSent:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/GetAnalyticsDataPartnerRequestSentSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Information about requests sent by partner users.
      title: getAnalyticsDataPartnerRequestSent
    GetAnalyticsDataPartnerRequestSent200OkSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      title: GetAnalyticsDataPartnerRequestSent200OkSchema
    getAnalyticsDataPartnerRequestSent200OK:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/GetAnalyticsDataPartnerRequestSent200OkSchema'
        rows:
          $ref: '#/components/schemas/getAnalyticsDataRowsData'
        pagination:
          $ref: '#/components/schemas/getAnalyticsDataPaginationData'
      description: Information about partner users' successful request calls in a workspace.
      title: getAnalyticsDataPartnerRequestSent200OK
    getAnalyticsDataPartnerEngagmentFunnel:
      type: object
      properties:
        all_partners:
          $ref: '#/components/schemas/getAnalyticsDataAllPartners'
        workspace_visited:
          $ref: '#/components/schemas/getAnalyticsDataPartnerWorkspaceVisited'
        viewed_collection:
          $ref: '#/components/schemas/getAnalyticsDataPartnersViewedCollection'
        request_sent:
          $ref: '#/components/schemas/getAnalyticsDataPartnerRequestSent'
        successful_requests_200OK:
          $ref: '#/components/schemas/getAnalyticsDataPartnerRequestSent200OK'
      title: getAnalyticsDataPartnerEngagmentFunnel
    GetAnalyticsDataData:
      oneOf:
        - $ref: '#/components/schemas/getAnalyticsDataSummary'
        - $ref: '#/components/schemas/getAnalyticsDataPartnerEngagmentFunnel'
      title: GetAnalyticsDataData
    getAnalyticsData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetAnalyticsDataData'
      required:
        - data
      title: getAnalyticsData
    CommonErrorTypeTitleDetailStatusType:
      oneOf:
        - type: string
          format: uri-reference
        - type: string
      title: CommonErrorTypeTitleDetailStatusType
    commonErrorTypeTitleDetailStatus:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailStatusType'
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        status:
          type: integer
          description: The error's HTTP status code.
      title: commonErrorTypeTitleDetailStatus
    commonErrorTypeTitleDetailStatusInstance:
      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.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: An explanation about the problem.
        status:
          type: integer
          description: The HTTP status code generated by the origin server.
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
      title: commonErrorTypeTitleDetailStatusInstance
    CommonErrorTypeTitleDetailDetail:
      oneOf:
        - type: string
        - type: object
          additionalProperties:
            description: Any type
      description: Information about the error.
      title: CommonErrorTypeTitleDetailDetail
    commonErrorTypeTitleDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          $ref: '#/components/schemas/CommonErrorTypeTitleDetailDetail'
          description: Information about the error.
      title: commonErrorTypeTitleDetail
    CommonErrorNameMessageError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: CommonErrorNameMessageError
    commonErrorNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageError'
          description: Information about the error.
      title: commonErrorNameMessage
    GetAnalyticsDataRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAnalyticsDataRequestInternalServerError
    analyticsMetadataInclude:
      type: string
      title: analyticsMetadataInclude
    analyticsMetadataResources:
      type: string
      title: analyticsMetadataResources
    getAnalyticsMetadataResourceMetricsData:
      type: object
      properties:
        metric:
          type: string
          description: The metric's name.
        description:
          type: string
          description: A description of the metric.
      description: Information about the resource's metric.
      title: getAnalyticsMetadataResourceMetricsData
    getAnalyticsMetadataResourceData:
      type: object
      properties:
        resource:
          type: string
          description: The name of the resource.
        description:
          type: string
          description: A description of the resource.
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsData'
          description: A list of the resource's accepted metrics values.
      description: Information about the resource.
      title: getAnalyticsMetadataResourceData
    getAnalyticsMetadataResourceMetricsDataDetailedParametersView:
      type: object
      properties:
        type:
          type: string
          description: The parameter's type.
        isRequired:
          type: boolean
          description: If true, the parameter is required.
        allowed_values:
          type: array
          items:
            type: string
          description: A list of the parameter's accepted values.
        description:
          type: string
          description: The parameter's description.
      description: Information about the `view` parameter.
      title: getAnalyticsMetadataResourceMetricsDataDetailedParametersView
    getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData:
      type: object
      properties:
        type:
          type: string
          description: The parameter's type.
        isRequired:
          type: boolean
          description: If true, the parameter is required.
        allowed_values:
          type: array
          items:
            type: string
          description: A list of the parameter's accepted values.
      description: Information about the filter.
      title: getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData
    GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1:
      type: object
      properties:
        workspace_type:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData'
        duration:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFiltersData'
      description: Information about the filter parameters.
      title: GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1
    getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters:
      oneOf:
        - type: array
          items:
            type: string
        - $ref: '#/components/schemas/GetAnalyticsMetadataResourceMetricsDataDetailedParametersFilters1'
      title: getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters
    getAnalticsMetadataPaginationData:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, pagination is supported for this metric.
        allowed_values:
          type: array
          items:
            type: string
          description: A list of the supported pagination parameters.
      description: Information about the metric's pagination parameters.
      title: getAnalticsMetadataPaginationData
    getAnalyticsMetadataResourceMetricsDataDetailedParameters:
      type: object
      properties:
        view:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersView'
        filters:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParametersFilters'
        pagination:
          $ref: '#/components/schemas/getAnalticsMetadataPaginationData'
      description: Information about the metric's parameters.
      title: getAnalyticsMetadataResourceMetricsDataDetailedParameters
    GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      description: The response schema for the `detailed` view.
      title: GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema
    getAnalyticsMetadataResourceMetricsDataDetailedData:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/GetAnalyticsMetadataResourceMetricsDataDetailedDataSchema'
          description: The response schema for the `detailed` view.
      description: Information about the metric's `detailed` parameter.
      title: getAnalyticsMetadataResourceMetricsDataDetailedData
    GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema:
      type: object
      properties:
        columns:
          $ref: '#/components/schemas/getAnalyticsDataColumnsData'
      description: The response schema for the `summary` view.
      title: GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema
    getAnalyticsMetadataResourceMetricsDataSummaryData:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/GetAnalyticsMetadataResourceMetricsDataSummaryDataSchema'
          description: The response schema for the `summary` view.
      description: Information about the metric's `summary` parameter.
      title: getAnalyticsMetadataResourceMetricsDataSummaryData
    getAnalyticsMetadataResourceMetricsDataDetailedResponse:
      type: object
      properties:
        detailed:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedData'
        summary:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataSummaryData'
      description: Information about the metric's `response` parameters.
      title: getAnalyticsMetadataResourceMetricsDataDetailedResponse
    getAnalyticsMetadataResourceMetricsDataDetailed:
      type: object
      properties:
        metric:
          type: string
          description: The metric's name.
        description:
          type: string
          description: A description of the metric.
        type:
          type: string
          description: The metric's data type.
        isRequired:
          type: boolean
          description: If true, the metric is required.
        parameters:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedParameters'
        response:
          $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailedResponse'
      description: Information about the resource's metric.
      title: getAnalyticsMetadataResourceMetricsDataDetailed
    getAnalyticsMetadataParametersResponseData:
      type: object
      properties:
        resource:
          type: string
          description: The name of the resource.
        description:
          type: string
          description: A description of the resource.
        type:
          type: string
          description: The metric's data type.
        isRequired:
          type: boolean
          description: If true, the metric is required.
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/getAnalyticsMetadataResourceMetricsDataDetailed'
          description: A list of the resource's detailed accepted metrics values.
      description: Detailed information about the resource including its metrics, parameters, and response schema.
      title: getAnalyticsMetadataParametersResponseData
    GetAnalyticsMetadataDataResourcesItems:
      oneOf:
        - $ref: '#/components/schemas/getAnalyticsMetadataResourceData'
        - $ref: '#/components/schemas/getAnalyticsMetadataParametersResponseData'
      title: GetAnalyticsMetadataDataResourcesItems
    GetAnalyticsMetadataData:
      type: object
      properties:
        description:
          type: string
          description: A description of the endpoint.
        resources:
          type: array
          items:
            $ref: '#/components/schemas/GetAnalyticsMetadataDataResourcesItems'
          description: A list of accepted resource values.
      description: The Analytics API's metadata information.
      title: GetAnalyticsMetadataData
    getAnalyticsMetadata:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetAnalyticsMetadataData'
          description: The Analytics API's metadata information.
      title: getAnalyticsMetadata
    GetAnalyticsMetadataRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAnalyticsMetadataRequestInternalServerError
    workspaceId:
      type: string
      title: workspaceId
    createdBy:
      type: integer
      title: createdBy
    cursor:
      type: string
      title: cursor
    apiDescription:
      type: string
      title: apiDescription
    limit:
      type: integer
      default: 10
      title: limit
    v10Accept:
      type: string
      enum:
        - application/vnd.api.v10+json
      title: v10Accept
    GetApisApisItems:
      type: object
      properties:
        id:
          type: string
          description: The API's ID.
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's short summary.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the API was created.
        createdBy:
          type: integer
          description: The Postman ID of the user that created the API.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the API was updated.
        updatedBy:
          type: integer
          description: The Postman ID of the user that updated the API.
        description:
          type: string
          description: The API's description.
      description: The API's base data schema.
      title: GetApisApisItems
    GetApisMeta:
      type: object
      properties:
        limit:
          type: integer
          description: The maximum number of records in the paginated response.
        total:
          type: integer
          description: The number of records that match the defined criteria.
        nextCursor:
          type: string
          format: base64
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: GetApisMeta
    getApis:
      type: object
      properties:
        apis:
          type: array
          items:
            $ref: '#/components/schemas/GetApisApisItems'
        meta:
          $ref: '#/components/schemas/GetApisMeta'
          description: The response's meta information for paginated results.
      description: Information about the API schema.
      title: getApis
    GetApisRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApisRequestUnauthorizedError
    GetApisRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApisRequestForbiddenError
    CommonErrorErrorObjTypeTitleDetailError:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Details about the error.
      description: Information about the error.
      title: CommonErrorErrorObjTypeTitleDetailError
    commonErrorErrorObjTypeTitleDetail:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorErrorObjTypeTitleDetailError'
          description: Information about the error.
      title: commonErrorErrorObjTypeTitleDetail
    GetApisRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApisRequestNotFoundError
    GetApisRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApisRequestInternalServerError
    createUpdateApi:
      type: object
      properties:
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's short summary.
        description:
          type: string
          description: The API's description. This supports Markdown formatting.
      required:
        - name
      description: Information about the API.
      title: createUpdateApi
    createApiResponse:
      type: object
      properties:
        id:
          type: string
          description: The API's ID.
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's short summary.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the API was created.
        createdBy:
          type: integer
          description: The Postman ID of the user that created the API.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the API was updated.
        updatedBy:
          type: integer
          description: The Postman ID of the user that updated the API.
        description:
          type: string
          description: The API's description.
      title: createApiResponse
    commonErrorTypeTitleMessageDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        message:
          type: string
          description: The error message.
        detail:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the error.
      title: commonErrorTypeTitleMessageDetail
    CreateApiRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: CreateApiRequestForbiddenError
    CreateApiRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateApiRequestInternalServerError
    apiId:
      type: string
      title: apiId
    ApiIncludeItems:
      type: string
      enum:
        - collections
        - versions
        - schemas
        - gitInfo
      title: ApiIncludeItems
    apiInclude:
      type: array
      items:
        $ref: '#/components/schemas/ApiIncludeItems'
      title: apiInclude
    GetApi0:
      type: object
      properties:
        id:
          type: string
          description: The API's ID.
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's short summary.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the API was created.
        createdBy:
          type: integer
          format: int64
          description: The Postman ID of the user that created the API.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the API was updated.
        updatedBy:
          type: integer
          format: int64
          description: The Postman ID of the user that updated the API.
        description:
          type: string
          description: The API's description.
      title: GetApi0
    GetApiOneOf1GitInfo:
      type: object
      properties:
        domain:
          type:
            - string
            - 'null'
          description: The domain at which the Git repository is hosted.
        repository:
          type: string
          description: The repository's name.
        organization:
          type: string
          description: The organization that owns the repository.
        schemaFolder:
          type: string
          description: The API definition's repository folder location.
        collectionFolder:
          type: string
          description: The API definition's collection repository folder location.
      description: Information about the API's Git repository integration.
      title: GetApiOneOf1GitInfo
    GetApiOneOf1SchemasItems:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
      description: Information about the schema.
      title: GetApiOneOf1SchemasItems
    GetApiOneOf1VersionsItems:
      type: object
      properties:
        id:
          type: string
          description: The version's ID.
        name:
          type: string
          description: The version's name.
      description: Information about the version.
      title: GetApiOneOf1VersionsItems
    GetApiOneOf1CollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
      description: Information about the collection.
      title: GetApiOneOf1CollectionsItems
    GetApi1:
      type: object
      properties:
        id:
          type: string
          description: The API's ID.
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's short summary.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the API was created.
        createdBy:
          type: integer
          format: int64
          description: The Postman ID of the user that created the API.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the API was updated.
        updatedBy:
          type: integer
          format: int64
          description: The Postman ID of the user that updated the API.
        description:
          type: string
          description: The API's description.
        gitInfo:
          $ref: '#/components/schemas/GetApiOneOf1GitInfo'
          description: Information about the API's Git repository integration.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/GetApiOneOf1SchemasItems'
          description: The API's schemas.
        versions:
          type: array
          items:
            $ref: '#/components/schemas/GetApiOneOf1VersionsItems'
          description: The API's versions.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/GetApiOneOf1CollectionsItems'
          description: The API's collections.
      description: >
        The API's extended data schema.


        **Note:**


        Git-connected APIs will only return the `versions` and `gitInfo` query responses. This is because schema and
        collection information is stored in the connected Git repository. The `gitInfo` object only lists the repository
        and folder locations of the files.
      title: GetApi1
    getApi:
      oneOf:
        - $ref: '#/components/schemas/GetApi0'
        - $ref: '#/components/schemas/GetApi1'
      title: getApi
    apiErrorNameMessage:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: apiErrorNameMessage
    GetApiRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiRequestForbiddenError
    GetApiRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiRequestNotFoundError
    GetApiRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiRequestInternalServerError
    updateApiResponse:
      type: object
      properties:
        id:
          type: string
          description: The API's ID.
        name:
          type: string
          description: The API's name.
        summary:
          type: string
          description: The API's summary.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the API was created.
        createdBy:
          type: string
          description: The user ID of the user that created the API.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the API was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that updated the API.
        description:
          type: string
          description: The API's description. This supports Markdown formatting.
      required:
        - name
      title: updateApiResponse
    UpdateApiRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: UpdateApiRequestForbiddenError
    UpdateApiRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: UpdateApiRequestNotFoundError
    UpdateApiRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateApiRequestInternalServerError
    DeleteApiRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: DeleteApiRequestForbiddenError
    DeleteApiRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: DeleteApiRequestNotFoundError
    DeleteApiRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteApiRequestInternalServerError
    CopyCollectionToApiData:
      type: object
      properties:
        collectionId:
          type: string
          description: The collection ID to copy to the API.
      title: CopyCollectionToApiData
    CopyCollectionToApiOperationType:
      type: string
      enum:
        - COPY_COLLECTION
      description: The `COPY_COLLECTION` method.
      title: CopyCollectionToApiOperationType
    copyCollectionToApi:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CopyCollectionToApiData'
        operationType:
          $ref: '#/components/schemas/CopyCollectionToApiOperationType'
          description: The `COPY_COLLECTION` method.
      title: copyCollectionToApi
    CreateApiCollectionDataInfoSchema:
      type: string
      enum:
        - https://schema.postman.com/json/collection/v2.1.0/collection.json
      description: The collection's schema format.
      title: CreateApiCollectionDataInfoSchema
    CreateApiCollectionDataInfo:
      type: object
      properties:
        name:
          type: string
          description: The collection's name.
        schema:
          $ref: '#/components/schemas/CreateApiCollectionDataInfoSchema'
          description: The collection's schema format.
      description: Information about the collection.
      title: CreateApiCollectionDataInfo
    CreateApiCollectionData:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/CreateApiCollectionDataInfo'
          description: Information about the collection.
        item:
          type: array
          items:
            description: Any type
          description: >-
            Information about the requests and responses in the collection. For a complete list of values, refer to the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      description: >-
        Information about the collection's contents, such as requests and responses. For a complete list of values,
        refer to the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: CreateApiCollectionData
    CreateApiCollectionOperationType:
      type: string
      enum:
        - CREATE_NEW
      description: The `CREATE_NEW` method.
      title: CreateApiCollectionOperationType
    createApiCollection:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateApiCollectionData'
          description: >-
            Information about the collection's contents, such as requests and responses. For a complete list of values,
            refer to the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        operationType:
          $ref: '#/components/schemas/CreateApiCollectionOperationType'
          description: The `CREATE_NEW` method.
      title: createApiCollection
    GenerateApiFromSchemaOperationType:
      type: string
      enum:
        - GENERATE_FROM_SCHEMA
      description: The `GENERATE_FROM_SCHEMA` method.
      title: GenerateApiFromSchemaOperationType
    generateApiFromSchema:
      type: object
      properties:
        name:
          type: string
          description: The collection's name.
        operationType:
          $ref: '#/components/schemas/GenerateApiFromSchemaOperationType'
          description: The `GENERATE_FROM_SCHEMA` method.
        options:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            The advanced creation options for collections and their values. For a complete list of properties and their
            values, see Postman's [OpenAPI to Postman Collection Converter OPTIONS
            documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md). These properties
            are case-sensitive.
      title: generateApiFromSchema
    API_addApiCollection_Request:
      oneOf:
        - $ref: '#/components/schemas/copyCollectionToApi'
        - $ref: '#/components/schemas/createApiCollection'
        - $ref: '#/components/schemas/generateApiFromSchema'
      title: API_addApiCollection_Request
    addApiCollectionResponse:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
      title: addApiCollectionResponse
    AddApiCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: AddApiCollectionRequestForbiddenError
    AddApiCollectionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: AddApiCollectionRequestNotFoundError
    AddApiCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AddApiCollectionRequestInternalServerError
    collectionIdApi:
      type: string
      format: uid
      title: collectionIdApi
    apiVersionId:
      type: string
      title: apiVersionId
    GetApiCollectionInfo:
      type: object
      properties:
        name:
          type: string
          description: The collection's name.
        schema:
          type: string
          format: url
          description: A URL to the collection's schema.
        _postman_id:
          type: string
          description: The collection's Postman ID.
        description:
          type: string
          description: The collection's description.
      description: Information about the collection.
      title: GetApiCollectionInfo
    getApiCollection:
      type: object
      properties:
        item:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: A list of the collection's contents.
        info:
          $ref: '#/components/schemas/GetApiCollectionInfo'
          description: Information about the collection.
        auth:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            The collection's auth information. For a complete list of values, refer to the **Auth** entry in the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        variable:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: A list of the collection's variables.
      title: getApiCollection
    GetApiCollectionRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCollectionRequestBadRequestError
    GetApiCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: GetApiCollectionRequestForbiddenError
    GetApiCollectionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiCollectionRequestNotFoundError
    GetApiCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCollectionRequestInternalServerError
    CommentDataStatus:
      type: string
      enum:
        - Open
        - Resolved
      description: The comment's current status.
      title: CommentDataStatus
    commentData:
      type: object
      properties:
        id:
          type: integer
          description: The comment's ID.
        threadId:
          type: integer
          description: The comment's thread ID.
        status:
          $ref: '#/components/schemas/CommentDataStatus'
          description: The comment's current status.
        createdBy:
          type: integer
          description: The user ID of the user who created the comment.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the comment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time when the comment was last updated.
        body:
          type: string
          description: The contents of the comment.
      description: Information about the comment.
      title: commentData
    commentResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/commentData'
          description: A list of comments.
      title: commentResponse
    CommentTaggedUsersUserNameType:
      type: string
      enum:
        - user
      description: The `user` value.
      title: CommentTaggedUsersUserNameType
    CommentTaggedUsersUserName:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CommentTaggedUsersUserNameType'
          description: The `user` value.
        id:
          type: string
          description: The user's ID.
      required:
        - type
        - id
      description: >-
        An object that contains information about the tagged user. The object's name is the user's Postman username. For
        example, `@user-postman`.
      title: CommentTaggedUsersUserName
    commentTaggedUsers:
      type: object
      properties:
        '{{userName}}':
          $ref: '#/components/schemas/CommentTaggedUsersUserName'
          description: >-
            An object that contains information about the tagged user. The object's name is the user's Postman username.
            For example, `@user-postman`.
      description: Information about users tagged in the `body` comment.
      title: commentTaggedUsers
    commentCreate:
      type: object
      properties:
        body:
          type: string
          description: The contents of the comment.
        threadId:
          type: integer
          description: The comment's thread ID. To create a reply on an existing comment, include this property.
        tags:
          $ref: '#/components/schemas/commentTaggedUsers'
      required:
        - body
      description: Information about the comment.
      title: commentCreate
    CommentCreatedUpdatedData:
      type: object
      properties:
        id:
          type: integer
          description: The comment's ID.
        threadId:
          type: integer
          description: The comment's thread ID.
        createdBy:
          type: integer
          description: The user ID of the user who created the comment.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the comment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time when the comment was last updated.
        body:
          type: string
          description: The contents of the comment.
      title: CommentCreatedUpdatedData
    commentCreatedUpdated:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CommentCreatedUpdatedData'
      title: commentCreatedUpdated
    commentId:
      type: integer
      title: commentId
    commentUpdate:
      type: object
      properties:
        body:
          type: string
          description: The contents of the comment.
        tags:
          $ref: '#/components/schemas/commentTaggedUsers'
      required:
        - body
      description: Information about the comment.
      title: commentUpdate
    syncCollectionWithSchemaResponse:
      type: object
      properties:
        taskId:
          type: string
          description: >-
            The created task ID. You can use this ID to track the status of syncing an API collection with an API
            schema.
      title: syncCollectionWithSchemaResponse
    SyncCollectionWithSchemaRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SyncCollectionWithSchemaRequestBadRequestError
    SyncCollectionWithSchemaRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: SyncCollectionWithSchemaRequestForbiddenError
    SyncCollectionWithSchemaRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: SyncCollectionWithSchemaRequestNotFoundError
    SyncCollectionWithSchemaRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SyncCollectionWithSchemaRequestInternalServerError
    CreateApiSchemaType:
      type: string
      enum:
        - proto:2
        - proto:3
        - graphql
        - openapi:3_1
        - openapi:3
        - openapi:2
        - openapi:1
        - raml:1
        - raml:0_8
        - wsdl:2
        - wsdl:1
        - asyncapi:2
      description: The schema's type.
      title: CreateApiSchemaType
    CreateApiSchemaFilesItemsRoot:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
          description: If true, tag the file as the root file. You can only update the root tag for protobuf specifications.
      description: Information about the schema's root file.
      title: CreateApiSchemaFilesItemsRoot
    CreateApiSchemaFilesItems:
      type: object
      properties:
        path:
          type: string
          description: The schema's file path.
        root:
          $ref: '#/components/schemas/CreateApiSchemaFilesItemsRoot'
          description: Information about the schema's root file.
        content:
          type: string
          description: The schema file's stringified contents.
      title: CreateApiSchemaFilesItems
    createApiSchema:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CreateApiSchemaType'
          description: The schema's type.
        files:
          type: array
          items:
            $ref: '#/components/schemas/CreateApiSchemaFilesItems'
          description: The list of files that are part of the schema.
      required:
        - type
        - files
      description: Information about the API schema.
      title: createApiSchema
    CreateApiSchemaResponseType:
      type: string
      enum:
        - proto:2
        - proto:3
        - graphql
        - openapi:3_1
        - openapi:3
        - openapi:2
        - openapi:1
        - raml:1
        - raml:0_8
        - wsdl:2
        - wsdl:1
        - asyncapi:2
      description: The schema's type.
      title: CreateApiSchemaResponseType
    CreateApiSchemaResponseFilesItemsRoot:
      type: object
      properties:
        enabled:
          type: boolean
          description: >-
            If true, the file is tagged as the schema's root file. The root tag is only allowed for protobuf
            specifications.
      description: An object that contains root file information.
      title: CreateApiSchemaResponseFilesItemsRoot
    CreateApiSchemaResponseFilesItems:
      type: object
      properties:
        id:
          type: string
          description: The schema file's ID.
        name:
          type: string
          description: The schema file's name.
        path:
          type: string
          description: The file system path to the schema file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        root:
          $ref: '#/components/schemas/CreateApiSchemaResponseFilesItemsRoot'
          description: An object that contains root file information.
        createdBy:
          type: string
          description: The user ID of the user that created the file.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the file.
      description: Information about the schema file.
      title: CreateApiSchemaResponseFilesItems
    createApiSchemaResponse:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
        type:
          $ref: '#/components/schemas/CreateApiSchemaResponseType'
          description: The schema's type.
        files:
          type: array
          items:
            $ref: '#/components/schemas/CreateApiSchemaResponseFilesItems'
          description: A list of the schema's files.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the schema was created.
        createdBy:
          type: string
          description: The user ID of the user that created the schema.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the schema was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that updated the schema.
      description: Information about the API schema.
      title: createApiSchemaResponse
    CreateApiSchemaRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateApiSchemaRequestBadRequestError
    CreateApiSchemaRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: CreateApiSchemaRequestForbiddenError
    CreateApiSchemaRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: CreateApiSchemaRequestNotFoundError
    CreateApiSchemaRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateApiSchemaRequestInternalServerError
    apiSchemaId:
      type: string
      title: apiSchemaId
    apiSchemaOutput:
      type: boolean
      default: false
      title: apiSchemaOutput
    GetApiSchemaOneOf0FilesDataItems:
      type: object
      properties:
        id:
          type: string
          description: The schema file's ID.
        name:
          type: string
          description: The schema file's name.
        path:
          type: string
          description: The file system path to the schema file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        createdBy:
          type: string
          description: The user ID of the user that created the file.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the file.
      description: Information about the schema file.
      title: GetApiSchemaOneOf0FilesDataItems
    GetApiSchemaOneOf0FilesMeta:
      type: object
      properties:
        nextPath:
          type: string
          description: The URL path to the next file.
      description: The response's non-standard meta information.
      title: GetApiSchemaOneOf0FilesMeta
    GetApiSchemaOneOf0Files:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetApiSchemaOneOf0FilesDataItems'
          description: A list of the schema files.
        meta:
          $ref: '#/components/schemas/GetApiSchemaOneOf0FilesMeta'
          description: The response's non-standard meta information.
      description: Information about the schema's files. The response is paginated and limited to one page.
      title: GetApiSchemaOneOf0Files
    GetApiSchema0:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
        type:
          type: string
          description: The schema's type.
        files:
          $ref: '#/components/schemas/GetApiSchemaOneOf0Files'
          description: Information about the schema's files. The response is paginated and limited to one page.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the schema was created.
        createdBy:
          type: string
          description: The user ID of the user that created the schema.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the schema was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the schema.
      description: Information about the schema.
      title: GetApiSchema0
    GetApiSchema1:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
        type:
          type: string
          description: The schema's type.
        createdBy:
          type: string
          description: The user ID of the user that created the schema.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the schema.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the schema was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the schema was last updated.
        content:
          type: string
          description: The schema file, in a bundled format.
      description: Information about the schema.
      title: GetApiSchema1
    getApiSchema:
      oneOf:
        - $ref: '#/components/schemas/GetApiSchema0'
        - $ref: '#/components/schemas/GetApiSchema1'
      title: getApiSchema
    GetApiSchemaRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaRequestBadRequestError
    GetApiSchemaRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: GetApiSchemaRequestForbiddenError
    GetApiSchemaRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiSchemaRequestNotFoundError
    GetApiSchemaRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaRequestInternalServerError
    GetApiSchemaFilesMeta:
      type: object
      properties:
        nextCursor:
          type: string
          description: The pointer to the next record in the set of paginated results.
      description: The schema's non-standard meta information.
      title: GetApiSchemaFilesMeta
    GetApiSchemaFilesFilesItems:
      type: object
      properties:
        id:
          type: string
          description: The schema file's ID.
        name:
          type: string
          description: The schema file's name.
        path:
          type: string
          description: The file system path to the schema file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        createdBy:
          type: integer
          format: int64
          description: The user ID of the user that created the file.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
        updatedBy:
          type: integer
          description: The user ID of the user that last updated the file.
      description: Information about the schema file.
      title: GetApiSchemaFilesFilesItems
    getApiSchemaFiles:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiSchemaFilesMeta'
          description: The schema's non-standard meta information.
        files:
          type: array
          items:
            $ref: '#/components/schemas/GetApiSchemaFilesFilesItems'
          description: A list of the schema's files.
      title: getApiSchemaFiles
    GetApiSchemaFilesRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFilesRequestBadRequestError
    GetApiSchemaFilesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFilesRequestForbiddenError
    GetApiSchemaFilesRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiSchemaFilesRequestNotFoundError
    GetApiSchemaFilesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFilesRequestInternalServerError
    file-path:
      type: string
      title: file-path
    getApiSchemaFileContents:
      type: object
      properties:
        id:
          type: string
          description: The schema file's ID.
        name:
          type: string
          description: The schema file's name.
        path:
          type: string
          description: The file system path to the schema file.
        content:
          type: string
          description: The schema file's stringified contents.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        createdBy:
          type: string
          description: The user Id of the user that created the file.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the file.
      title: getApiSchemaFileContents
    GetApiSchemaFileContentsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFileContentsRequestBadRequestError
    GetApiSchemaFileContentsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFileContentsRequestForbiddenError
    GetApiSchemaFileContentsRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiSchemaFileContentsRequestNotFoundError
    GetApiSchemaFileContentsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiSchemaFileContentsRequestInternalServerError
    CreateUpdateApiSchemaFileRoot:
      type: object
      properties:
        enabled:
          type: boolean
          description: If true, tag the file as the root file. You can only update the root tag for protobuf specifications.
      description: Information about the schema's root file.
      title: CreateUpdateApiSchemaFileRoot
    createUpdateApiSchemaFile:
      type: object
      properties:
        name:
          type: string
          description: The schema file's name.
        root:
          $ref: '#/components/schemas/CreateUpdateApiSchemaFileRoot'
          description: Information about the schema's root file.
        content:
          type: string
          description: The schema file's stringified contents.
      description: Information about schema file.
      title: createUpdateApiSchemaFile
    CreateUpdateApiSchemaFileResponseRoot:
      type: object
      properties:
        enabled:
          type: boolean
          description: If true, the file is the schema's the root file.
      description: Information about the schema's root file.
      title: CreateUpdateApiSchemaFileResponseRoot
    createUpdateApiSchemaFileResponse:
      type: object
      properties:
        createdBy:
          type: string
          description: The user ID of the user that created the file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        root:
          $ref: '#/components/schemas/CreateUpdateApiSchemaFileResponseRoot'
          description: Information about the schema's root file.
        name:
          type: string
          description: The schema file's name.
        path:
          type: string
          description: The file system path to the schema file.
        updatedBy:
          type: string
          description: The user ID of the user that last updated the file.
        id:
          type: string
          description: The schema file's ID.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
      description: Information about the schema file.
      title: createUpdateApiSchemaFileResponse
    CreateUpdateApiSchemaFileRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateUpdateApiSchemaFileRequestBadRequestError
    CreateUpdateApiSchemaFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: CreateUpdateApiSchemaFileRequestForbiddenError
    CreateUpdateApiSchemaFileRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: CreateUpdateApiSchemaFileRequestNotFoundError
    CreateUpdateApiSchemaFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateUpdateApiSchemaFileRequestInternalServerError
    DeleteApiSchemaFileRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteApiSchemaFileRequestBadRequestError
    DeleteApiSchemaFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: DeleteApiSchemaFileRequestForbiddenError
    DeleteApiSchemaFileRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: DeleteApiSchemaFileRequestNotFoundError
    DeleteApiSchemaFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteApiSchemaFileRequestInternalServerError
    apiTaskId:
      type: string
      title: apiTaskId
    GetStatusOfAnAsyncApiTaskMetaModel:
      type: string
      enum:
        - collection
        - api-version
      description: The model for which the task is performing the operation.
      title: GetStatusOfAnAsyncApiTaskMetaModel
    GetStatusOfAnAsyncApiTaskMetaAction:
      type: string
      enum:
        - update
        - create
      description: The task's action.
      title: GetStatusOfAnAsyncApiTaskMetaAction
    GetStatusOfAnAsyncApiTaskMeta:
      type: object
      properties:
        url:
          type: string
          format: url
          description: The endpoint URL that created the task.
        model:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskMetaModel'
          description: The model for which the task is performing the operation.
        action:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskMetaAction'
          description: The task's action.
      description: The response's non-standard meta information.
      title: GetStatusOfAnAsyncApiTaskMeta
    GetStatusOfAnAsyncApiTaskStatus:
      type: string
      enum:
        - pending
        - failed
        - completed
      description: The task's current status.
      title: GetStatusOfAnAsyncApiTaskStatus
    GetStatusOfAnAsyncApiTaskDetailsOneOf0ResourcesItems:
      type: object
      properties:
        id:
          type: string
          description: The ID of the assigned resource.
        url:
          type: string
          description: The task's assigned resource URL.
      title: GetStatusOfAnAsyncApiTaskDetailsOneOf0ResourcesItems
    GetStatusOfAnAsyncApiTaskDetails0:
      type: object
      properties:
        resources:
          type: array
          items:
            $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskDetailsOneOf0ResourcesItems'
      description: Information about the task's resources.
      title: GetStatusOfAnAsyncApiTaskDetails0
    GetStatusOfAnAsyncApiTaskDetailsOneOf1Error:
      type: object
      properties:
        message:
          type: string
          description: The task's error message.
      title: GetStatusOfAnAsyncApiTaskDetailsOneOf1Error
    GetStatusOfAnAsyncApiTaskDetails1:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskDetailsOneOf1Error'
      description: Information about the error that occurred during the task's processing.
      title: GetStatusOfAnAsyncApiTaskDetails1
    GetStatusOfAnAsyncApiTaskDetails:
      oneOf:
        - $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskDetails0'
        - $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskDetails1'
      title: GetStatusOfAnAsyncApiTaskDetails
    getStatusOfAnAsyncApiTask:
      type: object
      properties:
        id:
          type: string
          description: The task's ID.
        meta:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskMeta'
          description: The response's non-standard meta information.
        status:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskStatus'
          description: The task's current status.
        details:
          $ref: '#/components/schemas/GetStatusOfAnAsyncApiTaskDetails'
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the task was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the task was last updated.
      title: getStatusOfAnAsyncApiTask
    GetStatusOfAnAsyncApiTaskRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetStatusOfAnAsyncApiTaskRequestBadRequestError
    GetStatusOfAnAsyncApiTaskRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: GetStatusOfAnAsyncApiTaskRequestForbiddenError
    GetStatusOfAnAsyncApiTaskRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetStatusOfAnAsyncApiTaskRequestInternalServerError
    GetApiVersionsMeta:
      type: object
      properties:
        limit:
          type: integer
          description: The maximum number of records in the paginated response.
        total:
          type: integer
          description: The number of records that match the defined criteria.
        nextCursor:
          type: string
          format: base64
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: GetApiVersionsMeta
    GetApiVersionsVersionsItems:
      type: object
      properties:
        id:
          type: string
          description: The version's ID.
        name:
          type: string
          description: The version's name.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the version was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the version was last updated.
        releaseNotes:
          type: string
          description: The version's release notes.
      description: Information about the API version.
      title: GetApiVersionsVersionsItems
    getApiVersions:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiVersionsMeta'
          description: The response's meta information for paginated results.
        versions:
          type: array
          items:
            $ref: '#/components/schemas/GetApiVersionsVersionsItems'
          description: A list of the API's versions.
      title: getApiVersions
    GetApiVersionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiVersionsRequestForbiddenError
    GetApiVersionsRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiVersionsRequestNotFoundError
    GetApiVersionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiVersionsRequestInternalServerError
    CreateGitUnlinkedVersionSchemaSchemasItems:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
      description: Information about the schema.
      title: CreateGitUnlinkedVersionSchemaSchemasItems
    CreateGitUnlinkedVersionSchemaCollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
      description: Information about the collection.
      title: CreateGitUnlinkedVersionSchemaCollectionsItems
    createGitUnlinkedVersionSchema:
      type: object
      properties:
        name:
          type: string
          description: The version's name.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitUnlinkedVersionSchemaSchemasItems'
          description: A list of the version's schemas.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitUnlinkedVersionSchemaCollectionsItems'
          description: A list of the version's collections.
        releaseNotes:
          type: string
          description: Information about the API version release. For example, changelog notes.
      required:
        - name
        - schemas
        - collections
      description: Information about the API version.
      title: createGitUnlinkedVersionSchema
    CreateGitLinkedVersionSchemasItems:
      type: object
      properties:
        directoryPath:
          type: string
          description: The path to the root directory where schemas are stored in the Git repository.
      description: Information about the schema.
      title: CreateGitLinkedVersionSchemasItems
    CreateGitLinkedVersionCollectionsItems:
      type: object
      properties:
        filePath:
          type: string
          description: The path to the collection in the Git repository.
      description: Information about the collection.
      title: CreateGitLinkedVersionCollectionsItems
    createGitLinkedVersion:
      type: object
      properties:
        name:
          type: string
          description: The version's name.
        branch:
          type: string
          description: The branch ID.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitLinkedVersionSchemasItems'
          description: A list of the version's schemas.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitLinkedVersionCollectionsItems'
          description: A list of the version's collections.
        releaseNotes:
          type: string
          description: Information about the API version release. For example, changelog notes.
      required:
        - name
        - branch
        - schemas
        - collections
      description: Information about the API version.
      title: createGitLinkedVersion
    CreateGitLinkedVersionRootFileSchemasItems:
      type: object
      properties:
        filePath:
          type: string
          description: The path to the schema root file in the Git repository.
      description: Information about the schema.
      title: CreateGitLinkedVersionRootFileSchemasItems
    CreateGitLinkedVersionRootFileCollectionsItems:
      type: object
      properties:
        filePath:
          type: string
          description: Path to a collection in the Git repository.
      description: Information about the collection.
      title: CreateGitLinkedVersionRootFileCollectionsItems
    createGitLinkedVersionRootFile:
      type: object
      properties:
        name:
          type: string
          description: The version's name.
        branch:
          type: string
          description: The branch ID.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitLinkedVersionRootFileSchemasItems'
          description: A list of the version's schemas.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/CreateGitLinkedVersionRootFileCollectionsItems'
          description: A list of the version's collections.
        releaseNotes:
          type: string
          description: Information about the API version release. For example, changelog notes.
      required:
        - name
        - branch
        - schemas
        - collections
      description: Information about the API version.
      title: createGitLinkedVersionRootFile
    API_createApiVersion_Request:
      oneOf:
        - $ref: '#/components/schemas/createGitUnlinkedVersionSchema'
        - $ref: '#/components/schemas/createGitLinkedVersion'
        - $ref: '#/components/schemas/createGitLinkedVersionRootFile'
      title: API_createApiVersion_Request
    createApiVersionResponse:
      type: object
      properties:
        id:
          type: string
          description: The version's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the version was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the version was last updated.
        name:
          type: string
          description: The version's name.
        releaseNotes:
          type: string
          description: Information about the API version release. For example, changelog notes.
      title: createApiVersionResponse
    CreateApiVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: CreateApiVersionRequestForbiddenError
    CreateApiVersionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: CreateApiVersionRequestNotFoundError
    CreateApiVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateApiVersionRequestInternalServerError
    GetApiVersionVersionSchemasItems:
      type: object
      properties:
        id:
          type: string
          description: The schema's ID.
        type:
          type: string
          description: The schema type.
      description: Information about the schema.
      title: GetApiVersionVersionSchemasItems
    GetApiVersionVersionCollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        type:
          type: string
          description: The collection's name.
      description: Information about the collection.
      title: GetApiVersionVersionCollectionsItems
    GetApiVersionVersion:
      type: object
      properties:
        id:
          type: string
          description: The version's ID.
        name:
          type: string
          description: The version's name.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the version was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the version was last updated.
        releaseNotes:
          type: string
          description: The version's release notes.
        schemas:
          type: array
          items:
            $ref: '#/components/schemas/GetApiVersionVersionSchemasItems'
          description: A list of the API's schemas.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/GetApiVersionVersionCollectionsItems'
          description: A list of the API's collections.
      description: Information about the API version.
      title: GetApiVersionVersion
    getApiVersion:
      type: object
      properties:
        version:
          $ref: '#/components/schemas/GetApiVersionVersion'
          description: Information about the API version.
      title: getApiVersion
    GetApiVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiVersionRequestForbiddenError
    GetApiVersionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: GetApiVersionRequestNotFoundError
    GetApiVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiVersionRequestInternalServerError
    updateApiVersion:
      type: object
      properties:
        name:
          type: string
          description: The version's name.
        releaseNotes:
          type: string
          description: The version's Markdown-supported release notes.
      required:
        - name
      description: Information about the API version.
      title: updateApiVersion
    updateApiVersionResponse:
      type: object
      properties:
        id:
          type: string
          description: The version's ID.
        name:
          type: string
          description: The version's name.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the version was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the version was last updated.
        releaseNotes:
          type: string
          description: The version's release notes.
      description: Information about the API version.
      title: updateApiVersionResponse
    UpdateApiVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: UpdateApiVersionRequestForbiddenError
    UpdateApiVersionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: UpdateApiVersionRequestNotFoundError
    UpdateApiVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateApiVersionRequestInternalServerError
    DeleteApiVersionRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/apiErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteApiVersionRequestBadRequestError
    DeleteApiVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: DeleteApiVersionRequestForbiddenError
    DeleteApiVersionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorErrorObjTypeTitleDetail'
      title: DeleteApiVersionRequestNotFoundError
    DeleteApiVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteApiVersionRequestInternalServerError
    discoveryServicesSource:
      type: string
      enum:
        - api_gateway_app
        - insights_project
        - infra_watcher
        - public_api
      title: discoveryServicesSource
    discoveryServicesStatus:
      type: string
      title: discoveryServicesStatus
    discoveryServicesSearch:
      type: string
      title: discoveryServicesSearch
    limitDefault20:
      type: integer
      minimum: 1
      maximum: 100
      default: 20
      title: limitDefault20
    getApiCatalogDiscoveryMetaData:
      type: object
      properties:
        total:
          type: integer
          description: The number of records found.
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: getApiCatalogDiscoveryMetaData
    apiCatalogDiscoveryServicesTagsData:
      type: array
      items:
        type: string
      description: A list of tags associated with the service.
      title: apiCatalogDiscoveryServicesTagsData
    getApiCatalogServiceData:
      type: object
      properties:
        id:
          type: string
          description: The service's ID.
        name:
          type: string
          description: The service's name.
        version:
          type:
            - string
            - 'null'
          description: The service's version.
        sourceEnvironment:
          type:
            - string
            - 'null'
          description: The source environment in which the service was discovered.
        systemEnvironmentId:
          type:
            - string
            - 'null'
          description: The mapped system environment's ID. Returns a null value if the environment is not mapped.
        status:
          type: string
          description: The service's current status.
        endpointsCount:
          type: integer
          description: The total number of endpoints associated with the service.
        discoverySource:
          type: string
          description: The source through which the service was discovered.
        tags:
          $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData'
        discoveredAt:
          type: string
          format: date-time
          description: The date and time at which the service was first discovered.
      description: Information about the discovered service.
      title: getApiCatalogServiceData
    getApiCatalogDiscoveryServices:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/getApiCatalogDiscoveryMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/getApiCatalogServiceData'
          description: A list of discovered services.
      title: getApiCatalogDiscoveryServices
    apiCatalogErrorPathMessage:
      type: object
      properties:
        path:
          type: string
          description: The path in which the error occurred.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: apiCatalogErrorPathMessage
    apiCatalogError:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
        status:
          type: integer
          description: The HTTP status code generated by the origin server.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: An explanation about the problem.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/apiCatalogErrorPathMessage'
          description: A list of errors.
      title: apiCatalogError
    GetApiCatalogDiscoveryServicesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogDiscoveryServicesRequestInternalServerError
    postApiCatalogDiscoveryServicesApiDefinitionData:
      type: object
      properties:
        content:
          type: string
          description: A Base64-encoded JSON API definition. Cannot exceed 2 MB after decoding.
      description: >-
        The API definition (specification) for the service. If you pass this with the `endpoints` array, this object is
        given preference and `endpoints` is ignored.
      title: postApiCatalogDiscoveryServicesApiDefinitionData
    apiCatalogDiscoveryServiceEndpointsData:
      type: object
      properties:
        method:
          type: string
          description: The endpoint's HTTP method.
        path:
          type: string
          description: The endpoint's URL path.
        description:
          type:
            - string
            - 'null'
          description: The endpoint's description.
        host:
          type: string
          description: The endpoint's host.
      description: Information about a service's endpoint.
      title: apiCatalogDiscoveryServiceEndpointsData
    postApiCatalogDiscoveryServicesProviderMetadataData:
      type: object
      properties:
        commitSha:
          type: string
          description: A commit hash ID.
        branch:
          type: string
          description: The source provider's branch name.
        gitRepoUrl:
          type: string
          description: The source provider's Git repo URL.
        deployedAt:
          type: string
          format: date-time
          description: The date and time at which the service was deployed.
      description: Additional metadata from the discovery source provider.
      title: postApiCatalogDiscoveryServicesProviderMetadataData
    postApiCatalogDiscoveryServiceData:
      type: object
      properties:
        name:
          type: string
          description: The service's name.
        version:
          type: string
          description: The service's version.
        providerServiceId:
          type: string
          description: >-
            The ID of the service in the source registry. If you do not pass this property, the system uses the
            `{name}:{version}` value.
        description:
          type: string
          description: The service's description.
        sourceEnvironment:
          type: string
          description: The service's source environment.
        apiDefinition:
          $ref: '#/components/schemas/postApiCatalogDiscoveryServicesApiDefinitionData'
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/apiCatalogDiscoveryServiceEndpointsData'
          description: A list of the service's endpoints. If you pass this with the `apiDefinition` array, this array is ignored.
        tags:
          $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData'
        providerMetadata:
          $ref: '#/components/schemas/postApiCatalogDiscoveryServicesProviderMetadataData'
      required:
        - name
      description: Information about the discovered service.
      title: postApiCatalogDiscoveryServiceData
    postApiCatalogDiscoveryServices:
      type: object
      properties:
        discoveredServices:
          type: array
          items:
            $ref: '#/components/schemas/postApiCatalogDiscoveryServiceData'
          description: A list of discovered services to add to the API Catalog.
      required:
        - discoveredServices
      title: postApiCatalogDiscoveryServices
    postApiCatalogDiscoveryServicesServiceData:
      type: object
      properties:
        id:
          type: string
          description: The service's ID.
        organizationId:
          type: integer
          description: The ID of the organization that the service belongs to.
        name:
          type: string
          description: The servie's name.
        description:
          type:
            - string
            - 'null'
          description: The service's description.
        version:
          type:
            - string
            - 'null'
          description: The service's version.
        sourceEnvironment:
          type:
            - string
            - 'null'
          description: The source environment in which the service was discovered.
        systemEnvironmentId:
          type:
            - string
            - 'null'
          description: The mapped system environment's ID. Returns a null value if the environment is not mapped.
        tags:
          $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData'
        status:
          type: string
          description: The service's current status.
        endpointsCount:
          type: integer
          description: The total number of endpoints associated with the service.
        providerServiceId:
          type: string
          description: The ID of the service in the source registry.
        discoveredAt:
          type: string
          format: date-time
          description: The date and time at which the service was first discovered.
        discoveredBy:
          type: integer
          description: The user ID of the user who discovered or ingested the service.
        lastSyncedAt:
          type: string
          format: date-time
          description: The date and time of the most recent service sync.
      description: Information about a discovered service.
      title: postApiCatalogDiscoveryServicesServiceData
    postApiCatalogDiscoveryServicesResponseMetaData:
      type: object
      properties:
        total:
          type: integer
          description: The total number of services processed.
        created:
          type: integer
          description: The number of new services created.
        updated:
          type: integer
          description: The number of existing services updated.
      description: The operation's metadata summary.
      title: postApiCatalogDiscoveryServicesResponseMetaData
    postApiCatalogDiscoveryServicesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/postApiCatalogDiscoveryServicesServiceData'
          description: A list of discovered services.
        meta:
          $ref: '#/components/schemas/postApiCatalogDiscoveryServicesResponseMetaData'
      title: postApiCatalogDiscoveryServicesResponse
    PostApiCatalogDiscoveryServicesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PostApiCatalogDiscoveryServicesRequestInternalServerError
    serviceId:
      type: string
      title: serviceId
    apiCatalogDiscoveryServicesProviderMetadata:
      type: object
      properties:
        title:
          type: string
          description: The provider's service display title.
        environmentId:
          type: string
          description: The provider's environment ID.
        environmentVersion:
          type: string
          description: The provider's environment version.
        openApiSpecCanBeDownloaded:
          type: boolean
          description: If true, the provider has enabled downloading of the OpenAPI specification.
      description: Additional metadata from the discovery source provider.
      title: apiCatalogDiscoveryServicesProviderMetadata
    getApiCatalogDiscoveryServiceApiDefinitionData:
      type: object
      properties:
        format:
          type: string
          description: The definition's format.
        formatVersion:
          type: string
          description: The API definition format's version.
        contentHash:
          type: string
          description: A SHA-256 hash of the API definition content for change detection.
        content:
          type: string
          description: A Base64-encoded API definition.
      description: The API definition associated with the service.
      title: getApiCatalogDiscoveryServiceApiDefinitionData
    getApiCatalogDiscoveryService:
      type: object
      properties:
        id:
          type: string
          description: The service's ID.
        organizationId:
          type: integer
          description: The ID of the organization that the service belongs to.
        discoverySource:
          type: string
          description: The source through which the service was discovered.
        name:
          type: string
          description: The servie's name.
        description:
          type:
            - string
            - 'null'
          description: The service's description.
        version:
          type: string
          description: The service's version.
        sourceEnvironment:
          type:
            - string
            - 'null'
          description: The source environment in which the service was discovered.
        systemEnvironmentId:
          type:
            - string
            - 'null'
          description: The mapped system environment's ID. Returns a null value if the environment is not mapped.
        tags:
          $ref: '#/components/schemas/apiCatalogDiscoveryServicesTagsData'
        status:
          type: string
          description: The service's current status.
        providerServiceId:
          type: string
          description: The ID of the service in the source registry.
        providerMetadata:
          $ref: '#/components/schemas/apiCatalogDiscoveryServicesProviderMetadata'
        apiDefinition:
          $ref: '#/components/schemas/getApiCatalogDiscoveryServiceApiDefinitionData'
        endpoints:
          type: array
          items:
            $ref: '#/components/schemas/apiCatalogDiscoveryServiceEndpointsData'
          description: A list of the service's endpoints.
        endpointsCount:
          type: integer
          description: The total number of endpoints associated with the service.
        discoveredAt:
          type: string
          format: date-time
          description: The date and time at which the service was first discovered.
        discoveredBy:
          type: integer
          description: The user ID of the user who discovered or ingested the service.
        lastSyncedAt:
          type: string
          format: date-time
          description: The date and time of the most recent service sync.
        managedWorkspaceId:
          type:
            - string
            - 'null'
          description: >-
            The ID of the Postman workspace that the service has been integrated into. Returns a null value if the
            service is not integrated.
        integratedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date and time at which the service was linked to a Postman workspace. Returns a null value if the
            service is not integrated.
      description: Information about the discovered service.
      title: getApiCatalogDiscoveryService
    GetApiCatalogDiscoveryServiceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogDiscoveryServiceRequestInternalServerError
    systemEnvironmentId:
      type: string
      title: systemEnvironmentId
    apiCatalogServiceNameFilter:
      type: string
      maxLength: 255
      title: apiCatalogServiceNameFilter
    apiCatalogServiceTagsFilter:
      type: string
      pattern: ^[^,]+(,[^,]+)*$
      title: apiCatalogServiceTagsFilter
    apiCatalogServiceGovernanceGroupIdFilter:
      type: string
      title: apiCatalogServiceGovernanceGroupIdFilter
    apiCatalogServiceMetadataNextCursorData:
      type: string
      description: The pagination cursor that points to the next record in the results set.
      title: apiCatalogServiceMetadataNextCursorData
    apiCatalogServiceMetadataLimitData:
      type: integer
      description: The maximum number of records in the paginated response.
      title: apiCatalogServiceMetadataLimitData
    apiCatalogServiceMetadataFiltersData:
      type: object
      properties: {}
      description: The filters applied to the request.
      title: apiCatalogServiceMetadataFiltersData
    ApiCatalogServiceMetadataTimeRangeDataLabel:
      type: string
      enum:
        - last_7_days
      description: The time range's label.
      title: ApiCatalogServiceMetadataTimeRangeDataLabel
    apiCatalogServiceMetadataTimeRangeData:
      type: object
      properties:
        start:
          type: string
          format: date-time
          description: The start of the time window.
        end:
          type: string
          format: date-time
          description: The end of the time window.
        label:
          $ref: '#/components/schemas/ApiCatalogServiceMetadataTimeRangeDataLabel'
          description: The time range's label.
      required:
        - start
        - end
        - label
      description: The time window for the returned data.
      title: apiCatalogServiceMetadataTimeRangeData
    GetApiCatalogServicesMeta:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData'
        limit:
          $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData'
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
      required:
        - nextCursor
        - limit
        - filters
        - timeRange
      description: The response's meta information for paginated results.
      title: GetApiCatalogServicesMeta
    ApiCatalogServiceServiceDataStatus:
      type: string
      enum:
        - healthy
        - warning
        - critical
        - inactive
      description: The overall health status, derived from compliance signals.
      title: ApiCatalogServiceServiceDataStatus
    ApiCatalogServiceServiceDataTraffic:
      type: object
      properties:
        p95LatencyMs:
          type:
            - number
            - 'null'
          format: double
          description: The 95th-percentile response latency, in milliseconds.
        errorRatePct:
          type:
            - number
            - 'null'
          format: double
          description: The percentage of requests that resulted in errors.
      required:
        - p95LatencyMs
        - errorRatePct
      description: >-
        Information about traffic and performance within the time window. If there's no traffic data, this returns a
        null value.
      title: ApiCatalogServiceServiceDataTraffic
    ApiCatalogServiceServiceDataComplianceMonitorRunStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
      title: ApiCatalogServiceServiceDataComplianceMonitorRunStatus
    ApiCatalogServiceServiceDataComplianceMonitorRun:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceMonitorRunStatus'
            - type: 'null'
          description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
      required:
        - status
      description: The scheduled monitor run summary.
      title: ApiCatalogServiceServiceDataComplianceMonitorRun
    ApiCatalogServiceServiceDataComplianceCliRunStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
      title: ApiCatalogServiceServiceDataComplianceCliRunStatus
    ApiCatalogServiceServiceDataComplianceCliRun:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceCliRunStatus'
            - type: 'null'
          description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
      required:
        - status
      description: Information about the CI/CD pipeline.
      title: ApiCatalogServiceServiceDataComplianceCliRun
    ApiCatalogServiceServiceDataComplianceSpecLintStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
      title: ApiCatalogServiceServiceDataComplianceSpecLintStatus
    ApiCatalogServiceServiceDataComplianceSpecLint:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceSpecLintStatus'
            - type: 'null'
          description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
      required:
        - status
      description: Information about the API specification lint.
      title: ApiCatalogServiceServiceDataComplianceSpecLint
    ApiCatalogServiceServiceDataCompliance:
      type: object
      properties:
        monitorRun:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceMonitorRun'
          description: The scheduled monitor run summary.
        cliRun:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceCliRun'
          description: Information about the CI/CD pipeline.
        specLint:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataComplianceSpecLint'
          description: Information about the API specification lint.
      required:
        - monitorRun
        - cliRun
        - specLint
      description: Information about compliance and governance.
      title: ApiCatalogServiceServiceDataCompliance
    ApiCatalogServiceServiceDataOwnerType:
      type: string
      enum:
        - user
        - group
      description: The type of owner.
      title: ApiCatalogServiceServiceDataOwnerType
    ApiCatalogServiceServiceDataOwner:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataOwnerType'
          description: The type of owner.
        id:
          type: string
          description: The owner's ID.
        name:
          type:
            - string
            - 'null'
          description: The owner's display name.
        profilePicUrl:
          type:
            - string
            - 'null'
          format: uri
          description: The URL of the owner's profile picture.
        publicHandle:
          type:
            - string
            - 'null'
          format: uri
          description: The URL of the owner's public profile.
      required:
        - type
        - id
        - name
        - profilePicUrl
        - publicHandle
      description: The service's owner. If no owner is assigned, this returns a null value.
      title: ApiCatalogServiceServiceDataOwner
    ApiCatalogServiceServiceDataGovernanceGroup:
      type: object
      properties:
        id:
          type: string
          description: The governance group's ID.
        name:
          type: string
          description: The governance group's name.
      required:
        - id
        - name
      description: >-
        The governance group that the workspace belongs to. If no governance group is assigned, this returns a null
        value.
      title: ApiCatalogServiceServiceDataGovernanceGroup
    apiCatalogServiceServiceData:
      type: object
      properties:
        id:
          type: string
          description: The service's ID.
        name:
          type: string
          description: The service's name.
        status:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataStatus'
          description: The overall health status, derived from compliance signals.
        lastActivityAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date and time of the last observed activity. If there's no activity in the time window, this returns a
            null value.
        traffic:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataTraffic'
            - type: 'null'
          description: >-
            Information about traffic and performance within the time window. If there's no traffic data, this returns a
            null value.
        compliance:
          $ref: '#/components/schemas/ApiCatalogServiceServiceDataCompliance'
          description: Information about compliance and governance.
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time at which the workspace was created.
        gitRepo:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            The URL of the linked Git repository. If the workspace isn't connected to a repository, this returns a null
            value.
        owner:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataOwner'
            - type: 'null'
          description: The service's owner. If no owner is assigned, this returns a null value.
        tags:
          type: array
          items:
            type: string
          description: A list of the workspace's tags.
        governanceGroup:
          oneOf:
            - $ref: '#/components/schemas/ApiCatalogServiceServiceDataGovernanceGroup'
            - type: 'null'
          description: >-
            The governance group that the workspace belongs to. If no governance group is assigned, this returns a null
            value.
      required:
        - id
        - name
        - status
        - lastActivityAt
        - traffic
        - compliance
        - createdAt
        - gitRepo
        - owner
        - tags
        - governanceGroup
      description: Information about the service.
      title: apiCatalogServiceServiceData
    getApiCatalogServices:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServicesMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/apiCatalogServiceServiceData'
          description: A list of list of services.
      title: getApiCatalogServices
    GetApiCatalogServicesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServicesRequestInternalServerError
    GetApiCatalogServiceMeta:
      type: object
      properties:
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
      required:
        - timeRange
      description: The response's meta information for paginated results.
      title: GetApiCatalogServiceMeta
    GetApiCatalogServiceDataStatus:
      type: string
      enum:
        - healthy
        - warning
        - critical
        - inactive
      description: The overall health status, derived from compliance signals.
      title: GetApiCatalogServiceDataStatus
    getApiCatalogServiceTrafficData:
      type: object
      properties:
        p95LatencyMs:
          type: number
          format: double
          description: The 95th-percentile response latency, in milliseconds.
        errorRatePct:
          type: number
          format: double
          description: The percentage of requests that resulted in errors.
        totalRequests:
          type: integer
          description: The total number of requests.
        totalRequestsDeltaPct:
          type:
            - number
            - 'null'
          format: double
          description: The percentage change in total requests compared to the preceding seven day window.
        totalErrors:
          type: integer
          description: The total number of error responses.
        totalEndpoints:
          type: integer
          description: The total number of distinct endpoints.
        p95LatencyMsDeltaPct:
          type:
            - number
            - 'null'
          format: double
          description: The percentage change in p95 latency compared to the preceding seven day window.
        errorRatePctDeltaPct:
          type:
            - number
            - 'null'
          format: double
          description: The percentage change in error rate compared to the preceding seven day window.
      description: >-
        Information about traffic and performance within the time window. If there's no traffic data, this returns a
        null value.
      title: getApiCatalogServiceTrafficData
    GetApiCatalogServiceComplianceDataMonitorRunStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
      title: GetApiCatalogServiceComplianceDataMonitorRunStatus
    GetApiCatalogServiceComplianceDataMonitorRun:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataMonitorRunStatus'
            - type: 'null'
          description: Whether the monitor's latest runs passed or failed. If no runs exist, this returns a null value.
        totalMonitors:
          type: integer
          description: >-
            The total number of monitors in the workspace. This value is the same as the as `entityCounts.monitors`
            value.
        activeMonitors:
          type: integer
          description: The number of distinct monitors with at least one run in the time window.
        passingMonitors:
          type: integer
          description: The number of distinct monitors whose latest run passed within the time window.
        failingMonitors:
          type: integer
          description: The number of distinct monitors whose latest run failed within the time window.
        lastRunAt:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time of the most recent run across all monitors. If no runs exist, this returns a null value.
      required:
        - status
        - totalMonitors
        - activeMonitors
        - passingMonitors
        - failingMonitors
        - lastRunAt
      description: The scheduled monitor run summary.
      title: GetApiCatalogServiceComplianceDataMonitorRun
    GetApiCatalogServiceComplianceDataCliRunStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
      title: GetApiCatalogServiceComplianceDataCliRunStatus
    GetApiCatalogServiceComplianceDataCliRun:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataCliRunStatus'
            - type: 'null'
          description: Whether the pipelines' latest runs passed or failed. If no runs exist, this returns a null value.
        activePipelines:
          type: integer
          description: The number of distinct pipelines with at least one run within the time window.
        passingPipelines:
          type: integer
          description: The number of distinct pipelines whose latest run passed within the time window.
        failingPipelines:
          type: integer
          description: The number of distinct pipelines whose latest run failed within the time window.
        lastRunAt:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time of the most recent run across all pipelines. If no runs exist, this returns a null value.
      required:
        - status
        - activePipelines
        - passingPipelines
        - failingPipelines
        - lastRunAt
      description: Information about the CI/CD pipeline.
      title: GetApiCatalogServiceComplianceDataCliRun
    GetApiCatalogServiceComplianceDataSpecLintStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
      title: GetApiCatalogServiceComplianceDataSpecLintStatus
    GetApiCatalogServiceComplianceDataSpecLint:
      type: object
      properties:
        status:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataSpecLintStatus'
            - type: 'null'
          description: Whether the specifications' latest lints passed or failed. If no lints exist, this returns a null value.
        totalSpecs:
          type: integer
          description: >-
            The total number of API specifications in the workspace. This value is the same as the as
            `entityCounts.specifications` value.
        activeSpecs:
          type: integer
          description: The number of distinct specifications with at least one lint within the time window.
        passingSpecs:
          type: integer
          description: The number of distinct specifications whose latest lint passed within the time window.
        failingSpecs:
          type: integer
          description: The number of distinct specifications whose latest lint failed within the time window.
        lastRunAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date and time of the most recent lint run across all specifications. If no lint exist, this returns a
            null value.
      required:
        - status
        - totalSpecs
        - activeSpecs
        - passingSpecs
        - failingSpecs
        - lastRunAt
      description: Information about the API specification lint.
      title: GetApiCatalogServiceComplianceDataSpecLint
    GetApiCatalogServiceComplianceDataCollectionRuns:
      type: object
      properties:
        totalRuns:
          type: integer
          description: The total number of collection runs.
        passedRuns:
          type: integer
          description: The number of collection runs that passed.
        failedRuns:
          type: integer
          description: The number of collection runs that failed.
        passRate:
          type:
            - number
            - 'null'
          format: double
          description: The percentage of collection runs that passed. If no runs exist, this returns a null value.
        totalCollections:
          type: integer
          description: >-
            The total number of collections in the workspace. This value is the same as the as
            `entityCounts.collections` value.
        activeCollections:
          type: integer
          description: The number of distinct collections with at least one run within the time window.
        totalAssertions:
          type: integer
          description: The total number of assertions evaluated.
        failedAssertions:
          type: integer
          description: The number of assertions that failed.
      required:
        - totalRuns
        - passedRuns
        - failedRuns
        - passRate
        - totalCollections
        - activeCollections
        - totalAssertions
        - failedAssertions
      description: Information about collection runs, including monitor runs, CI pipeline runs, and manual runs.
      title: GetApiCatalogServiceComplianceDataCollectionRuns
    getApiCatalogServiceComplianceData:
      type: object
      properties:
        monitorRun:
          $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataMonitorRun'
          description: The scheduled monitor run summary.
        cliRun:
          $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataCliRun'
          description: Information about the CI/CD pipeline.
        specLint:
          $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataSpecLint'
          description: Information about the API specification lint.
        collectionRuns:
          $ref: '#/components/schemas/GetApiCatalogServiceComplianceDataCollectionRuns'
          description: Information about collection runs, including monitor runs, CI pipeline runs, and manual runs.
      required:
        - monitorRun
        - cliRun
        - specLint
        - collectionRuns
      description: Information about compliance and governance.
      title: getApiCatalogServiceComplianceData
    getApiCatalogServiceEntityCountData:
      type: object
      properties:
        collections:
          type: integer
          description: The total number of collections.
        specifications:
          type: integer
          description: The total number of API specifications.
        monitors:
          type: integer
          description: The total number of monitors.
        mocks:
          type: integer
          description: The total number of mock servers.
        flows:
          type: integer
          description: The total number of Postman Flows.
        environments:
          type: integer
          description: The total number of environments.
      required:
        - collections
        - specifications
        - monitors
        - mocks
        - flows
        - environments
      description: Information about the workspace's entities.
      title: getApiCatalogServiceEntityCountData
    GetApiCatalogServiceOwnerDataType:
      type: string
      enum:
        - user
        - group
      description: The type of owner.
      title: GetApiCatalogServiceOwnerDataType
    getApiCatalogServiceOwnerData:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GetApiCatalogServiceOwnerDataType'
          description: The type of owner.
        id:
          type: string
          description: The owner's ID.
        name:
          type:
            - string
            - 'null'
          description: The owner's display name.
        profilePicUrl:
          type:
            - string
            - 'null'
          format: uri
          description: The URL of the owner's profile picture.
        publicHandle:
          type:
            - string
            - 'null'
          format: uri
          description: The URL of the owner's public profile.
      required:
        - type
        - id
        - name
        - profilePicUrl
        - publicHandle
      description: The service's owner. If no owner is assigned, this returns a null value.
      title: getApiCatalogServiceOwnerData
    GetApiCatalogServiceDataGovernanceGroup:
      type: object
      properties:
        id:
          type: string
          description: The governance group's ID.
        name:
          type: string
          description: The governance group's name.
      required:
        - id
        - name
      description: >-
        The governance group that the workspace belongs to. If no governance group is assigned, this returns a null
        value.
      title: GetApiCatalogServiceDataGovernanceGroup
    GetApiCatalogServiceDataDependenciesItemsDirection:
      type: string
      enum:
        - inbound
        - outbound
      description: Whether traffic flows into (inbound) or out of (outbound) the service.
      title: GetApiCatalogServiceDataDependenciesItemsDirection
    GetApiCatalogServiceDataDependenciesItems:
      type: object
      properties:
        id:
          type: string
          description: The dependent service's ID.
        name:
          type: string
          description: The dependent service's name.
        direction:
          $ref: '#/components/schemas/GetApiCatalogServiceDataDependenciesItemsDirection'
          description: Whether traffic flows into (inbound) or out of (outbound) the service.
      required:
        - id
        - name
        - direction
      title: GetApiCatalogServiceDataDependenciesItems
    GetApiCatalogServiceData:
      type: object
      properties:
        id:
          type: string
          description: The service's ID.
        name:
          type: string
          description: The service's name.
        status:
          $ref: '#/components/schemas/GetApiCatalogServiceDataStatus'
          description: The overall health status, derived from compliance signals.
        lastActivityAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            The date and time of the last observed activity. If there's no activity in the time window, this returns a
            null value.
        traffic:
          $ref: '#/components/schemas/getApiCatalogServiceTrafficData'
        compliance:
          $ref: '#/components/schemas/getApiCatalogServiceComplianceData'
        entityCounts:
          $ref: '#/components/schemas/getApiCatalogServiceEntityCountData'
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time at which the workspace was created.
        gitRepo:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            The URL of the linked Git repository. If the workspace isn't connected to a repository, this returns a null
            value.
        owner:
          $ref: '#/components/schemas/getApiCatalogServiceOwnerData'
        tags:
          type: array
          items:
            type: string
          description: A list of the workspace's tags.
        governanceGroup:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceDataGovernanceGroup'
            - type: 'null'
          description: >-
            The governance group that the workspace belongs to. If no governance group is assigned, this returns a null
            value.
        dependencies:
          type: array
          items:
            $ref: '#/components/schemas/GetApiCatalogServiceDataDependenciesItems'
          description: A list of inbound and outbound service dependencies from the service graph.
      required:
        - id
        - name
        - status
        - lastActivityAt
        - traffic
        - compliance
        - entityCounts
        - createdAt
        - gitRepo
        - owner
        - tags
        - governanceGroup
        - dependencies
      description: Information about the service.
      title: GetApiCatalogServiceData
    getApiCatalogService:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServiceMeta'
          description: The response's meta information for paginated results.
        data:
          $ref: '#/components/schemas/GetApiCatalogServiceData'
          description: Information about the service.
      required:
        - meta
        - data
      title: getApiCatalogService
    GetApiCatalogServiceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServiceRequestInternalServerError
    apiCatalogServiceHttpMethodFilter:
      type: string
      pattern: ^(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|TRACE)(,(GET|POST|PUT|PATCH|DELETE|HEAD|OPTIONS|TRACE))*$
      title: apiCatalogServiceHttpMethodFilter
    apiCatalogServiceHostsFilter:
      type: string
      pattern: ^[^,]+(,[^,]+)*$
      title: apiCatalogServiceHostsFilter
    apiCatalogServiceResponseCodeFilter:
      type: string
      pattern: ^\\d{3}(,\\d{3})*$
      title: apiCatalogServiceResponseCodeFilter
    apiCatalogServiceSearchFilter:
      type: string
      maxLength: 500
      title: apiCatalogServiceSearchFilter
    apiCatalogServiceSortEndpointsFilter:
      type: string
      pattern: ^(count|endpoint|p95LatencyMs|errorRate):(asc|desc)$
      title: apiCatalogServiceSortEndpointsFilter
    GetApiCatalogServiceEndpointsMeta:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData'
        limit:
          $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData'
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
        totalEndpoints:
          type: integer
          description: The total number of endpoints that match the given filters.
        totalRequests:
          type: integer
          description: The total number of requests that match the given filters.
      required:
        - nextCursor
        - limit
        - filters
        - timeRange
        - totalEndpoints
        - totalRequests
      description: The response's meta information for paginated results.
      title: GetApiCatalogServiceEndpointsMeta
    GetApiCatalogServiceEndpointsDataItemsMethod:
      type: string
      enum:
        - GET
        - POST
        - PUT
        - PATCH
        - DELETE
        - HEAD
        - OPTIONS
        - TRACE
      description: The endpoint's HTTP method.
      title: GetApiCatalogServiceEndpointsDataItemsMethod
    GetApiCatalogServiceEndpointsDataItemsPerformance:
      type: object
      properties:
        p90LatencyMs:
          type: number
          format: double
          description: The 90th-percentile response latency, in milliseconds.
        p95LatencyMs:
          type: number
          format: double
          description: The 95th-percentile response latency, in milliseconds.
      required:
        - p90LatencyMs
        - p95LatencyMs
      description: Information about latency percentile metrics.
      title: GetApiCatalogServiceEndpointsDataItemsPerformance
    GetApiCatalogServiceEndpointsDataItemsErrors:
      type: object
      properties:
        totalErrors:
          type: integer
          description: The total number of 4xx and 5xx responses.
        errorRatePct:
          type: number
          format: double
          description: The percentage of requests that resulted in errors.
        breakdown:
          type: object
          additionalProperties:
            type: integer
          description: The error counts, keyed by the HTTP status code.
      required:
        - totalErrors
        - errorRatePct
        - breakdown
      description: Information about the endpoint's errors.
      title: GetApiCatalogServiceEndpointsDataItemsErrors
    GetApiCatalogServiceEndpointsDataItems:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/GetApiCatalogServiceEndpointsDataItemsMethod'
          description: The endpoint's HTTP method.
        path:
          type: string
          description: The endpoint's URL path template.
        host:
          type: string
          description: The hostname the endpoint was observed on.
        requestCount:
          type: integer
          description: The total number of requests to this endpoint within the time window.
        performance:
          $ref: '#/components/schemas/GetApiCatalogServiceEndpointsDataItemsPerformance'
          description: Information about latency percentile metrics.
        errors:
          $ref: '#/components/schemas/GetApiCatalogServiceEndpointsDataItemsErrors'
          description: Information about the endpoint's errors.
      required:
        - method
        - path
        - host
        - requestCount
        - performance
        - errors
      title: GetApiCatalogServiceEndpointsDataItems
    getApiCatalogServiceEndpoints:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServiceEndpointsMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetApiCatalogServiceEndpointsDataItems'
          description: A list of observed API endpoints with traffic and performance metrics.
      required:
        - meta
        - data
      title: getApiCatalogServiceEndpoints
    GetApiCatalogServiceEndpointsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServiceEndpointsRequestInternalServerError
    collectionUid:
      type: string
      format: uid
      title: collectionUid
    apiCatalogServiceSortMonitorRun:
      type: string
      pattern: ^(timestamp|duration|failedAssertions):(asc|desc)$
      title: apiCatalogServiceSortMonitorRun
    environmentId:
      type: string
      title: environmentId
    apiCatalogServiceStatusFilter:
      type: string
      enum:
        - passed
        - failed
      title: apiCatalogServiceStatusFilter
    apiCatalogServiceMetadataTotalRunsData:
      type: integer
      description: The total number of runs that match the given filters.
      title: apiCatalogServiceMetadataTotalRunsData
    apiCatalogServiceMetadataPassedRunsData:
      type: integer
      description: The number of successful runs.
      title: apiCatalogServiceMetadataPassedRunsData
    apiCatalogServiceMetadataFailedRunsData:
      type: integer
      description: The number of runs with at least one failure.
      title: apiCatalogServiceMetadataFailedRunsData
    apiCatalogServiceMetadataSuccessRatePctData:
      type: number
      format: double
      description: The percentage of runs that passed, rounded to two decimal places.
      title: apiCatalogServiceMetadataSuccessRatePctData
    GetApiCatalogServiceMonitorRunsMeta:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData'
        limit:
          $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData'
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
        totalRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData'
        passedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData'
        failedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData'
        successRatePct:
          $ref: '#/components/schemas/apiCatalogServiceMetadataSuccessRatePctData'
      required:
        - nextCursor
        - limit
        - filters
        - timeRange
        - totalRuns
        - passedRuns
        - failedRuns
        - successRatePct
      description: The response's meta information for paginated results.
      title: GetApiCatalogServiceMonitorRunsMeta
    GetApiCatalogServiceMonitorRunsDataItemsStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the monitor run passed or failed.
      title: GetApiCatalogServiceMonitorRunsDataItemsStatus
    apiCatalogServiceCollectionData:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type:
            - string
            - 'null'
          description: The collection's name. If the collection was deleted, this returns a null value.
      required:
        - id
        - name
      description: Information about the collection.
      title: apiCatalogServiceCollectionData
    apiCatalogServiceEnvironmentData:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type:
            - string
            - 'null'
          description: The environment's name. If the environment was deleted, this returns a null value.
      required:
        - id
        - name
      description: Information about the environment.
      title: apiCatalogServiceEnvironmentData
    GetApiCatalogServiceMonitorRunsDataItemsSummary:
      type: object
      properties:
        totalRequests:
          type: integer
          description: The total number of HTTP requests executed in the run.
        failedRequests:
          type: integer
          description: The number of requests that failed.
        totalAssertions:
          type: integer
          description: The total number of test assertions evaluated.
        failedAssertions:
          type: integer
          description: The number of failed assertions.
        durationMs:
          type: integer
          description: The total execution duration, in milliseconds.
      required:
        - totalRequests
        - failedRequests
        - totalAssertions
        - failedAssertions
        - durationMs
      description: Information about the monitor run.
      title: GetApiCatalogServiceMonitorRunsDataItemsSummary
    apiCatalogServicePerformanceData:
      type: object
      properties:
        minResponseMs:
          type: number
          format: double
          description: The fastest individual response time, in milliseconds.
        maxResponseMs:
          type: number
          format: double
          description: The slowest individual response time, in milliseconds.
      required:
        - minResponseMs
        - maxResponseMs
      description: Information about the response time range across all requests in the run.
      title: apiCatalogServicePerformanceData
    GetApiCatalogServiceMonitorRunsDataItems:
      type: object
      properties:
        id:
          type: string
          description: The monitor run's ID.
        status:
          $ref: '#/components/schemas/GetApiCatalogServiceMonitorRunsDataItemsStatus'
          description: Whether the monitor run passed or failed.
        timestamp:
          type: string
          format: date-time
          description: The date and time at which the run completed.
        collection:
          $ref: '#/components/schemas/apiCatalogServiceCollectionData'
        environment:
          $ref: '#/components/schemas/apiCatalogServiceEnvironmentData'
        summary:
          $ref: '#/components/schemas/GetApiCatalogServiceMonitorRunsDataItemsSummary'
          description: Information about the monitor run.
        performance:
          $ref: '#/components/schemas/apiCatalogServicePerformanceData'
      required:
        - id
        - status
        - timestamp
        - collection
        - environment
        - summary
        - performance
      title: GetApiCatalogServiceMonitorRunsDataItems
    getApiCatalogServiceMonitorRuns:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServiceMonitorRunsMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetApiCatalogServiceMonitorRunsDataItems'
          description: A list of monitor runs.
      required:
        - meta
        - data
      title: getApiCatalogServiceMonitorRuns
    GetApiCatalogServiceMonitorRunsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServiceMonitorRunsRequestInternalServerError
    specId:
      type: string
      title: specId
    apiCatalogServiceSpecLintSeverityFilter:
      type: string
      enum:
        - info
        - warning
        - error
      title: apiCatalogServiceSpecLintSeverityFilter
    apiCatalogServiceSortSpecLintFilter:
      type: string
      pattern: ^(timestamp|errorCount):(asc|desc)$
      title: apiCatalogServiceSortSpecLintFilter
    apiCatalogServiceMetadataConformanceRatePctData:
      type: number
      format: double
      description: The percentage of runs that passed, rounded to two decimal places.
      title: apiCatalogServiceMetadataConformanceRatePctData
    GetApiCatalogServiceSpecificationLintsMeta:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData'
        limit:
          $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData'
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
        totalRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData'
        passedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData'
        failedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData'
        conformanceRatePct:
          $ref: '#/components/schemas/apiCatalogServiceMetadataConformanceRatePctData'
      required:
        - nextCursor
        - limit
        - filters
        - timeRange
        - totalRuns
        - passedRuns
        - failedRuns
        - conformanceRatePct
      description: The response's meta information for paginated results.
      title: GetApiCatalogServiceSpecificationLintsMeta
    GetApiCatalogServiceSpecificationLintsDataItemsStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the lint run passed or failed.
      title: GetApiCatalogServiceSpecificationLintsDataItemsStatus
    GetApiCatalogServiceSpecificationLintsDataItemsIssues:
      type: object
      properties:
        errors:
          type: integer
          description: The number of error level issues found.
        warnings:
          type: integer
          description: The number of warning level issues found.
        info:
          type: integer
          description: The number of info level issues found.
      required:
        - errors
        - warnings
        - info
      description: Issue counts by severity level.
      title: GetApiCatalogServiceSpecificationLintsDataItemsIssues
    GetApiCatalogServiceSpecificationLintsDataItems:
      type: object
      properties:
        specId:
          type: string
          description: The API specification's ID.
        specName:
          type:
            - string
            - 'null'
          description: >-
            The API specification's name. If the specification was deleted or its metadata is unavailable, this returns
            a null value.
        specType:
          type:
            - string
            - 'null'
          description: The API specification's type and version ID. If the metadata is unavailable, this returns a null value.
        timestamp:
          type: string
          format: date-time
          description: The date and time at which the run completed.
        status:
          $ref: '#/components/schemas/GetApiCatalogServiceSpecificationLintsDataItemsStatus'
          description: Whether the lint run passed or failed.
        issues:
          $ref: '#/components/schemas/GetApiCatalogServiceSpecificationLintsDataItemsIssues'
          description: Issue counts by severity level.
      required:
        - specId
        - specName
        - specType
        - timestamp
        - status
        - issues
      title: GetApiCatalogServiceSpecificationLintsDataItems
    getApiCatalogServiceSpecificationLints:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServiceSpecificationLintsMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetApiCatalogServiceSpecificationLintsDataItems'
          description: A list of API specification lint runs.
      required:
        - meta
        - data
      title: getApiCatalogServiceSpecificationLints
    GetApiCatalogServiceSpecificationLintsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServiceSpecificationLintsRequestInternalServerError
    apiCatalogServiceBranchFilter:
      type: string
      maxLength: 255
      title: apiCatalogServiceBranchFilter
    apiCatalogServiceWorkflowNameFilter:
      type: string
      maxLength: 255
      title: apiCatalogServiceWorkflowNameFilter
    apiCatalogServiceActorFilter:
      type: string
      maxLength: 100
      title: apiCatalogServiceActorFilter
    apiCatalogServiceRepoNameFilter:
      type: string
      maxLength: 255
      title: apiCatalogServiceRepoNameFilter
    apiCatalogServiceRepoOwnerFilter:
      type: string
      maxLength: 100
      title: apiCatalogServiceRepoOwnerFilter
    apiCatalogServiceSortCiFilter:
      type: string
      pattern: ^(timestamp|duration):(asc|desc)$
      title: apiCatalogServiceSortCiFilter
    GetApiCatalogServiceCiRunsMeta:
      type: object
      properties:
        nextCursor:
          $ref: '#/components/schemas/apiCatalogServiceMetadataNextCursorData'
        limit:
          $ref: '#/components/schemas/apiCatalogServiceMetadataLimitData'
        filters:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFiltersData'
        timeRange:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTimeRangeData'
        totalRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataTotalRunsData'
        passedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataPassedRunsData'
        failedRuns:
          $ref: '#/components/schemas/apiCatalogServiceMetadataFailedRunsData'
        successRatePct:
          $ref: '#/components/schemas/apiCatalogServiceMetadataSuccessRatePctData'
      required:
        - nextCursor
        - limit
        - filters
        - timeRange
        - totalRuns
        - passedRuns
        - failedRuns
        - successRatePct
      description: The response's meta information for paginated results.
      title: GetApiCatalogServiceCiRunsMeta
    GetApiCatalogServiceCiRunsDataItemsStatus:
      type: string
      enum:
        - passed
        - failed
      description: Whether the CI run passed or failed.
      title: GetApiCatalogServiceCiRunsDataItemsStatus
    GetApiCatalogServiceCiRunsDataItemsSourceRepo:
      type: object
      properties:
        name:
          type:
            - string
            - 'null'
          description: The repository's name.
        owner:
          type:
            - string
            - 'null'
          description: The repository owner or organization.
        url:
          type:
            - string
            - 'null'
          format: uri
          description: The repository's URL.
      required:
        - name
        - owner
        - url
      description: Information about the source repository.
      title: GetApiCatalogServiceCiRunsDataItemsSourceRepo
    GetApiCatalogServiceCiRunsDataItemsSourcePullRequest:
      type: object
      properties:
        number:
          type: integer
          description: The pull request number.
        title:
          type:
            - string
            - 'null'
          description: The pull request's title.
        status:
          type:
            - string
            - 'null'
          description: The pull request's status.
        author:
          type:
            - string
            - 'null'
          description: The author of the pull request.
        baseBranch:
          type:
            - string
            - 'null'
          description: The target branch of the pull request.
        headBranch:
          type:
            - string
            - 'null'
          description: The pull request's source branch.
      required:
        - number
        - title
        - status
        - author
        - baseBranch
        - headBranch
      description: Information about the pull request. This returns null if the run wasn't triggered by a pull request.
      title: GetApiCatalogServiceCiRunsDataItemsSourcePullRequest
    GetApiCatalogServiceCiRunsDataItemsSource:
      type: object
      properties:
        branch:
          type:
            - string
            - 'null'
          description: The Git branch's name.
        commitSha:
          type:
            - string
            - 'null'
          description: The full Git commit SHA.
        repo:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsSourceRepo'
          description: Information about the source repository.
        pullRequest:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsSourcePullRequest'
            - type: 'null'
          description: Information about the pull request. This returns null if the run wasn't triggered by a pull request.
      required:
        - branch
        - commitSha
        - repo
        - pullRequest
      description: Information about the Git source control for the CI run.
      title: GetApiCatalogServiceCiRunsDataItemsSource
    GetApiCatalogServiceCiRunsDataItemsPipeline:
      type: object
      properties:
        provider:
          type:
            - string
            - 'null'
          description: The CI provider.
        workflowName:
          type:
            - string
            - 'null'
          description: The workflow or pipeline name.
        workflowId:
          type:
            - string
            - 'null'
          description: The workflow ID.
        jobName:
          type:
            - string
            - 'null'
          description: The job name in the workflow.
        jobId:
          type:
            - string
            - 'null'
          description: The job's ID.
        pipelineId:
          type:
            - string
            - 'null'
          description: The pipeline run's ID.
        pipelineNumber:
          type:
            - string
            - 'null'
          description: The pipeline run number.
        runAttempt:
          type:
            - integer
            - 'null'
          description: The attempt number for this run.
        actor:
          type:
            - string
            - 'null'
          description: The user or bot that triggered the run.
      required:
        - provider
        - workflowName
        - workflowId
        - jobName
        - jobId
        - pipelineId
        - pipelineNumber
        - runAttempt
        - actor
      description: Information about the CI/CD pipeline.
      title: GetApiCatalogServiceCiRunsDataItemsPipeline
    GetApiCatalogServiceCiRunsDataItemsExecutionSystem:
      type: object
      properties:
        os:
          type: string
          description: The operating system and kernel version.
        cpus:
          type: integer
          description: The number of CPU cores.
        memoryMb:
          type: integer
          description: The available memory, in megabytes.
      description: The system information about the execution run. This returns as null if unavailable.
      title: GetApiCatalogServiceCiRunsDataItemsExecutionSystem
    GetApiCatalogServiceCiRunsDataItemsExecution:
      type: object
      properties:
        cliVersion:
          type:
            - string
            - 'null'
          description: The Postman CLI version.
        system:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsExecutionSystem'
          description: The system information about the execution run. This returns as null if unavailable.
      required:
        - cliVersion
        - system
      description: Information about the environment run.
      title: GetApiCatalogServiceCiRunsDataItemsExecution
    GetApiCatalogServiceCiRunsDataItemsSummary:
      type: object
      properties:
        totalRequests:
          type: integer
          description: The total number of HTTP requests executed in the run.
        failedRequests:
          type: integer
          description: The number of requests that failed.
        totalAssertions:
          type: integer
          description: The total number of test assertions evaluated.
        failedAssertions:
          type: integer
          description: The number of failed assertions.
        durationMs:
          type: integer
          description: Total execution duration in milliseconds.
      required:
        - totalRequests
        - failedRequests
        - totalAssertions
        - failedAssertions
        - durationMs
      description: Information about the CI run.
      title: GetApiCatalogServiceCiRunsDataItemsSummary
    GetApiCatalogServiceCiRunsDataItems:
      type: object
      properties:
        id:
          type: string
          description: The CI run's ID.
        status:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsStatus'
          description: Whether the CI run passed or failed.
        timestamp:
          type: string
          format: date-time
          description: The date and time at which the run completed.
        collection:
          $ref: '#/components/schemas/apiCatalogServiceCollectionData'
        environment:
          $ref: '#/components/schemas/apiCatalogServiceEnvironmentData'
        source:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsSource'
          description: Information about the Git source control for the CI run.
        pipeline:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsPipeline'
          description: Information about the CI/CD pipeline.
        execution:
          oneOf:
            - $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsExecution'
            - type: 'null'
          description: Information about the environment run.
        summary:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItemsSummary'
          description: Information about the CI run.
        performance:
          $ref: '#/components/schemas/apiCatalogServicePerformanceData'
      required:
        - id
        - status
        - timestamp
        - collection
        - environment
        - source
        - pipeline
        - execution
        - summary
        - performance
      title: GetApiCatalogServiceCiRunsDataItems
    getApiCatalogServiceCiRuns:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetApiCatalogServiceCiRunsMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetApiCatalogServiceCiRunsDataItems'
          description: A list of CI collection runs.
      required:
        - meta
        - data
      title: getApiCatalogServiceCiRuns
    GetApiCatalogServiceCiRunsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogServiceCiRunsRequestInternalServerError
    systemEnvironmentProductionFilter:
      type: boolean
      title: systemEnvironmentProductionFilter
    apiCatalogSystemEnvironmentsFiltersData:
      type: object
      properties:
        isProduction:
          type: boolean
      description: The applied filters, if any.
      title: apiCatalogSystemEnvironmentsFiltersData
    apiCatalogSystemEnvironmentsMetaData:
      type: object
      properties:
        total:
          type: integer
          description: The number of records that match the defined criteria.
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
        limit:
          type: integer
          description: The maximum number of records in the paginated response.
        filters:
          $ref: '#/components/schemas/apiCatalogSystemEnvironmentsFiltersData'
      required:
        - total
        - nextCursor
        - limit
      description: The response's meta information for paginated results.
      title: apiCatalogSystemEnvironmentsMetaData
    apiCatalogSystemEnvironmentData:
      type: object
      properties:
        id:
          type: string
          description: The system environment's ID.
        name:
          type: string
          description: The system environment's name.
        label:
          type: string
          description: A lowercase, terminal-friendly identifier for the system environment.
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: A six-digit hex color code.
        description:
          type: string
          description: A description of the system environment.
        isProduction:
          type: boolean
          description: If true, the system environment is a production environment.
        associationCount:
          type: integer
          description: The total number of workspace environments associated with this system environment.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the system environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the system environment was last updated.
      required:
        - id
        - name
        - label
        - color
        - description
        - isProduction
        - associationCount
        - createdAt
        - updatedAt
      description: Information about the system environment.
      title: apiCatalogSystemEnvironmentData
    getApiCatalogSystemEnvironments:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/apiCatalogSystemEnvironmentsMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/apiCatalogSystemEnvironmentData'
          description: A list of system environments.
      required:
        - meta
        - data
      title: getApiCatalogSystemEnvironments
    GetApiCatalogSystemEnvironmentsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: GetApiCatalogSystemEnvironmentsRequestBadRequestError
    GetApiCatalogSystemEnvironmentsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogSystemEnvironmentsRequestInternalServerError
    createApiCatalogSystemEnvironment:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: The system environment's name. This value must be unique within the team.
        label:
          type: string
          pattern: ^[a-z0-9_-]+$
          maxLength: 50
          description: >-
            A lowercase, terminal-friendly identifier for the system environment. Accepts only alphanumeric characters,
            hyphens, and underscores.
        description:
          type: string
          maxLength: 500
          description: A description of the system environment. To remove a description, pass this value as an empty string.
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: A six-digit hex color code.
        isProduction:
          type: boolean
          default: false
          description: If true, the system environment is a production environment.
      required:
        - name
        - color
      title: createApiCatalogSystemEnvironment
    postPatchApiCatalogSystemEnvironmentData:
      type: object
      properties:
        id:
          type: string
          description: The system environment's ID.
        name:
          type: string
          description: The system environment's name.
        label:
          type: string
          description: A lowercase, terminal-friendly identifier for the system environment.
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: A six-digit hex color code.
        description:
          type: string
          description: A description of the system environment.
        isProduction:
          type: boolean
          description: If true, the system environment is a production environment.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the system environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the system environment was last updated.
      required:
        - id
        - name
        - label
        - color
        - description
        - isProduction
        - createdAt
        - updatedAt
      description: Information about the system environment.
      title: postPatchApiCatalogSystemEnvironmentData
    createApiCatalogSystemEnvironmentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/postPatchApiCatalogSystemEnvironmentData'
      required:
        - data
      title: createApiCatalogSystemEnvironmentResponse
    CreateApiCatalogSystemEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: CreateApiCatalogSystemEnvironmentRequestBadRequestError
    CreateApiCatalogSystemEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateApiCatalogSystemEnvironmentRequestInternalServerError
    getApiCatalogSystemEnvironment:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/apiCatalogSystemEnvironmentData'
      required:
        - data
      title: getApiCatalogSystemEnvironment
    GetApiCatalogSystemEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: GetApiCatalogSystemEnvironmentRequestBadRequestError
    GetApiCatalogSystemEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogSystemEnvironmentRequestInternalServerError
    updateApiCatalogSystemEnvironment:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: The system environment's name. This value must be unique within the team.
        description:
          type: string
          maxLength: 500
          description: A description of the system environment. To remove a description, pass this value as an empty string.
        color:
          type: string
          pattern: ^#[0-9A-Fa-f]{6}$
          description: A six-digit hex color code.
        isProduction:
          type: boolean
          description: If true, the system environment is a production environment.
      title: updateApiCatalogSystemEnvironment
    updateApiCatalogSystemEnvironmentResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/postPatchApiCatalogSystemEnvironmentData'
      required:
        - data
      title: updateApiCatalogSystemEnvironmentResponse
    UpdateApiCatalogSystemEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: UpdateApiCatalogSystemEnvironmentRequestBadRequestError
    UpdateApiCatalogSystemEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateApiCatalogSystemEnvironmentRequestInternalServerError
    systemEnvironmentWorkspaceId:
      type: string
      title: systemEnvironmentWorkspaceId
    getApiCatalogSystemEnvironmentAssociationsData:
      type: object
      properties:
        id:
          type: string
          description: The association's ID.
        workspaceEnvironmentId:
          type: string
          description: The workspace environment's ID.
        workspaceId:
          type: string
          description: The ID of the workspace that contains the environment.
        associatedAt:
          type: string
          format: date-time
          description: The date and time at which the association was created.
      required:
        - id
        - workspaceEnvironmentId
        - workspaceId
        - associatedAt
      description: Information about the workspace-environment association.
      title: getApiCatalogSystemEnvironmentAssociationsData
    getApiCatalogSystemEnvironmentAssociations:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/apiCatalogSystemEnvironmentsMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/getApiCatalogSystemEnvironmentAssociationsData'
          description: A list of workspace-environment associations.
      required:
        - meta
        - data
      title: getApiCatalogSystemEnvironmentAssociations
    GetApiCatalogSystemEnvironmentAssociationsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: GetApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
    GetApiCatalogSystemEnvironmentAssociationsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
    systemEnvironmentAllowPartial:
      type: boolean
      default: false
      title: systemEnvironmentAllowPartial
    workspaceEnvironmentIds:
      type: string
      pattern: ^[0-9]+-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
      description: A workspace environment's unique ID (`userId`-`environmentId`).
      title: workspaceEnvironmentIds
    workspaceEnvironmentIdsData:
      type: array
      items:
        $ref: '#/components/schemas/workspaceEnvironmentIds'
      description: A list of workspace environment unique IDs (`userId`-`environmentId`).
      title: workspaceEnvironmentIdsData
    addApiCatalogSystemEnvironmentAssociations:
      type: object
      properties:
        workspaceEnvironmentIds:
          $ref: '#/components/schemas/workspaceEnvironmentIdsData'
      required:
        - workspaceEnvironmentIds
      title: addApiCatalogSystemEnvironmentAssociations
    addApiCatalogSystemEnvironmentAssociationsMetaData:
      type: object
      properties:
        created:
          type: integer
          description: The number of new associations created.
        existing:
          type: integer
          description: The number of associations that already existed and were unchanged.
        replaced:
          type: integer
          description: The number of associations that were moved from a different system environment.
        excluded:
          type: integer
          description: >-
            The number of associations that were skipped. This only returns if you pass the `allowPartial` query
            parameter as `true`).
      required:
        - created
        - existing
        - replaced
        - excluded
      description: The response's meta information for paginated results.
      title: addApiCatalogSystemEnvironmentAssociationsMetaData
    AddApiCatalogSystemEnvironmentAssociationsDataStatus:
      type: string
      enum:
        - created
        - existing
        - replaced
        - excluded
      description: |
        The association's status:
        - `created` — An association was created.
        - `existing` — The association already existed and is unchanged.
        - `replaced` — The association was moved from a different system environment.
        - `excluded` — The association was skipped.
      title: AddApiCatalogSystemEnvironmentAssociationsDataStatus
    addApiCatalogSystemEnvironmentAssociationsData:
      type: object
      properties:
        id:
          type: string
          description: The association's unique ID. This value doesn't return if the item was excluded.
        workspaceEnvironmentId:
          type: string
          description: The workspace's environment ID.
        workspaceId:
          type: string
          description: The ID of the workspace that contains the environment. This value doesn't return if the item was excluded.
        associatedAt:
          type: string
          format: date-time
          description: The date and time at which the association was created. This value doesn't return if the item was excluded.
        status:
          $ref: '#/components/schemas/AddApiCatalogSystemEnvironmentAssociationsDataStatus'
          description: |
            The association's status:
            - `created` — An association was created.
            - `existing` — The association already existed and is unchanged.
            - `replaced` — The association was moved from a different system environment.
            - `excluded` — The association was skipped.
        previousSystemEnvironmentId:
          type: string
          description: The system environment ID the association was moved from. This only returns when the status is `replaced`.
        reason:
          type: string
          description: The reason the association was excluded. This only returns when the status is `excluded`.
      required:
        - workspaceEnvironmentId
        - status
      description: Information about the associated workspace environment.
      title: addApiCatalogSystemEnvironmentAssociationsData
    addApiCatalogSystemEnvironmentAssociationsResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/addApiCatalogSystemEnvironmentAssociationsData'
      required:
        - meta
        - data
      title: addApiCatalogSystemEnvironmentAssociationsResponse
    AddApiCatalogSystemEnvironmentAssociationsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: AddApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
    AddApiCatalogSystemEnvironmentAssociationsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AddApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
    removeApiCatalogSystemEnvironmentAssociations:
      type: object
      properties:
        workspaceEnvironmentIds:
          $ref: '#/components/schemas/workspaceEnvironmentIdsData'
      required:
        - workspaceEnvironmentIds
      title: removeApiCatalogSystemEnvironmentAssociations
    removeApiCatalogSystemEnvironmentAssociationsMetaData:
      type: object
      properties:
        deleted:
          type: integer
          description: The number of associations successfully removed.
        notFound:
          type: integer
          description: The number of environment IDs with no existing association to remove.
      required:
        - deleted
        - notFound
      description: The response's meta information for paginated results.
      title: removeApiCatalogSystemEnvironmentAssociationsMetaData
    RemoveApiCatalogSystemEnvironmentAssociationsDataStatus:
      type: string
      enum:
        - deleted
        - notFound
      description: |
        The status of the operation:
        - `deleted` — The association was successfully removed.
        - `notFound` — The association could not be removed.
      title: RemoveApiCatalogSystemEnvironmentAssociationsDataStatus
    removeApiCatalogSystemEnvironmentAssociationsData:
      type: object
      properties:
        workspaceEnvironmentId:
          type: string
          description: The workspace's environment ID.
        status:
          $ref: '#/components/schemas/RemoveApiCatalogSystemEnvironmentAssociationsDataStatus'
          description: |
            The status of the operation:
            - `deleted` — The association was successfully removed.
            - `notFound` — The association could not be removed.
      required:
        - workspaceEnvironmentId
        - status
      description: Information about the associated workspace environment.
      title: removeApiCatalogSystemEnvironmentAssociationsData
    removeApiCatalogSystemEnvironmentAssociationsResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/removeApiCatalogSystemEnvironmentAssociationsData'
      required:
        - meta
        - data
      title: removeApiCatalogSystemEnvironmentAssociationsResponse
    RemoveApiCatalogSystemEnvironmentAssociationsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/apiCatalogError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
      title: RemoveApiCatalogSystemEnvironmentAssociationsRequestBadRequestError
    RemoveApiCatalogSystemEnvironmentAssociationsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RemoveApiCatalogSystemEnvironmentAssociationsRequestInternalServerError
    SchemaSecurityValidationRequestSchemaLanguage:
      type: string
      enum:
        - json
        - yaml
      description: The definition format.
      title: SchemaSecurityValidationRequestSchemaLanguage
    SchemaSecurityValidationRequestSchemaType:
      type: string
      enum:
        - openapi3
        - openapi2
      description: The definition type.
      title: SchemaSecurityValidationRequestSchemaType
    SchemaSecurityValidationRequestSchema:
      type: object
      properties:
        language:
          $ref: '#/components/schemas/SchemaSecurityValidationRequestSchemaLanguage'
          description: The definition format.
        schema:
          type: string
          description: The stringified API definition.
        type:
          $ref: '#/components/schemas/SchemaSecurityValidationRequestSchemaType'
          description: The definition type.
      required:
        - language
        - schema
        - type
      title: SchemaSecurityValidationRequestSchema
    schemaSecurityValidationRequest:
      type: object
      properties:
        schema:
          $ref: '#/components/schemas/SchemaSecurityValidationRequestSchema'
      title: schemaSecurityValidationRequest
    schemaSecurityValidationResponse:
      type: object
      properties:
        warnings:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: >
            Information about each issue discovered in the analysis. Each object includes the violation's severity and
            category, the location of the issue, data paths, and other information. This returns an empty object if
            there are no issues present in the schema.


            If there are issues, this returns the `possibleFixUrl` response in each warning object. This provides a link
            to documentation you can use to resolve the warning.
      title: schemaSecurityValidationResponse
    CommonErrorNameObjectNameMessageErrorName:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: CommonErrorNameObjectNameMessageErrorName
    CommonErrorNameObjectNameMessageError:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/CommonErrorNameObjectNameMessageErrorName'
      description: Information about the error.
      title: CommonErrorNameObjectNameMessageError
    commonErrorNameObjectNameMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameObjectNameMessageError'
          description: Information about the error.
      title: commonErrorNameObjectNameMessage
    SchemaSecurityValidationRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SchemaSecurityValidationRequestUnauthorizedError
    SchemaSecurityValidationRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SchemaSecurityValidationRequestForbiddenError
    SchemaSecurityValidationRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SchemaSecurityValidationRequestInternalServerError
    auditLogsUserIdQuery:
      type: integer
      title: auditLogsUserIdQuery
    auditLogsActionQuery:
      type: string
      title: auditLogsActionQuery
    sinceDateQuery:
      type: string
      format: date
      title: sinceDateQuery
    untilDateQuery:
      type: string
      format: date
      title: untilDateQuery
    auditLogsLimitQuery:
      type: integer
      maximum: 300
      title: auditLogsLimitQuery
    ascDescDefaultDesc:
      type: string
      enum:
        - asc
        - desc
      default: desc
      title: ascDescDefaultDesc
    auditLogActor:
      type: object
      properties:
        name:
          type: string
          description: The user's name.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        id:
          type: number
          format: double
          description: The user's ID.
        active:
          type: boolean
          description: If true, the user is active. If false, the user is deactivated.
      description: Information about the user who preformed the audit event.
      title: auditLogActor
    auditLogUser:
      type: object
      properties:
        name:
          type: string
          description: The user's name.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        id:
          type: number
          format: double
          description: The user's ID.
      description: Information about the user.
      title: auditLogUser
    auditLogTeam:
      type: object
      properties:
        name:
          type: string
          description: The team's name.
        id:
          type: number
          format: double
          description: The team's ID.
      description: The user's team information.
      title: auditLogTeam
    auditLogData:
      type: object
      properties:
        actor:
          $ref: '#/components/schemas/auditLogActor'
        user:
          $ref: '#/components/schemas/auditLogUser'
        team:
          $ref: '#/components/schemas/auditLogTeam'
        variables:
          type: object
          additionalProperties:
            description: Any type
          description: Additional information about the performed action.
      description: Information about the audit log.
      title: auditLogData
    auditLogEvent:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The audit event's ID.
        ip:
          type:
            - string
            - 'null'
          description: The IP address of the user that performed the action.
        userAgent:
          type:
            - string
            - 'null'
          description: The user agent information.
        action:
          type: string
          description: The action performed by the user.
        timestamp:
          type: string
          format: date-time
          description: The date and time at which the event occurred.
        message:
          type: string
          description: The audit event's description.
        data:
          $ref: '#/components/schemas/auditLogData'
      description: Information about the audit log event.
      title: auditLogEvent
    getAuditLogs:
      type: object
      properties:
        trails:
          type: array
          items:
            $ref: '#/components/schemas/auditLogEvent'
          description: A list of audit log events.
      title: getAuditLogs
    GetAuditLogsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuditLogsRequestUnauthorizedError
    GetAuditLogsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuditLogsRequestInternalServerError
    auditLogAction:
      type: object
      properties:
        code:
          type: string
          description: The audit log event action's code.
        name:
          type: string
          description: The audit log event action's display name as it appears in Postman's Audit Logs dashboard.
      description: Information about the audit log event action.
      title: auditLogAction
    getAuditLogEventActions:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/auditLogAction'
          description: A list of available audit log event actions.
      title: getAuditLogEventActions
    GetAuditLogEventActionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuditLogEventActionsRequestInternalServerError
    InvoicesAccountInfoSalesChannel:
      type: string
      enum:
        - SELF_SERVE
        - SALES_SERVE
      description: |
        The sales channel from which the account was created:
        - `SELF_SERVE` — The user purchased the account plan.
        - `SALES_SERVE` — The account was purchased through the Postman sales team process.
      title: InvoicesAccountInfoSalesChannel
    invoicesSlots:
      type: object
      properties:
        available:
          type: integer
          description: The number of the team's available slots.
        consumed:
          type: integer
          description: The number of currently-billed team members.
        total:
          type: integer
          description: The total number of slots available to the team.
        unbilled:
          type: integer
          description: >-
            The number of unbilled slots if [auto-flex billing](https://learning.postman.com/auto-flex-policy/) is
            available.
      description: Information about the team's slots.
      title: invoicesSlots
    invoicesAccountInfo:
      type: object
      properties:
        billingEmail:
          type: string
          format: email
          description: The email address to which invoices are sent.
        id:
          type: integer
          description: The account's ID.
        state:
          type: string
          description: |
            The account's current state:
            - `FREE`
            - `PAID`
            - `EXPIRED_TRIAL`
            - `OVERDUE`
            - `SUSPENDED`
            - `BLOCKED`
            - `PAYMENT_DISPUTED`
        teamId:
          type: integer
          description: The team's ID associated with the account.
        salesChannel:
          $ref: '#/components/schemas/InvoicesAccountInfoSalesChannel'
          description: |
            The sales channel from which the account was created:
            - `SELF_SERVE` — The user purchased the account plan.
            - `SALES_SERVE` — The account was purchased through the Postman sales team process.
        slots:
          $ref: '#/components/schemas/invoicesSlots'
      description: Information about the account.
      title: invoicesAccountInfo
    GetAccountsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountsRequestUnauthorizedError
    GetAccountsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountsRequestInternalServerError
    billingAccountId:
      type: string
      title: billingAccountId
    billingAccountStatus:
      type: string
      enum:
        - PAID
      title: billingAccountStatus
    invoicesTotal:
      type: object
      properties:
        value:
          type: integer
          description: The amount billed.
        currency:
          type: string
          description: The currency of the billed amount. Currently only supports the `USD` value.
      description: Information about the invoice's total billed amount.
      title: invoicesTotal
    InvoicesLinksWeb:
      type: object
      properties:
        href:
          type: string
          format: url
          description: A URL where you can download the invoice in PDF and view details.
      description: An object containing web-based account references.
      title: InvoicesLinksWeb
    invoicesLinks:
      type: object
      properties:
        web:
          $ref: '#/components/schemas/InvoicesLinksWeb'
          description: An object containing web-based account references.
      description: A [JSON API spec](https://jsonapi.org/format/#document-links) object containing hypermedia links.
      title: invoicesLinks
    invoiceData:
      type: object
      properties:
        id:
          type: string
          description: The invoice's ID.
        status:
          type: string
          description: The invoice's status.
        issuedAt:
          type: string
          format: date
          description: The date on which the invoice was issued.
        totalAmount:
          $ref: '#/components/schemas/invoicesTotal'
        links:
          $ref: '#/components/schemas/invoicesLinks'
      description: Information about the invoice.
      title: invoiceData
    getAccountInvoices:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/invoiceData'
          description: A list of account invoices.
      required:
        - data
      title: getAccountInvoices
    GetAccountInvoicesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountInvoicesRequestUnauthorizedError
    GetAccountInvoicesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAccountInvoicesRequestInternalServerError
    collectionUidQuery:
      type: string
      format: uid
      title: collectionUidQuery
    GetCollectionAccessKeysDataItemsStatus:
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      description: The token's active status.
      title: GetCollectionAccessKeysDataItemsStatus
    GetCollectionAccessKeysDataItems:
      type: object
      properties:
        id:
          type: string
          description: The collection access key's ID.
        token:
          type: string
          description: The masked collection access key.
        status:
          $ref: '#/components/schemas/GetCollectionAccessKeysDataItemsStatus'
          description: The token's active status.
        teamId:
          type: integer
          description: The team ID of the collection access key's owner.
        userId:
          type: integer
          description: The user ID of the collection access key's owner.
        collectionId:
          type: string
          format: uid
          description: The collection access key's associated collection ID.
        expiresAfter:
          type: string
          format: date-time
          description: >-
            The date and time at which the collection access key expires. Collection access keys are valid for 60 days.
            If unused, the access key expires after 60 days. If someone uses the access key, then its expiration date
            increases by another 60 days.
        lastUsedAt:
          type: string
          description: >-
            The date and time at which the collection access key was used. If the collection key is unused, this returns
            an empty string value.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection access key was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection access key was updated.
        deletedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: The date and time at which the collection access key was revoked.
      description: Information about the collection access key.
      title: GetCollectionAccessKeysDataItems
    GetCollectionAccessKeysMeta:
      type: object
      properties:
        nextCursor:
          type: string
          description: The pagination cursor that points to the next record in the results set.
        prevCursor:
          type: string
          description: The pagination cursor to previous set of response data.
      description: The response's non-standard metadata information.
      title: GetCollectionAccessKeysMeta
    getCollectionAccessKeys:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionAccessKeysDataItems'
          description: A list of collection access keys.
        meta:
          $ref: '#/components/schemas/GetCollectionAccessKeysMeta'
          description: The response's non-standard metadata information.
      title: getCollectionAccessKeys
    CommonErrorNameMessageDetailsErrorDetails:
      oneOf:
        - type: object
          additionalProperties:
            description: Any type
        - type: array
          items:
            type: string
      description: Information about the error.
      title: CommonErrorNameMessageDetailsErrorDetails
    CommonErrorNameMessageDetailsError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        details:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsErrorDetails'
          description: Information about the error.
      title: CommonErrorNameMessageDetailsError
    commonErrorNameMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/CommonErrorNameMessageDetailsError'
      title: commonErrorNameMessageDetails
    GetCollectionAccessKeysRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetCollectionAccessKeysRequestBadRequestError
    GetCollectionAccessKeysRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionAccessKeysRequestUnauthorizedError
    GetCollectionAccessKeysRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionAccessKeysRequestForbiddenError
    GetCollectionAccessKeysRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionAccessKeysRequestInternalServerError
    collectionAccessKeyId:
      type: string
      title: collectionAccessKeyId
    DeleteCollectionAccessKeyRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionAccessKeyRequestUnauthorizedError
    DeleteCollectionAccessKeyRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionAccessKeyRequestForbiddenError
    common404Error:
      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.
        title:
          type: string
          description: A short summary of the problem.
        status:
          type: integer
          description: The HTTP status code generated by the origin server.
        detail:
          type: string
          description: An explanation about the problem.
      title: common404Error
    DeleteCollectionAccessKeyRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionAccessKeyRequestInternalServerError
    collectionFolderUid:
      type: string
      format: uid
      title: collectionFolderUid
    collectionId:
      type: string
      title: collectionId
    createCollectionFolder:
      type: object
      properties:
        name:
          type: string
          description: >-
            The folder's name. It is recommended that you pass the `name` property in the request body. If you do not,
            the system uses a null value. As a result, this creates a folder with a blank name.
        folder:
          type: string
          format: uid
          description: The ID of a folder in which to create the folder.
      description: >
        Information about the collection folder. For a complete list of properties, refer to the [Postman Collection
        Format documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a folder with a blank name.
      title: createCollectionFolder
    CreateCollectionFolderResponseData:
      type: object
      properties:
        id:
          type: string
          description: The folder's ID.
        name:
          type: string
          description: The folder's name.
        order:
          type: array
          items:
            type: string
          description: A list of request IDs and their order in the created folder.
        owner:
          type: string
          description: The user ID of the folder's owner.
        folder:
          type:
            - string
            - 'null'
          description: Information about the folder.
        folders:
          type: array
          items:
            type: string
          description: A list of folders.
        requests:
          type: array
          items:
            type: string
          description: A list of requests.
        createdAt:
          type: string
          format: date-time
          description: The folder's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the folder was last updated.
        collection:
          type: string
          description: The collection ID that the folder belongs to.
        description:
          type: string
          description: The folder's description.
        folders_order:
          type: array
          items:
            type: string
          description: A list of folder IDs and their order in the collection.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the folder.
      description: >-
        Information about the collection folder. For a complete list of properties, refer to the [Postman Collection
        Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: CreateCollectionFolderResponseData
    createCollectionFolderResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateCollectionFolderResponseData'
          description: >-
            Information about the collection folder. For a complete list of properties, refer to the [Postman Collection
            Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The folder's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: createCollectionFolderResponse
    CreateCollectionFolderRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionFolderRequestInternalServerError
    collectionFolderId:
      type: string
      title: collectionFolderId
    request-method:
      type: string
      enum:
        - GET
        - PUT
        - POST
        - PATCH
        - DELETE
        - COPY
        - HEAD
        - OPTIONS
        - LINK
        - UNLINK
        - PURGE
        - LOCK
        - UNLOCK
        - PROPFIND
        - VIEW
      description: The request's HTTP method.
      title: request-method
    RequestHeaderDataItems:
      type: object
      properties:
        key:
          type: string
          description: The header's key.
        value:
          type: string
          description: The header's value.
        description:
          type: string
          description: The header's description.
      title: RequestHeaderDataItems
    request-header-data:
      type: array
      items:
        $ref: '#/components/schemas/RequestHeaderDataItems'
      description: The request's headers.
      title: request-header-data
    RequestQueryParamsItems:
      type: object
      properties:
        key:
          type: string
          description: The query parameter's key.
        value:
          type: string
          description: The query parameter's value.
        description:
          type: string
          description: The query parameter's description.
        enabled:
          type: boolean
          description: If true, the query parameter is enabled.
      title: RequestQueryParamsItems
    request-query-params:
      type: array
      items:
        $ref: '#/components/schemas/RequestQueryParamsItems'
      description: The request's query parameters.
      title: request-query-params
    CreateCollectionRequestDataMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - binary
        - graphql
      description: The request body's data mode.
      title: CreateCollectionRequestDataMode
    RequestDataItemsType:
      type: string
      enum:
        - text
        - file
      description: The form data's type.
      title: RequestDataItemsType
    RequestDataItems:
      type: object
      properties:
        key:
          type: string
          description: The form data's key.
        value:
          type: string
          description: The form data's value.
        description:
          type: string
          description: The form data's description.
        enabled:
          type: boolean
          description: If true, the form data entry is enabled.
        type:
          $ref: '#/components/schemas/RequestDataItemsType'
          description: The form data's type.
        uuid:
          type: string
          description: The form data entry's unique identifier.
      title: RequestDataItems
    request-data:
      type: array
      items:
        $ref: '#/components/schemas/RequestDataItems'
      description: The request body's form data.
      title: request-data
    request-graphql-mode-data:
      type: object
      properties:
        query:
          type: string
          description: The GraphQL query.
        variables:
          type: string
          description: The GraphQL query variables, in JSON format.
      description: The request body's GraphQL mode data.
      title: request-graphql-mode-data
    RequestDataOptionsRaw:
      type: object
      properties:
        language:
          type: string
          description: The raw mode data's language type.
      description: Options for the `raw` data mode.
      title: RequestDataOptionsRaw
    RequestDataOptionsUrlencoded:
      type: object
      properties: {}
      description: Options for the `urlencoded` data mode.
      title: RequestDataOptionsUrlencoded
    RequestDataOptionsParams:
      type: object
      properties: {}
      description: Options for the `params` data mode.
      title: RequestDataOptionsParams
    RequestDataOptionsBinary:
      type: object
      properties: {}
      description: Options for the `binary` data mode.
      title: RequestDataOptionsBinary
    RequestDataOptionsGraphql:
      type: object
      properties: {}
      description: Options for the `graphql` data mode.
      title: RequestDataOptionsGraphql
    request-data-options:
      type: object
      properties:
        raw:
          $ref: '#/components/schemas/RequestDataOptionsRaw'
          description: Options for the `raw` data mode.
        urlencoded:
          $ref: '#/components/schemas/RequestDataOptionsUrlencoded'
          description: Options for the `urlencoded` data mode.
        params:
          $ref: '#/components/schemas/RequestDataOptionsParams'
          description: Options for the `params` data mode.
        binary:
          $ref: '#/components/schemas/RequestDataOptionsBinary'
          description: Options for the `binary` data mode.
        graphql:
          $ref: '#/components/schemas/RequestDataOptionsGraphql'
          description: Options for the `graphql` data mode.
      description: Additional configurations and options set for the request body's various data modes.
      title: request-data-options
    RequestAuthType:
      type: string
      enum:
        - basic
        - bearer
        - apikey
        - digest
        - oauth1
        - oauth2
        - hawk
        - awsv4
        - ntlm
        - edgegrid
        - jwt
        - asap
        - noauth
      description: The authorization type.
      title: RequestAuthType
    AuthAttributeValueOneOf1Items:
      type: object
      properties: {}
      title: AuthAttributeValueOneOf1Items
    AuthAttributeValue1:
      type: array
      items:
        $ref: '#/components/schemas/AuthAttributeValueOneOf1Items'
      title: AuthAttributeValue1
    AuthAttributeValue:
      oneOf:
        - type: string
        - $ref: '#/components/schemas/AuthAttributeValue1'
      description: The key's value.
      title: AuthAttributeValue
    AuthAttributeType:
      type: string
      enum:
        - string
        - boolean
        - number
        - array
        - object
        - any
      description: The value's type.
      title: AuthAttributeType
    auth-attribute:
      type: object
      properties:
        key:
          type: string
          description: The auth method's key value.
        value:
          $ref: '#/components/schemas/AuthAttributeValue'
          description: The key's value.
        type:
          $ref: '#/components/schemas/AuthAttributeType'
          description: The value's type.
      required:
        - key
      description: >-
        Information about the supported Postman [authorization
        type](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
      title: auth-attribute
    request-auth:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/RequestAuthType'
          description: The authorization type.
        apikey:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The API key's authentication information.
        awsv4:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for AWS Signature authentication.
        basic:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for Basic Auth.
        bearer:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for Bearer Token authentication.
        digest:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for Digest access authentication.
        edgegrid:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for Akamai Edgegrid authentication.
        hawk:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for Hawk authentication.
        ntlm:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for NTLM authentication.
        oauth1:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for OAuth1 authentication.
        oauth2:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for OAuth2 authentication.
        jwt:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for JWT authentication.
        asap:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The attributes for ASAP authentication.
      required:
        - type
      description: The request's authentication information.
      title: request-auth
    RequestEventsItemsListen:
      type: string
      enum:
        - test
        - prerequest
      description: The event type.
      title: RequestEventsItemsListen
    script-2:
      type: object
      properties:
        id:
          type: string
          description: The script's ID.
        type:
          type: string
          description: The type of script. For example, `text/javascript`.
        exec:
          type: array
          items:
            type: string
          description: >-
            A list of script strings, where each line represents a line of code. Separate lines makes it easy to track
            script changes.
      description: Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
      title: script-2
    RequestEventsItems:
      type: object
      properties:
        listen:
          $ref: '#/components/schemas/RequestEventsItemsListen'
          description: The event type.
        script:
          $ref: '#/components/schemas/script-2'
      title: RequestEventsItems
    request-events:
      type: array
      items:
        $ref: '#/components/schemas/RequestEventsItems'
      description: A list of scripts configured to run when specific events occur.
      title: request-events
    createCollectionRequest:
      type: object
      properties:
        name:
          type: string
          description: >-
            The request's name. It is recommended that you pass the `name` property in the request body. If you do not,
            the system uses a null value. As a result, this creates a request with a blank name.
        description:
          type:
            - string
            - 'null'
          description: The request's description.
        method:
          $ref: '#/components/schemas/request-method'
        url:
          type:
            - string
            - 'null'
          description: The request's URL.
        headerData:
          $ref: '#/components/schemas/request-header-data'
        queryParams:
          $ref: '#/components/schemas/request-query-params'
        dataMode:
          $ref: '#/components/schemas/CreateCollectionRequestDataMode'
          description: The request body's data mode.
        data:
          $ref: '#/components/schemas/request-data'
        rawModeData:
          type:
            - string
            - 'null'
          description: The request body's raw mode data.
        graphqlModeData:
          $ref: '#/components/schemas/request-graphql-mode-data'
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        auth:
          $ref: '#/components/schemas/request-auth'
        events:
          $ref: '#/components/schemas/request-events'
      description: >
        Information about the request. For a complete list of properties, refer to the **Request** property in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a request with a blank name.
      title: createCollectionRequest
    CreateCollectionRequestResponseData:
      type: object
      properties:
        id:
          type: string
          description: The request's ID.
        name:
          type: string
          description: The request's name.
        owner:
          type: string
          description: The user ID of the request's owner.
        folder:
          type:
            - string
            - 'null'
          description: Information about the request's parent folder.
        responses:
          type: array
          items:
            type: string
          description: A list of the request's responses.
        collection:
          type: string
          description: The collection ID that the request belongs to.
        responses_order:
          type: array
          items:
            type: string
          description: A list of response IDs and their order in the folder.
        createdAt:
          type: string
          format: date-time
          description: The requeset's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the request was last updated.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the folder.
      description: >-
        Information about the created request. For a complete list of properties, refer to the **Request** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: CreateCollectionRequestResponseData
    createCollectionRequestResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateCollectionRequestResponseData'
          description: >-
            Information about the created request. For a complete list of properties, refer to the **Request** entry in
            the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The request's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: createCollectionRequestResponse
    CreateCollectionRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionRequestRequestInternalServerError
    collectionRequestId:
      type: string
      title: collectionRequestId
    header-2:
      type: object
      properties:
        key:
          type: string
          description: The header's key, such as `Content-Type` or `X-Custom-Header`.
        value:
          type: string
          description: The header key's value.
        description:
          type:
            - string
            - 'null'
          description: The header's description.
      required:
        - key
        - value
      description: Information about the header.
      title: header-2
    header-list-2:
      type: array
      items:
        $ref: '#/components/schemas/header-2'
      description: A list of headers.
      title: header-list-2
    CreateCollectionResponseDataMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - binary
        - graphql
      description: The associated request body's data mode.
      title: CreateCollectionResponseDataMode
    CreateCollectionResponseResponseCode:
      type: object
      properties:
        code:
          type: number
          format: double
          description: The response's HTTP response status code.
        name:
          type: string
          description: The name of the status code.
      description: The response's HTTP response code information.
      title: CreateCollectionResponseResponseCode
    createCollectionResponse:
      type: object
      properties:
        name:
          type: string
          description: >-
            The response's name. It is recommended that you pass the `name` property in the request body. If you do not,
            the system uses a null value. As a result, this creates a response with a blank name.
        description:
          type:
            - string
            - 'null'
          description: The response's description.
        url:
          type:
            - string
            - 'null'
          description: The associated request's URL.
        method:
          $ref: '#/components/schemas/request-method'
        headers:
          $ref: '#/components/schemas/header-list-2'
        dataMode:
          $ref: '#/components/schemas/CreateCollectionResponseDataMode'
          description: The associated request body's data mode.
        rawModeData:
          type:
            - string
            - 'null'
          description: The associated request body's raw mode data.
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        responseCode:
          $ref: '#/components/schemas/CreateCollectionResponseResponseCode'
          description: The response's HTTP response code information.
        status:
          type:
            - string
            - 'null'
          description: The response's HTTP status text.
        time:
          type: string
          description: The time taken by the request to complete, in milliseconds.
        cookies:
          type:
            - string
            - 'null'
          description: The response's cookie data.
        mime:
          type:
            - string
            - 'null'
          description: The response's MIME type.
        text:
          type: string
          description: The raw text of the response body.
        language:
          type: string
          description: The response body's language type.
        rawDataType:
          type:
            - string
            - 'null'
          description: The response's raw data type.
        requestObject:
          type: string
          description: A JSON-stringified representation of the associated request.
      description: >
        Information about the response. For a complete list of properties, refer to the **Response** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).


        **Note:**


        It is recommended that you pass the `name` property in the request body. If you do not, the system uses a null
        value. As a result, this creates a response with a blank name.
      title: createCollectionResponse
    CreateCollectionResponseResponseData:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        owner:
          type: string
          description: The user ID of the response's owner.
        request:
          type: string
          description: The request ID of the response's associated request.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the response was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the response was last updated.
        lastUpdatedBy:
          type: string
          description: The user ID of the user who last updated the response.
      description: >-
        Information about the response. For a complete list of properties, refer to the **Response** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: CreateCollectionResponseResponseData
    createCollectionResponseResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateCollectionResponseResponseData'
          description: >-
            Information about the response. For a complete list of properties, refer to the **Response** entry in the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The response's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: createCollectionResponseResponse
    CreateCollectionResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionResponseRequestInternalServerError
    booleanQuery:
      type: boolean
      title: booleanQuery
    GetCollectionFolderData:
      type: object
      properties:
        id:
          type: string
          description: The folder's ID.
        name:
          type: string
          description: The folder's name.
        description:
          type: string
          description: The folder's description.
        createdAt:
          type: string
          format: date-time
          description: The folder's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the folder was last updated.
        owner:
          type: string
          description: The user ID of the folder's owner.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the folder.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
        collection:
          type: string
          description: The collection ID that the folder belongs to.
      description: >-
        Information about the folder. For a complete list of properties, refer to the **Folders** entry in the [Postman
        Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionFolderData
    getCollectionFolder:
      type: object
      properties:
        model_id:
          type: string
          description: The folder's ID.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        data:
          $ref: '#/components/schemas/GetCollectionFolderData'
          description: >-
            Information about the folder. For a complete list of properties, refer to the **Folders** entry in the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: getCollectionFolder
    GetCollectionFolderRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionFolderRequestInternalServerError
    updateCollectionFolder:
      type: object
      properties:
        name:
          type: string
          description: The folder's name.
        description:
          type: string
          description: The folder's description.
      description: >-
        The folder properties to update. For a complete list of properties, refer to the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
      title: updateCollectionFolder
    UpdateCollectionFolderResponseData:
      type: object
      properties:
        id:
          type: string
          description: The folder's ID.
        name:
          type: string
          description: The folder's name.
        description:
          type: string
          description: The folder's description.
        createdAt:
          type: string
          format: date-time
          description: The folder's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the folder was last updated.
        owner:
          type: string
          description: The user ID of the folder's owner.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the folder.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
        collection:
          type: string
          description: The collection ID that the folder belongs to.
        folder:
          type:
            - string
            - 'null'
          description: Information about the folder.
      description: >-
        The folder's updated information, including the updated properties. For a complete list of properties, refer to
        the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
      title: UpdateCollectionFolderResponseData
    updateCollectionFolderResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionFolderResponseData'
          description: >-
            The folder's updated information, including the updated properties. For a complete list of properties, refer
            to the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The folder's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: updateCollectionFolderResponse
    UpdateCollectionFolderRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionFolderRequestInternalServerError
    DeleteCollectionFolderData:
      type: object
      properties:
        id:
          type: string
          description: The folder's ID.
        owner:
          type: string
          description: The user ID of the folder's owner.
      description: The folder's information.
      title: DeleteCollectionFolderData
    deleteCollectionFolder:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DeleteCollectionFolderData'
          description: The folder's information.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The folder's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: deleteCollectionFolder
    DeleteCollectionFolderRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionFolderRequestInternalServerError
    GetCollectionRequestData:
      type: object
      properties:
        id:
          type: string
          description: The request's ID.
        name:
          type: string
          description: The request's name.
        owner:
          type: string
          description: The user ID of the request's owner.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the request.
        createdAt:
          type: string
          format: date-time
          description: The request's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the request was last updated.
      description: >-
        Information about the request. For a complete list of properties, refer to the **Request** entry in the [Postman
        Collection Format documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionRequestData
    getCollectionRequest:
      type: object
      properties:
        model_id:
          type: string
          description: The request's ID.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        data:
          $ref: '#/components/schemas/GetCollectionRequestData'
          description: >-
            Information about the request. For a complete list of properties, refer to the **Request** entry in the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: getCollectionRequest
    GetCollectionRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRequestRequestInternalServerError
    UpdateCollectionRequestDataMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - binary
        - graphql
      description: The request body's data mode.
      title: UpdateCollectionRequestDataMode
    updateCollectionRequest:
      type: object
      properties:
        name:
          type: string
          description: The request's name.
        description:
          type:
            - string
            - 'null'
          description: The request's description.
        method:
          $ref: '#/components/schemas/request-method'
        url:
          type:
            - string
            - 'null'
          description: The request's URL.
        headerData:
          $ref: '#/components/schemas/request-header-data'
        queryParams:
          $ref: '#/components/schemas/request-query-params'
        dataMode:
          $ref: '#/components/schemas/UpdateCollectionRequestDataMode'
          description: The request body's data mode.
        data:
          $ref: '#/components/schemas/request-data'
        rawModeData:
          type:
            - string
            - 'null'
          description: The request body's raw mode data.
        graphqlModeData:
          $ref: '#/components/schemas/request-graphql-mode-data'
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        auth:
          $ref: '#/components/schemas/request-auth'
        events:
          $ref: '#/components/schemas/request-events'
      description: >-
        The request properties to update. For a complete list of properties, refer to the **Request** property in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
      title: updateCollectionRequest
    UpdateCollectionRequestResponseData:
      type: object
      properties:
        id:
          type: string
          description: The request's ID.
        name:
          type: string
          description: The request's name.
        description:
          type: string
          description: The request's description.
        createdAt:
          type: string
          format: date-time
          description: The request's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the request was last updated.
        owner:
          type: string
          description: The user ID of the request's owner.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the request.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      description: >-
        Information about the updated request. For a complete list of properties, refer to the **Request** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: UpdateCollectionRequestResponseData
    updateCollectionRequestResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionRequestResponseData'
          description: >-
            Information about the updated request. For a complete list of properties, refer to the **Request** entry in
            the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The request's ID.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: updateCollectionRequestResponse
    UpdateCollectionRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionRequestRequestInternalServerError
    DeleteCollectionRequestData:
      type: object
      properties:
        id:
          type: string
          description: The request's ID.
        owner:
          type: string
          description: The user ID of the request's owner.
      description: The request's information.
      title: DeleteCollectionRequestData
    deleteCollectionRequest:
      type: object
      properties:
        model_id:
          type: string
          description: The request's ID.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        data:
          $ref: '#/components/schemas/DeleteCollectionRequestData'
          description: The request's information.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: deleteCollectionRequest
    DeleteCollectionRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionRequestRequestInternalServerError
    collectionResponseId:
      type: string
      title: collectionResponseId
    GetCollectionResponseData:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        request:
          type: string
          description: The ID of the request that the response belongs to.
        name:
          type: string
          description: The response's name.
        owner:
          type: string
          description: The user ID of the response's owner.
        createdAt:
          type: string
          format: date-time
          description: The response's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the response was last updated.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the response.
      description: >-
        Information about the response. For a complete list of properties, refer to the **Response** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionResponseData
    getCollectionResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetCollectionResponseData'
          description: >-
            Information about the response. For a complete list of properties, refer to the **Response** entry in the
            [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The response's ID.
      title: getCollectionResponse
    GetCollectionResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionResponseRequestInternalServerError
    UpdateCollectionResponseDataMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - binary
        - graphql
      description: The associated request body's data mode.
      title: UpdateCollectionResponseDataMode
    UpdateCollectionResponseResponseCode:
      type: object
      properties:
        code:
          type: number
          format: double
          description: The response's HTTP response status code.
        name:
          type: string
          description: The name of the status code.
      description: The response's HTTP response code information.
      title: UpdateCollectionResponseResponseCode
    updateCollectionResponse:
      type: object
      properties:
        name:
          type: string
          description: The response's name.
        description:
          type:
            - string
            - 'null'
          description: The response's description.
        url:
          type:
            - string
            - 'null'
          description: The associated request's URL.
        method:
          $ref: '#/components/schemas/request-method'
        headers:
          $ref: '#/components/schemas/header-list-2'
        dataMode:
          $ref: '#/components/schemas/UpdateCollectionResponseDataMode'
          description: The associated request body's data mode.
        rawModeData:
          type:
            - string
            - 'null'
          description: The associated request body's raw mode data.
        dataOptions:
          $ref: '#/components/schemas/request-data-options'
        responseCode:
          $ref: '#/components/schemas/UpdateCollectionResponseResponseCode'
          description: The response's HTTP response code information.
        status:
          type:
            - string
            - 'null'
          description: The response's HTTP status text.
        time:
          type: string
          description: The time taken by the request to complete, in milliseconds.
        cookies:
          type:
            - string
            - 'null'
          description: The response's cookie data.
        mime:
          type:
            - string
            - 'null'
          description: The response's MIME type.
        text:
          type: string
          description: The raw text of the response body.
        language:
          type: string
          description: The response body's language type.
        rawDataType:
          type:
            - string
            - 'null'
          description: The response's raw data type.
        requestObject:
          type: string
          description: A JSON-stringified representation of the associated request.
      description: >-
        The response properties to update. For a complete list of properties, refer to the **Response** entry in the
        [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json).
      title: updateCollectionResponse
    UpdateCollectionResponseResponseData:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        name:
          type: string
          description: The response's name.
        owner:
          type: string
          description: The user ID of the response's owner.
        createdAt:
          type: string
          format: date-time
          description: The response's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the response was last updated.
        lastRevision:
          type: integer
          format: int64
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
        lastUpdatedBy:
          type: string
          description: The user ID of the user that last updated the response.
      description: >-
        Information about the updated response. For a complete list of response properties, refer to the **Response**
        entry in the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: UpdateCollectionResponseResponseData
    updateCollectionResponseResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/UpdateCollectionResponseResponseData'
          description: >-
            Information about the updated response. For a complete list of response properties, refer to the
            **Response** entry in the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        model_id:
          type: string
          description: The response's ID.
      title: updateCollectionResponseResponse
    UpdateCollectionResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionResponseRequestInternalServerError
    DeleteCollectionResponseData:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        owner:
          type: string
          description: The user ID of the request's owner.
      description: The response's information.
      title: DeleteCollectionResponseData
    deleteCollectionResponse:
      type: object
      properties:
        model_id:
          type: string
          description: The response's ID.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: A Postman-specific response that contains information about the internal performed operation.
        data:
          $ref: '#/components/schemas/DeleteCollectionResponseData'
          description: The response's information.
        revision:
          type: number
          format: double
          description: >-
            An internal revision ID. Its value increments each time the resource changes. You can use this ID to track
            whether there were changes since the last time you fetched the resource.
      title: deleteCollectionResponse
    DeleteCollectionResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionResponseRequestInternalServerError
    collectionRequestUid:
      type: string
      format: uid
      title: collectionRequestUid
    collectionResponseUid:
      type: string
      format: uid
      title: collectionResponseUid
    AsyncCollectionForkMergeStrategy:
      type: string
      enum:
        - default
        - updateSourceWithDestination
        - deleteSource
      description: >
        The fork's merge strategy:

        - `default` — Make no changes to the fork. You must have **Editor** access to the destination collection.

        - `updateSourceWithDestination` — Merge changes and apply any differences in the destination collection to the
        source. You must have **Editor** access to both the source and destination collection.

        - `deleteSource` — Merge the changes and delete the fork. You must have **Editor** access to both the source and
        destination collection.
      title: AsyncCollectionForkMergeStrategy
    asyncCollectionForkMerge:
      type: object
      properties:
        strategy:
          $ref: '#/components/schemas/AsyncCollectionForkMergeStrategy'
          description: >
            The fork's merge strategy:

            - `default` — Make no changes to the fork. You must have **Editor** access to the destination collection.

            - `updateSourceWithDestination` — Merge changes and apply any differences in the destination collection to
            the source. You must have **Editor** access to both the source and destination collection.

            - `deleteSource` — Merge the changes and delete the fork. You must have **Editor** access to both the source
            and destination collection.
        source:
          type: string
          format: uid
          description: The source collection's unique ID.
        destination:
          type: string
          format: uid
          description: The destination collection's unique ID.
      required:
        - strategy
        - source
        - destination
      title: asyncCollectionForkMerge
    AsyncMergeCollectionForkTask:
      type: object
      properties:
        id:
          type: string
          description: The task's ID.
        status:
          type: string
          description: The task's status.
      description: Information about the merge task.
      title: AsyncMergeCollectionForkTask
    asyncMergeCollectionFork:
      type: object
      properties:
        task:
          $ref: '#/components/schemas/AsyncMergeCollectionForkTask'
          description: Information about the merge task.
      title: asyncMergeCollectionFork
    AsyncMergePullCollectionForkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AsyncMergePullCollectionForkRequestUnauthorizedError
    AsyncMergePullCollectionForkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AsyncMergePullCollectionForkRequestInternalServerError
    collectionForkTaskId:
      type: string
      title: collectionForkTaskId
    AsyncMergePullCollectionTaskStatusStatus:
      type: string
      enum:
        - successful
        - in-progress
        - failed
      description: The task's current status.
      title: AsyncMergePullCollectionTaskStatusStatus
    AsyncMergePullCollectionTaskStatusDetailsError:
      type: object
      properties:
        message:
          type: string
          description: The error message.
      title: AsyncMergePullCollectionTaskStatusDetailsError
    AsyncMergePullCollectionTaskStatusDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/AsyncMergePullCollectionTaskStatusDetailsError'
      description: If the task failed, an object containing information about the error.
      title: AsyncMergePullCollectionTaskStatusDetails
    asyncMergePullCollectionTaskStatus:
      type: object
      properties:
        id:
          type: string
          description: The task's ID.
        status:
          $ref: '#/components/schemas/AsyncMergePullCollectionTaskStatusStatus'
          description: The task's current status.
        details:
          $ref: '#/components/schemas/AsyncMergePullCollectionTaskStatusDetails'
          description: If the task failed, an object containing information about the error.
      title: asyncMergePullCollectionTaskStatus
    AsyncMergePullCollectionTaskStatusRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AsyncMergePullCollectionTaskStatusRequestUnauthorizedError
    AsyncMergePullCollectionTaskStatusRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AsyncMergePullCollectionTaskStatusRequestInternalServerError
    collectionNameQuery:
      type: string
      title: collectionNameQuery
    limitNoDefault:
      type: integer
      title: limitNoDefault
    offsetNoDefault:
      type: integer
      title: offsetNoDefault
    GetCollectionsCollectionsItemsFork:
      type: object
      properties:
        label:
          type: string
          description: The fork's label.
        createdAt:
          type: string
          format: date-time
          description: The fork's creation date and time.
        from:
          type: string
          description: The unique ID of the fork's source collection.
      description: >-
        If the collection is
        [forked](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities),
        the fork's information.
      title: GetCollectionsCollectionsItemsFork
    GetCollectionsCollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        owner:
          type: string
          description: The owner of the collection.
        createdAt:
          type: string
          format: date-time
          description: The collection's creation date and time.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection was last updated.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
        fork:
          $ref: '#/components/schemas/GetCollectionsCollectionsItemsFork'
          description: >-
            If the collection is
            [forked](https://learning.postman.com/docs/collaborating-in-postman/version-control/#forking-postman-entities),
            the fork's information.
        isPublic:
          type: boolean
          description: If true, the collection is public and visible to all users.
      description: Information about the collection.
      title: GetCollectionsCollectionsItems
    metaLimitOffsetTotal:
      type: object
      properties:
        total:
          type: number
          format: double
          description: The number of records found.
        offset:
          type: number
          format: double
          description: The zero-based offset of the first item returned.
        limit:
          type: number
          format: double
          description: The maximum number of records in the paginated response.
      description: The response's meta information for paginated results.
      title: metaLimitOffsetTotal
    getCollections:
      type: object
      properties:
        collections:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionsCollectionsItems'
        meta:
          $ref: '#/components/schemas/metaLimitOffsetTotal'
      title: getCollections
    GetCollectionsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionsRequestUnauthorizedError
    GetCollectionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionsRequestInternalServerError
    InfoSchema:
      type: string
      enum:
        - https://schema.postman.com/json/collection/v2.1.0/collection.json
      description: The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
      title: InfoSchema
    info:
      type: object
      properties:
        name:
          type: string
          description: The collection's name.
        description:
          type: string
          description: The collection's description.
        schema:
          $ref: '#/components/schemas/InfoSchema'
          description: >-
            The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0
            schema.
      required:
        - name
        - schema
      description: Information about the collection.
      title: info
    VariableValue:
      oneOf:
        - type: string
        - type: boolean
        - type: integer
      description: The key's value.
      title: VariableValue
    variable:
      type: object
      properties:
        key:
          type: string
          description: The variable's key (name).
        value:
          $ref: '#/components/schemas/VariableValue'
          description: The key's value.
        description:
          type: string
          maxLength: 512
          description: The variable's description.
        disabled:
          type: boolean
          default: false
          description: If true, the variable is not enabled. Doesn't apply to path parameter variables.
      description: Information about the variable.
      title: variable
    variable-list:
      type: array
      items:
        $ref: '#/components/schemas/variable'
      description: >-
        A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/).
        Make certain not to include sensitive information in variables.
      title: variable-list
    EventListen:
      type: string
      enum:
        - test
        - prerequest
      description: Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.
      title: EventListen
    script:
      type: object
      properties:
        type:
          type: string
          description: The type of script. For example, `text/javascript`.
        exec:
          type: array
          items:
            type: string
          description: >-
            A list of script strings, where each line represents a line of code. Separate lines makes it easy to track
            script changes.
      description: Information about the Javascript code that can be used to to perform setup or teardown operations in a response.
      title: script
    event:
      type: object
      properties:
        listen:
          $ref: '#/components/schemas/EventListen'
          description: Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.
        script:
          $ref: '#/components/schemas/script'
      required:
        - listen
      description: Information about the collection's events.
      title: event
    event-list:
      type: array
      items:
        $ref: '#/components/schemas/event'
      description: A list of scripts configured to run when specific events occur.
      title: event-list
    UrlOneOf1QueryItems:
      type: object
      properties:
        key:
          type:
            - string
            - 'null'
          description: The query parameter's key.
        value:
          type:
            - string
            - 'null'
          description: The key's value.
        disabled:
          type: boolean
          default: false
          description: If true, the query parameter isn't sent with the request.
        description:
          type:
            - string
            - 'null'
          description: The query parameter's description.
      title: UrlOneOf1QueryItems
    Url1:
      type: object
      properties:
        raw:
          type: string
          description: The request's raw URL.
        protocol:
          type: string
          description: The request protocol.
        host:
          type: array
          items:
            type: string
          description: The host's URL.
        path:
          type: array
          items:
            type: string
          description: A list of the URL's path components.
        port:
          type: string
          description: The URL's port number. An empty value indicates port `80` (http) or `443` (https).
        query:
          type: array
          items:
            $ref: '#/components/schemas/UrlOneOf1QueryItems'
          description: A list of query parameters. These are the query string parts of the URL, parsed as separate variables.
      title: Url1
    url:
      oneOf:
        - type: string
          format: url
        - $ref: '#/components/schemas/Url1'
      description: Information about the URL.
      title: url
    AuthType:
      type: string
      enum:
        - noauth
        - basic
        - bearer
        - apikey
        - digest
        - oauth1
        - oauth2
        - hawk
        - awsv4
        - ntlm
        - edgegrid
      description: The authorization type.
      title: AuthType
    auth:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/AuthType'
          description: The authorization type.
        noauth:
          description: Any type
        apikey:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The API key's authentication information.
        awsv4:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [AWS
            Signature](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/) authentication.
        basic:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Basic
            Auth](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#basic-auth).
        bearer:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Bearer
            Token](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token)
            authentication.
        digest:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Digest](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/)
            access authentication.
        edgegrid:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Akamai
            Edgegrid](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/) authentication.
        hawk:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for
            [Hawk](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/)
            authentication.
        ntlm:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for
            [NTLM](https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/)
            authentication.
        oauth1:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [OAuth1](https://learning.postman.com/docs/sending-requests/authorization/oauth-10/)
            authentication.
        oauth2:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [OAuth2](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/)
            authentication.
      required:
        - type
      description: >-
        The [authorization type supported by
        Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
      title: auth
    header:
      type: object
      properties:
        key:
          type: string
          description: The header's key, such as `Content-Type` or `X-Custom-Header`.
        value:
          type: string
          description: The header key's value.
        disabled:
          type: boolean
          default: false
          description: If true, the current header isn't sent with requests.
        description:
          type:
            - string
            - 'null'
          description: The header's description.
      required:
        - key
        - value
      description: Information about the header.
      title: header
    header-list:
      type: array
      items:
        $ref: '#/components/schemas/header'
      description: A list of headers.
      title: header-list
    RequestBodyMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - file
        - graphql
      description: The data associated with the request.
      title: RequestBodyMode
    RequestBodyUrlencodedItems:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        value:
          type: string
          description: The key's value.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      required:
        - key
      title: RequestBodyUrlencodedItems
    RequestBodyFormdataItemsOneOf0Type:
      type: string
      enum:
        - text
      description: The `text` value.
      title: RequestBodyFormdataItemsOneOf0Type
    RequestBodyFormdataItems0:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        value:
          type: string
          description: The key's value.
        type:
          $ref: '#/components/schemas/RequestBodyFormdataItemsOneOf0Type'
          description: The `text` value.
        contentType:
          type: string
          description: The form-data Content-Type header.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      title: RequestBodyFormdataItems0
    RequestBodyFormdataItemsOneOf1Src:
      oneOf:
        - type: string
        - type: array
          items:
            type: string
      title: RequestBodyFormdataItemsOneOf1Src
    RequestBodyFormdataItemsOneOf1Type:
      type: string
      enum:
        - file
      description: The `file` value.
      title: RequestBodyFormdataItemsOneOf1Type
    RequestBodyFormdataItems1:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        src:
          $ref: '#/components/schemas/RequestBodyFormdataItemsOneOf1Src'
        type:
          $ref: '#/components/schemas/RequestBodyFormdataItemsOneOf1Type'
          description: The `file` value.
        contentType:
          type: string
          description: The form-data Content-Type header.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      title: RequestBodyFormdataItems1
    RequestBodyFormdataItems:
      oneOf:
        - $ref: '#/components/schemas/RequestBodyFormdataItems0'
        - $ref: '#/components/schemas/RequestBodyFormdataItems1'
      title: RequestBodyFormdataItems
    RequestBodyFile:
      type: object
      properties:
        src:
          type:
            - string
            - 'null'
          description: >-
            The name of the file to upload (not its path). A null value indicates that no file is selected as a part of
            the request body.
      description: If the `mode` value is `file`, an object containing the file request information.
      title: RequestBodyFile
    RequestBodyGraphql:
      type: object
      properties:
        query:
          type: string
          description: The GraphQL query.
        variables:
          type:
            - string
            - 'null'
          description: The GraphQL query variables, in JSON format.
      description: If the `mode` value is `graphql`, an object containing the GraphQL request information.
      title: RequestBodyGraphql
    RequestBodyOptions:
      type: object
      properties: {}
      description: Additional configurations and options set for various modes.
      title: RequestBodyOptions
    RequestBody:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/RequestBodyMode'
          description: The data associated with the request.
        raw:
          type: string
          description: If the `mode` value is `raw`, the raw content of the request body.
        urlencoded:
          type: array
          items:
            $ref: '#/components/schemas/RequestBodyUrlencodedItems'
          description: A list of x-www-form-encoded key/value pairs.
        formdata:
          type: array
          items:
            $ref: '#/components/schemas/RequestBodyFormdataItems'
          description: If the `mode` value is `formdata`, then a list of form-data key/pair values.
        file:
          $ref: '#/components/schemas/RequestBodyFile'
          description: If the `mode` value is `file`, an object containing the file request information.
        graphql:
          $ref: '#/components/schemas/RequestBodyGraphql'
          description: If the `mode` value is `graphql`, an object containing the GraphQL request information.
        options:
          $ref: '#/components/schemas/RequestBodyOptions'
          description: Additional configurations and options set for various modes.
      description: Information about the collection's request body. To set this to "none", pass an empty object.
      title: RequestBody
    request:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/url'
        auth:
          $ref: '#/components/schemas/auth'
        method:
          type: string
          description: The request's standard HTTP method.
        description:
          type:
            - string
            - 'null'
          description: The request's description.
        header:
          $ref: '#/components/schemas/header-list'
        body:
          $ref: '#/components/schemas/RequestBody'
          description: Information about the collection's request body. To set this to "none", pass an empty object.
      description: Information about the collection request.
      title: request
    ResponseHeader1:
      type: array
      items:
        $ref: '#/components/schemas/header'
      description: A list of the request's headers.
      title: ResponseHeader1
    ResponseHeader:
      oneOf:
        - type: string
        - $ref: '#/components/schemas/ResponseHeader1'
      title: ResponseHeader
    response:
      type: object
      properties:
        originalRequest:
          $ref: '#/components/schemas/request'
        responseTime:
          type:
            - number
            - 'null'
          format: double
          description: >-
            The time taken by the request to complete. If a number, the unit is milliseconds. If the response is
            manually created, this can be set as null.
        header:
          $ref: '#/components/schemas/ResponseHeader'
        body:
          type:
            - string
            - 'null'
          description: The raw text of the response.
        status:
          type: string
          description: The response's status.
        code:
          type: integer
          description: The response status code.
      description: Information about the request's response.
      title: response
    ProtocolProfileBehaviorDisabledSystemHeaders:
      type: object
      properties:
        cache-control:
          type: boolean
        postman-token:
          type: boolean
        content-type:
          type: boolean
        content-length:
          type: boolean
        accept-encoding:
          type: boolean
        connection:
          type: boolean
        host:
          type: boolean
      description: Disable the system headers which are added implicitly.
      title: ProtocolProfileBehaviorDisabledSystemHeaders
    ProtocolProfileBehaviorProtocolVersion:
      type: string
      enum:
        - http1
        - http2
        - auto
      description: The HTTP protocol version to use. Supports the `http1`, `http2`, and `auto` values.
      title: ProtocolProfileBehaviorProtocolVersion
    protocol-profile-behavior:
      type: object
      properties:
        strictSSL:
          type: boolean
          description: If true, enables certificate verification.
        followRedirects:
          type: boolean
          description: If true, follow HTTP 3xx responses as redirects.
        maxRedirects:
          type: number
          format: double
          description: The maximum number of redirects to follow.
        disableBodyPruning:
          type: boolean
          description: If true, disables request body pruning for the GET, COPY, HEAD, PURGE, and UNLOCK methods.
        disableUrlEncoding:
          type: boolean
          description: If true, disables the percent encoding of auth, path, query, and fragment URL segments.
        disabledSystemHeaders:
          $ref: '#/components/schemas/ProtocolProfileBehaviorDisabledSystemHeaders'
          description: Disable the system headers which are added implicitly.
        insecureHTTPParser:
          type: boolean
          description: If true, uses an insecure HTTP parser that accepts invalid HTTP headers.
        followOriginalHttpMethod:
          type: boolean
          description: If true, redirects with the original HTTP method. Redirects with the GET HTTP method by default.
        followAuthorizationHeader:
          type: boolean
          description: If true, retains the `authorization` header when a redirect happens to a different hostname.
        protocolVersion:
          $ref: '#/components/schemas/ProtocolProfileBehaviorProtocolVersion'
          description: The HTTP protocol version to use. Supports the `http1`, `http2`, and `auto` values.
        removeRefererHeaderOnRedirect:
          type: boolean
          description: If true, removes the `referer` header when a redirect happens.
        tlsPreferServerCiphers:
          type: boolean
          description: If true, uses the server's cipher suite order instead of the client's during negotiation.
        tlsDisabledProtocols:
          type: array
          items:
            type: string
          description: The SSL and TLS protocol versions to disable during negotiation.
        tlsCipherSelection:
          type: array
          items:
            type: string
          description: The order of cipher suites that the SSL server profile uses to establish a secure connection.
      description: >-
        The [settings](https://learning.postman.com/docs/sending-requests/create-requests/request-settings/) used to
        alter the [Protocol Profile
        Behavior](https://github.com/postmanlabs/postman-runtime/blob/develop/docs/protocol-profile-behavior.md) of
        sending a request.
      title: protocol-profile-behavior
    item:
      type: object
      properties:
        name:
          type: string
          description: The item's name.
        description:
          type:
            - string
            - 'null'
          description: The item's description.
        variable:
          $ref: '#/components/schemas/variable-list'
        event:
          $ref: '#/components/schemas/event-list'
        request:
          $ref: '#/components/schemas/request'
        response:
          type: array
          items:
            $ref: '#/components/schemas/response'
          description: A list of the collection's responses.
        protocolProfileBehavior:
          $ref: '#/components/schemas/protocol-profile-behavior'
      description: Information about the collection request or folder.
      title: item
    createCollectionSchema:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/info'
        item:
          type: array
          items:
            $ref: '#/components/schemas/item'
        event:
          $ref: '#/components/schemas/event-list'
        variable:
          $ref: '#/components/schemas/variable-list'
        auth:
          $ref: '#/components/schemas/auth'
        protocolProfileBehavior:
          $ref: '#/components/schemas/protocol-profile-behavior'
      required:
        - info
        - item
      title: createCollectionSchema
    createCollection:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/createCollectionSchema'
      title: createCollection
    CollectionCreatedCollection:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
      title: CollectionCreatedCollection
    collectionCreated:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/CollectionCreatedCollection'
      title: collectionCreated
    CreateCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionRequestUnauthorizedError
    CreateCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionRequestInternalServerError
    ascDesc:
      type: string
      enum:
        - asc
        - desc
      title: ascDesc
    GetCollectionsForkedByUserDataItems:
      type: object
      properties:
        forkName:
          type: string
          description: The forked collection's label.
        forkId:
          type: string
          format: uid
          description: The forked collection's ID.
        sourceId:
          type: string
          description: The ID of the forked collection's source collection.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the fork was created.
      description: Information about the forked collection.
      title: GetCollectionsForkedByUserDataItems
    GetCollectionsForkedByUserMeta:
      type: object
      properties:
        total:
          type: number
          format: double
          description: The total number of forked collections.
        nextCursor:
          type:
            - string
            - 'null'
          format: base64
          description: The pagination cursor that points to the next record in the results set.
        inaccessibleFork:
          type: number
          format: double
          description: The total number of forked collections that the user cannot access.
      description: The response's meta information for paginated results.
      title: GetCollectionsForkedByUserMeta
    getCollectionsForkedByUser:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionsForkedByUserDataItems'
          description: A list of the user's forked collections.
        meta:
          $ref: '#/components/schemas/GetCollectionsForkedByUserMeta'
          description: The response's meta information for paginated results.
      title: getCollectionsForkedByUser
    Fork400ErrorNoUserFoundError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: Fork400ErrorNoUserFoundError
    fork400ErrorNoUserFound:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Fork400ErrorNoUserFoundError'
      title: fork400ErrorNoUserFound
    GetCollectionsForkedByUserRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionsForkedByUserRequestUnauthorizedError
    GetCollectionsForkedByUserRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionsForkedByUserRequestInternalServerError
    createCollectionFork:
      type: object
      properties:
        label:
          type: string
          description: The fork's label.
      required:
        - label
      title: createCollectionFork
    CreateCollectionForkResponseCollectionFork:
      type: object
      properties:
        label:
          type: string
          description: The fork's label.
        createdAt:
          type: string
          format: date-time
          description: The fork's creation date and time.
        from:
          type: string
          format: uid
          description: The unique ID of fork's source collection.
      description: Information about the collection's fork.
      title: CreateCollectionForkResponseCollectionFork
    CreateCollectionForkResponseCollection:
      type: object
      properties:
        id:
          type: string
          description: The forked collection's ID.
        name:
          type: string
          description: The collection's name.
        fork:
          $ref: '#/components/schemas/CreateCollectionForkResponseCollectionFork'
          description: Information about the collection's fork.
        uid:
          type: string
          format: uid
          description: The forked collection's unique ID.
      description: Information about the forked collection.
      title: CreateCollectionForkResponseCollection
    createCollectionForkResponse:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/CreateCollectionForkResponseCollection'
          description: Information about the forked collection.
      title: createCollectionForkResponse
    CreateCollectionForkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionForkRequestUnauthorizedError
    CreateCollectionForkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionForkRequestInternalServerError
    MergeCollectionForkStrategy:
      type: string
      enum:
        - deleteSource
        - updateSourceWithDestination
      default: updateSourceWithDestination
      description: >
        The fork's merge strategy:

        - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete, Postman
        deletes the fork. You must have Editor access to both the parent and forked collections.

        - `updateSourceWithDestination` — Merge the changes into the parent collection. Any differences in the parent
        collection are also made to the fork.
      title: MergeCollectionForkStrategy
    mergeCollectionFork:
      type: object
      properties:
        destination:
          type: string
          format: uid
          description: The destination (parent) collection's unique ID.
        source:
          type: string
          format: uid
          description: The source collection's unique ID.
        strategy:
          $ref: '#/components/schemas/MergeCollectionForkStrategy'
          default: updateSourceWithDestination
          description: >
            The fork's merge strategy:

            - `deleteSource` — Merge the changes into the parent collection. After the merge process is complete,
            Postman deletes the fork. You must have Editor access to both the parent and forked collections.

            - `updateSourceWithDestination` — Merge the changes into the parent collection. Any differences in the
            parent collection are also made to the fork.
      required:
        - destination
        - source
      title: mergeCollectionFork
    MergeCollectionForkResponseCollection:
      type: object
      properties:
        id:
          type: string
          description: The source collection's ID.
        uid:
          type: string
          format: uid
          description: The source collection's unique ID.
      title: MergeCollectionForkResponseCollection
    mergeCollectionForkResponse:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/MergeCollectionForkResponseCollection'
      title: mergeCollectionForkResponse
    MergeCollectionForkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MergeCollectionForkRequestUnauthorizedError
    MergeCollectionForkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MergeCollectionForkRequestForbiddenError
    MergeCollectionForkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MergeCollectionForkRequestInternalServerError
    collectionAccessKeyQuery:
      type: string
      title: collectionAccessKeyQuery
    collectionModelQuery:
      type: string
      enum:
        - minimal
      title: collectionModelQuery
    GetCollectionCollectionInfoFork:
      type: object
      properties:
        label:
          type: string
          description: The fork's label.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection was forked.
        from:
          type: string
          format: uid
          description: The source (parent) collection's unique ID.
      description: If the collection was forked from another collection, this object contains information about the fork.
      title: GetCollectionCollectionInfoFork
    GetCollectionCollectionInfo:
      type: object
      properties:
        _postman_id:
          type: string
          description: The collection's Postman ID.
        name:
          type: string
          description: The collection's name.
        description:
          type: string
          description: The collection's description.
        schema:
          type: string
          format: url
          description: A URL to the collection's schema.
        fork:
          $ref: '#/components/schemas/GetCollectionCollectionInfoFork'
          description: If the collection was forked from another collection, this object contains information about the fork.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection was last updated.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection was created.
        lastUpdatedBy:
          type: string
          description: The user ID of the user who last updated the collection.
      description: Information about the collection.
      title: GetCollectionCollectionInfo
    Variable2Value:
      oneOf:
        - type: string
        - type: boolean
        - type: integer
      description: The key's value.
      title: Variable2Value
    variable-2:
      type: object
      properties:
        id:
          type: string
          description: The variable's ID. Doesn't apply to collection-level variables.
        key:
          type: string
          description: The variable's key (name).
        description:
          type: string
          maxLength: 512
          description: The variable's description.
        value:
          $ref: '#/components/schemas/Variable2Value'
          description: The key's value.
        enabled:
          type: boolean
          default: true
          description: If true, the variable is enabled.
        disabled:
          type: boolean
          default: false
          description: If true, the variable is not enabled. Doesn't apply to path parameter variables.
      description: Information about the variable.
      title: variable-2
    environmentSecret:
      type: boolean
      description: >-
        If true, the variable is marked as secret and its value is retrieved from the mentioned provider in the source
        field.
      title: environmentSecret
    EnvironmentVariableSourcePostmanType:
      type: string
      enum:
        - cloud
      description: |
        The variable's type:
        - `cloud` — The variable value is synced and stored in the Postman Cloud.
      title: EnvironmentVariableSourcePostmanType
    EnvironmentVariableSourcePostman:
      type: object
      properties:
        secretId:
          type: string
          description: The variable's secret ID.
        type:
          $ref: '#/components/schemas/EnvironmentVariableSourcePostmanType'
          description: |
            The variable's type:
            - `cloud` — The variable value is synced and stored in the Postman Cloud.
        vaultId:
          type: string
          description: The variable's ID in the Postman Vault.
      description: Information about the Postman-specific source of the variable's value.
      title: EnvironmentVariableSourcePostman
    EnvironmentVariableSourceProvider:
      type: string
      enum:
        - postman
      description: The secret's provider.
      title: EnvironmentVariableSourceProvider
    environmentVariableSource:
      type: object
      properties:
        postman:
          $ref: '#/components/schemas/EnvironmentVariableSourcePostman'
          description: Information about the Postman-specific source of the variable's value.
        provider:
          $ref: '#/components/schemas/EnvironmentVariableSourceProvider'
          description: The secret's provider.
      description: Information about the source of the variable's value.
      title: environmentVariableSource
    secretVariable:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
          description: If true, the variable is enabled.
        key:
          type: string
          description: The variable's key (name).
        secret:
          $ref: '#/components/schemas/environmentSecret'
        source:
          $ref: '#/components/schemas/environmentVariableSource'
        id:
          type: string
          description: The variable's ID. Doesn't apply to collection-level variables.
        description:
          type: string
          maxLength: 512
          description: The variable's description.
      description: Information about the secret variable.
      title: secretVariable
    VariableList2Items:
      oneOf:
        - $ref: '#/components/schemas/variable-2'
        - $ref: '#/components/schemas/secretVariable'
      title: VariableList2Items
    variable-list-2:
      type: array
      items:
        $ref: '#/components/schemas/VariableList2Items'
      description: >-
        A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/).
        Make certain not to include sensitive information in variables.
      title: variable-list-2
    Event2Listen:
      type: string
      enum:
        - test
        - prerequest
      description: The `prerequest` (pre-request) or `test` (post-response) value.
      title: Event2Listen
    event-2:
      type: object
      properties:
        id:
          type: string
          description: The event's ID.
        listen:
          $ref: '#/components/schemas/Event2Listen'
          description: The `prerequest` (pre-request) or `test` (post-response) value.
        script:
          $ref: '#/components/schemas/script-2'
      required:
        - listen
      description: Information about the collection's events.
      title: event-2
    event-list-2:
      type: array
      items:
        $ref: '#/components/schemas/event-2'
      description: >-
        A list of scripts configured to run when specific events occur. These scripts can be referenced in the
        collection by their ID.
      title: event-list-2
    Auth2Type:
      type: string
      enum:
        - basic
        - bearer
        - apikey
        - digest
        - oauth1
        - oauth2
        - hawk
        - awsv4
        - ntlm
        - edgegrid
        - jwt
        - asap
      description: The authorization type.
      title: Auth2Type
    auth-2:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/Auth2Type'
          description: The authorization type.
        apikey:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: The API key's authentication information.
        awsv4:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [AWS
            Signature](https://learning.postman.com/docs/sending-requests/authorization/aws-signature/) authentication.
        basic:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Basic
            Auth](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#basic-auth).
        bearer:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Bearer
            Token](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token)
            authentication.
        digest:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Digest](https://learning.postman.com/docs/sending-requests/authorization/digest-auth/)
            access authentication.
        edgegrid:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [Akamai
            Edgegrid](https://learning.postman.com/docs/sending-requests/authorization/akamai-edgegrid/) authentication.
        hawk:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for
            [Hawk](https://learning.postman.com/docs/sending-requests/authorization/hawk-authentication/)
            authentication.
        ntlm:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for
            [NTLM](https://learning.postman.com/docs/sending-requests/authorization/ntlm-authentication/)
            authentication.
        oauth1:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [OAuth1](https://learning.postman.com/docs/sending-requests/authorization/oauth-10/)
            authentication.
        oauth2:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for [OAuth2](https://learning.postman.com/docs/sending-requests/authorization/oauth-20/)
            authentication.
        jwt:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for JWT (JSON Web Token). Includes the `payload`, `secret`, `algorithm`, `addTokenTo`, and
            `headerPrefix` properties.
        asap:
          type: array
          items:
            $ref: '#/components/schemas/auth-attribute'
          description: >-
            The attributes for ASAP (Atlassian S2S Authentication Protocol). Includes the `kid`, `aud`, `iss`, `alg`,
            `privateKey`, and `claims` properties.
      required:
        - type
      description: >-
        The [authorization type supported by
        Postman](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/).
      title: auth-2
    Request2BodyMode:
      type: string
      enum:
        - raw
        - urlencoded
        - formdata
        - file
        - graphql
      description: The data associated with the request.
      title: Request2BodyMode
    Request2BodyUrlencodedItems:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        value:
          type: string
          description: The key's value.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      required:
        - key
      title: Request2BodyUrlencodedItems
    Request2BodyFormdataItemsOneOf0Type:
      type: string
      enum:
        - text
      description: The `text` value.
      title: Request2BodyFormdataItemsOneOf0Type
    Request2BodyFormdataItems0:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        value:
          type: string
          description: The key's value.
        type:
          $ref: '#/components/schemas/Request2BodyFormdataItemsOneOf0Type'
          description: The `text` value.
        contentType:
          type: string
          description: The form-data Content-Type header.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      title: Request2BodyFormdataItems0
    Request2BodyFormdataItemsOneOf1Src:
      oneOf:
        - type: string
        - type: array
          items:
            type: string
      title: Request2BodyFormdataItemsOneOf1Src
    Request2BodyFormdataItemsOneOf1Type:
      type: string
      enum:
        - file
      description: The `file` value.
      title: Request2BodyFormdataItemsOneOf1Type
    Request2BodyFormdataItems1:
      type: object
      properties:
        key:
          type: string
          description: The key value.
        src:
          $ref: '#/components/schemas/Request2BodyFormdataItemsOneOf1Src'
        type:
          $ref: '#/components/schemas/Request2BodyFormdataItemsOneOf1Type'
          description: The `file` value.
        contentType:
          type: string
          description: The form-data Content-Type header.
        description:
          type:
            - string
            - 'null'
          description: The key's description.
      title: Request2BodyFormdataItems1
    Request2BodyFormdataItems:
      oneOf:
        - $ref: '#/components/schemas/Request2BodyFormdataItems0'
        - $ref: '#/components/schemas/Request2BodyFormdataItems1'
      title: Request2BodyFormdataItems
    Request2BodyFile:
      type: object
      properties:
        src:
          type:
            - string
            - 'null'
          description: >-
            The name of the file to upload (not its path). A null value indicates that no file is selected as a part of
            the request body.
      description: If the `mode` value is `file`, an object containing the file request information.
      title: Request2BodyFile
    Request2BodyGraphql:
      type: object
      properties:
        query:
          type: string
          description: The GraphQL query.
        variables:
          type:
            - string
            - 'null'
          description: The GraphQL query variables, in JSON format.
      description: If the `mode` value is `graphql`, an object containing the GraphQL request information.
      title: Request2BodyGraphql
    Request2BodyOptions:
      type: object
      properties: {}
      description: Additional configurations and options set for various modes.
      title: Request2BodyOptions
    Request2Body:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/Request2BodyMode'
          description: The data associated with the request.
        raw:
          type: string
          description: If the `mode` value is `raw`, the raw content of the request body.
        urlencoded:
          type: array
          items:
            $ref: '#/components/schemas/Request2BodyUrlencodedItems'
          description: A list of x-www-form-encoded key/value pairs.
        formdata:
          type: array
          items:
            $ref: '#/components/schemas/Request2BodyFormdataItems'
          description: If the `mode` value is `formdata`, then a list of form-data key/pair values.
        file:
          $ref: '#/components/schemas/Request2BodyFile'
          description: If the `mode` value is `file`, an object containing the file request information.
        graphql:
          $ref: '#/components/schemas/Request2BodyGraphql'
          description: If the `mode` value is `graphql`, an object containing the GraphQL request information.
        options:
          $ref: '#/components/schemas/Request2BodyOptions'
          description: Additional configurations and options set for various modes.
      description: Information about the collection's request body.
      title: Request2Body
    request-2:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/url'
        auth:
          $ref: '#/components/schemas/auth-2'
        method:
          type: string
          description: The request's standard HTTP method.
        description:
          type:
            - string
            - 'null'
          description: The request's description.
        header:
          $ref: '#/components/schemas/header-list-2'
        body:
          $ref: '#/components/schemas/Request2Body'
          description: Information about the collection's request body.
      description: Information about the collection request.
      title: request-2
    Response2Header1:
      type: array
      items:
        $ref: '#/components/schemas/header-2'
      description: A list of the request's headers.
      title: Response2Header1
    Response2Header:
      oneOf:
        - type: string
        - $ref: '#/components/schemas/Response2Header1'
      title: Response2Header
    response-2:
      type: object
      properties:
        id:
          type: string
          description: The response's ID.
        originalRequest:
          $ref: '#/components/schemas/request-2'
        responseTime:
          type:
            - number
            - 'null'
          format: double
          description: The time taken by the request to complete. The unit is milliseconds.
        header:
          $ref: '#/components/schemas/Response2Header'
        body:
          type:
            - string
            - 'null'
          description: The raw text of the response.
        status:
          type: string
          description: The response's status.
        code:
          type: integer
          description: The response status code.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the response was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the response was updated.
        uid:
          type: string
          format: uid
          description: The item's unique ID.
      description: Information about the request's response.
      title: response-2
    item-2:
      type: object
      properties:
        id:
          type: string
          description: The collection item's ID.
        name:
          type: string
          description: The item's name.
        description:
          type:
            - string
            - 'null'
          description: The item's description.
        variable:
          $ref: '#/components/schemas/variable-list-2'
        event:
          $ref: '#/components/schemas/event-list-2'
        request:
          $ref: '#/components/schemas/request-2'
        response:
          type: array
          items:
            $ref: '#/components/schemas/response-2'
          description: A list of the collection's responses.
        protocolProfileBehavior:
          $ref: '#/components/schemas/protocol-profile-behavior'
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection item was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection item was updated.
        uid:
          type: string
          format: uid
          description: The collection item's unique ID.
      required:
        - id
      description: Information about the collection request or folder.
      title: item-2
    CollectionVariableValue:
      oneOf:
        - type: string
        - type: boolean
        - type: integer
      description: The key's value.
      title: CollectionVariableValue
    collection-variable:
      type: object
      properties:
        key:
          type: string
          description: The variable's key (name).
        value:
          $ref: '#/components/schemas/CollectionVariableValue'
          description: The key's value.
        disabled:
          type: boolean
          default: false
          description: If true, the variable is not enabled.
      description: >-
        Information about a collection-level variable. Collection variables don't support `id`, `description`, or
        `enabled` fields. Use `disabled` to control whether a variable is active.
      title: collection-variable
    collection-secret-variable:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
          description: If true, the variable is enabled.
        key:
          type: string
          description: The variable's key (name).
        secret:
          $ref: '#/components/schemas/environmentSecret'
        source:
          $ref: '#/components/schemas/environmentVariableSource'
        description:
          type: string
          maxLength: 512
          description: The variable's description.
      description: Information about a collection-level secret variable. Collection variables don't have an `id` field.
      title: collection-secret-variable
    CollectionVariableListItems:
      oneOf:
        - $ref: '#/components/schemas/collection-variable'
        - $ref: '#/components/schemas/collection-secret-variable'
      title: CollectionVariableListItems
    collection-variable-list:
      type: array
      items:
        $ref: '#/components/schemas/CollectionVariableListItems'
      description: >-
        A list of the collection's [variables](https://learning.postman.com/docs/sending-requests/variables/variables/).
        Make certain not to include sensitive information in variables.
      title: collection-variable-list
    GetCollectionCollection:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/GetCollectionCollectionInfo'
          description: Information about the collection.
        item:
          type: array
          items:
            $ref: '#/components/schemas/item-2'
        auth:
          $ref: '#/components/schemas/auth-2'
        event:
          $ref: '#/components/schemas/event-list-2'
        variable:
          $ref: '#/components/schemas/collection-variable-list'
      description: >-
        For a complete list of this endpoint's possible values, use the [Postman Collection Format
        documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: GetCollectionCollection
    getCollection:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/GetCollectionCollection'
          description: >-
            For a complete list of this endpoint's possible values, use the [Postman Collection Format
            documentation](https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html).
      title: getCollection
    GetCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRequestUnauthorizedError
    GetCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRequestInternalServerError
    Prefer:
      type: string
      enum:
        - respond-async
      title: Prefer
    Info2Schema:
      type: string
      enum:
        - https://schema.postman.com/json/collection/v2.1.0/collection.json
      description: The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0 schema.
      title: Info2Schema
    info-2:
      type: object
      properties:
        name:
          type: string
          description: The collection's name.
        _postman_id:
          type: string
          description: The collection's Postman ID. This field exists for Postman Collection Format v1 compatibility.
        description:
          type: string
          description: The collection's description.
        schema:
          $ref: '#/components/schemas/Info2Schema'
          description: >-
            The "https://schema.postman.com/json/collection/v2.1.0/collection.json" Postman Collection Format v2.1.0
            schema.
        updatedAt:
          type: string
          format: date-time
          description: The date and time when the collection was last updated.
        createdat:
          type: string
          format: date-time
          description: The date and time when the collection was created.
        lastUpdatedBy:
          type: string
          description: The user ID of the person who last updated the collection.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
      required:
        - name
        - schema
      description: Information about the collection.
      title: info-2
    modifyCollectionSchema:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/info-2'
        item:
          type: array
          items:
            $ref: '#/components/schemas/item-2'
        event:
          $ref: '#/components/schemas/event-list-2'
        variable:
          $ref: '#/components/schemas/collection-variable-list'
        auth:
          $ref: '#/components/schemas/auth-2'
        protocolProfileBehavior:
          $ref: '#/components/schemas/protocol-profile-behavior'
      required:
        - info
        - item
      title: modifyCollectionSchema
    putCollection:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/modifyCollectionSchema'
      title: putCollection
    PutCollectionResponseCollection:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
      title: PutCollectionResponseCollection
    putCollectionResponse:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/PutCollectionResponseCollection'
      title: putCollectionResponse
    PutCollectionRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: PutCollectionRequestBadRequestError
    PutCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutCollectionRequestUnauthorizedError
    PutCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutCollectionRequestForbiddenError
    PutCollectionRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: PutCollectionRequestNotFoundError
    PutCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutCollectionRequestInternalServerError
    DeleteCollectionCollection:
      type: object
      properties:
        id:
          type: string
          description: The deleted collection's ID.
        uid:
          type: string
          format: uid
          description: The deleted collection's unique ID.
      description: Information about the deleted collection.
      title: DeleteCollectionCollection
    deleteCollection:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/DeleteCollectionCollection'
          description: Information about the deleted collection.
      title: deleteCollection
    DeleteCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionRequestUnauthorizedError
    DeleteCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteCollectionRequestInternalServerError
    PatchCollectionCollection:
      oneOf:
        - description: Any type
        - description: Any type
        - description: Any type
        - description: Any type
      description: >
        The collection updates to apply. You must pass at least one of the following: `info`, `variable`, `auth`, or
        `events`. Unsupported properties are rejected.
      title: PatchCollectionCollection
    patchCollection:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/PatchCollectionCollection'
          description: >
            The collection updates to apply. You must pass at least one of the following: `info`, `variable`, `auth`, or
            `events`. Unsupported properties are rejected.
      title: patchCollection
    PatchCollectionResponseCollection:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's updated name.
        description:
          type: string
          description: The collection's updated description.
      title: PatchCollectionResponseCollection
    patchCollectionResponse:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/PatchCollectionResponseCollection'
      title: patchCollectionResponse
    PatchCollectionRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: PatchCollectionRequestBadRequestError
    PatchCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchCollectionRequestUnauthorizedError
    PatchCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchCollectionRequestForbiddenError
    PatchCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchCollectionRequestInternalServerError
    duplicateCollection:
      type: object
      properties:
        workspace:
          type: string
          description: The workspace ID in which to duplicate the collection.
        suffix:
          type: string
          description: An optional suffix to append to the duplicated collection's name.
      required:
        - workspace
      title: duplicateCollection
    DuplicateCollectionResponseTaskStatus:
      type: string
      enum:
        - processing
        - completed
        - failed
      description: The status of the collection duplication task.
      title: DuplicateCollectionResponseTaskStatus
    DuplicateCollectionResponseTask:
      type: object
      properties:
        id:
          type: string
          description: The duplication task's ID.
        status:
          $ref: '#/components/schemas/DuplicateCollectionResponseTaskStatus'
          description: The status of the collection duplication task.
        reason:
          type:
            - string
            - 'null'
          description: If the task failed, the reason why it failed to complete.
      title: DuplicateCollectionResponseTask
    duplicateCollectionResponse:
      type: object
      properties:
        task:
          $ref: '#/components/schemas/DuplicateCollectionResponseTask'
      title: duplicateCollectionResponse
    DuplicateCollectionRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: DuplicateCollectionRequestBadRequestError
    DuplicateCollectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DuplicateCollectionRequestUnauthorizedError
    DuplicateCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DuplicateCollectionRequestForbiddenError
    DuplicateCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DuplicateCollectionRequestInternalServerError
    GetCollectionForksDataItems:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the fork was created.
        createdBy:
          type: string
          description: The user who created the collection fork.
        forkId:
          type: string
          format: uid
          description: The forked collection's ID.
        forkName:
          type: string
          description: The forked collection's label.
      description: Information about the forked collection.
      title: GetCollectionForksDataItems
    GetCollectionForksMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          format: base64
          description: The pagination cursor that points to the next record in the results set.
        total:
          type: number
          format: double
          description: The total number of forked collections.
      description: The response's meta information for paginated results.
      title: GetCollectionForksMeta
    getCollectionForks:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionForksDataItems'
          description: A list of the collection's forks.
        meta:
          $ref: '#/components/schemas/GetCollectionForksMeta'
          description: The response's meta information for paginated results.
      title: getCollectionForks
    Fork404ErrorError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: Fork404ErrorError
    fork404Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Fork404ErrorError'
      title: fork404Error
    GetCollectionForksRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionForksRequestInternalServerError
    documentationColorSettings:
      type: object
      properties:
        highlight:
          type: string
          description: The hexcode color code for the documentation's highlighting.
        rightSidebar:
          type: string
          description: The hexcode color code for the documentation's right sidebar color.
        topBar:
          type: string
          description: The hexcode color code for the documentation's top bar color.
      description: >-
        The theme's colors, in six digit hexcode. The values in this object must match the hexcode values of either the
        `light` or `dark` theme defined in the `appearance` object.
      title: documentationColorSettings
    PublishDocumentationDocumentationLayout:
      type: string
      enum:
        - classic-single-column
        - classic-double-column
      default: classic-single-column
      description: |
        The documentation's default layout style:
        - `classic-single-column` — Displays sample code inline beneath each request.
        - `classic-double-column` — Displays sample code in a column next to the documentation.
      title: PublishDocumentationDocumentationLayout
    documentationMetaTags:
      type: object
      properties:
        name:
          type: string
          description: |
            The key's name:
              - `title` — The title of your documentation. This value appears in relevant search queries and browser tabs. By default, the system uses the collection's name for the documentation title.
              - `description` — The documentation's description. This provides brief information about your document and lets users know what it contains. By default, the system uses the collection's description content.
        value:
          type: string
          description: The `name` key's value.
      required:
        - name
        - value
      title: documentationMetaTags
    DocumentationApperanceSettingsDefault:
      type: string
      enum:
        - light
        - dark
      description: The default color theme (`light` or `dark`). Documentation uses the given theme value by default.
      title: DocumentationApperanceSettingsDefault
    DocumentationThemeSettingsName:
      type: string
      enum:
        - dark
        - light
      description: The `light` or `dark` theme.
      title: DocumentationThemeSettingsName
    documentationThemeSettings:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/DocumentationThemeSettingsName'
          description: The `light` or `dark` theme.
        colors:
          $ref: '#/components/schemas/documentationColorSettings'
        logo:
          type:
            - string
            - 'null'
          description: The URL to the documentation's logo image. By default, public documentation uses your team logo.
      title: documentationThemeSettings
    documentationApperanceSettings:
      type: object
      properties:
        default:
          $ref: '#/components/schemas/DocumentationApperanceSettingsDefault'
          description: The default color theme (`light` or `dark`). Documentation uses the given theme value by default.
        themes:
          type: array
          items:
            $ref: '#/components/schemas/documentationThemeSettings'
          description: A list of theme settings for the `light` and `dark` themes.
      description: Information about the documentation appearance, such as colors and theme.
      title: documentationApperanceSettings
    documentationCustomizationSettings:
      type: object
      properties:
        metaTags:
          type: array
          items:
            $ref: '#/components/schemas/documentationMetaTags'
          description: The key-pair values that contain the documentation's `title` and `description` metadata information.
        appearance:
          $ref: '#/components/schemas/documentationApperanceSettings'
      description: Information about the documentation's customization.
      title: documentationCustomizationSettings
    publishDocumentation:
      type: object
      properties:
        environmentUid:
          type: string
          format: uid
          description: >-
            The unique ID of the environment to publish with the documentation. The initial values of all variables are
            published with the documentation. Make certain they don't contain sensitive information such as passwords or
            tokens.
        customColor:
          $ref: '#/components/schemas/documentationColorSettings'
        documentationLayout:
          $ref: '#/components/schemas/PublishDocumentationDocumentationLayout'
          default: classic-single-column
          description: |
            The documentation's default layout style:
            - `classic-single-column` — Displays sample code inline beneath each request.
            - `classic-double-column` — Displays sample code in a column next to the documentation.
        customization:
          $ref: '#/components/schemas/documentationCustomizationSettings'
      required:
        - customColor
        - customization
      title: publishDocumentation
    publishDocumentationResponse:
      type: object
      properties:
        published:
          type: boolean
          description: If true, the documentation is published.
        documentationLayout:
          type: string
          description: The documentation's default layout style.
        customization:
          $ref: '#/components/schemas/documentationCustomizationSettings'
        publishDate:
          type: string
          format: date-time
          description: The date and time at which the documentation was published.
        publisherId:
          type: string
          description: The user ID of the user that published the documentation.
        environmentUid:
          type: string
          format: uid
          description: The unique ID of the environment published with the collection documentation.
        customColor:
          $ref: '#/components/schemas/documentationColorSettings'
        publicUrl:
          type: string
          format: url
          description: The public URL of the published documentation.
        id:
          type: string
          description: The published documentation's ID.
        collectionId:
          type: string
          description: The collection's ID.
      title: publishDocumentationResponse
    PullCollectionChangesResponseCollection:
      type: object
      properties:
        destinationId:
          type: string
          format: uid
          description: The ID of the forked collection the changes were pulled into.
        sourceId:
          type: string
          format: uid
          description: The ID of the source collection the changes were pulled from.
      description: Information about the updated collection fork.
      title: PullCollectionChangesResponseCollection
    pullCollectionChangesResponse:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/PullCollectionChangesResponseCollection'
          description: Information about the updated collection fork.
      title: pullCollectionChangesResponse
    PullCollectionChangesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PullCollectionChangesRequestInternalServerError
    GetCollectionPullRequestsDataItemsStatus:
      type: string
      enum:
        - open
        - approved
        - declined
        - merged
      description: The pull request's current status.
      title: GetCollectionPullRequestsDataItemsStatus
    GetCollectionPullRequestsDataItems:
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time at which the pull request was created.
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
        description:
          type: string
          description: The pull request's description.
        destinationId:
          type: string
          description: The pull request's merge destination ID.
        href:
          type: string
          description: A URL where you can view the pull request's details.
        id:
          type: string
          description: The pull request's ID.
        sourceId:
          type: string
          description: The pull request's source (parent) ID.
        status:
          $ref: '#/components/schemas/GetCollectionPullRequestsDataItemsStatus'
          description: The pull request's current status.
        comment:
          type: string
          description: If the pull request is declined, a comment about why the pull request was declined.
        title:
          type: string
          description: The pull request's title.
        updatedBy:
          type: string
          description: The ID of the user who updated the pull request.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the pull request was updated.
      description: Information about the pull request.
      title: GetCollectionPullRequestsDataItems
    getCollectionPullRequests:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionPullRequestsDataItems'
      title: getCollectionPullRequests
    GetCollectionPullRequestsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionPullRequestsRequestInternalServerError
    pullRequestCreate:
      type: object
      properties:
        title:
          type: string
          description: The title of the pull request.
        description:
          type: string
          description: The pull request's description.
        reviewers:
          type: array
          items:
            type: string
          description: A list of reviewers to assign to the pull request.
        destinationId:
          type: string
          description: The collection ID to merge the pull request into.
      required:
        - title
        - reviewers
        - destinationId
      description: Information about the pull request.
      title: pullRequestCreate
    pullRequestCreated:
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time at which the pull request was created.
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
        description:
          type: string
          description: The pull request's description.
        destinationId:
          type: string
          description: The pull request's merge destination ID.
        id:
          type: string
          description: The pull request's ID.
        sourceId:
          type: string
          description: The pull request's source (parent) ID.
        status:
          type: string
          description: The pull request's current status.
        title:
          type: string
          description: The pull request's title.
        updatedAt:
          type: string
          description: The date and time at which the pull request was updated.
      title: pullRequestCreated
    CreateCollectionPullRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateCollectionPullRequestRequestInternalServerError
    GetCollectionRolesGroupItemsRole:
      type: string
      enum:
        - VIEWER
        - EDITOR
      description: |
        The role type:
        - `VIEWER` — Can view, fork, and export collections.
        - `EDITOR` — Can edit collections directly.
      title: GetCollectionRolesGroupItemsRole
    GetCollectionRolesGroupItems:
      type: object
      properties:
        role:
          $ref: '#/components/schemas/GetCollectionRolesGroupItemsRole'
          description: |
            The role type:
            - `VIEWER` — Can view, fork, and export collections.
            - `EDITOR` — Can edit collections directly.
        id:
          type: number
          format: double
          description: The role's ID.
      description: Information about the group role.
      title: GetCollectionRolesGroupItems
    GetCollectionRolesTeamItemsRole:
      type: string
      enum:
        - VIEWER
        - EDITOR
      description: |
        The role type:
        - `VIEWER` — Can view, fork, and export collections.
        - `EDITOR` — Can edit collections directly.
      title: GetCollectionRolesTeamItemsRole
    GetCollectionRolesTeamItems:
      type: object
      properties:
        role:
          $ref: '#/components/schemas/GetCollectionRolesTeamItemsRole'
          description: |
            The role type:
            - `VIEWER` — Can view, fork, and export collections.
            - `EDITOR` — Can edit collections directly.
        id:
          type: number
          format: double
          description: The role's ID.
      description: Information about the team role.
      title: GetCollectionRolesTeamItems
    GetCollectionRolesUserItemsRole:
      type: string
      enum:
        - VIEWER
        - EDITOR
      description: |
        The role type:
        - `VIEWER` — Can view, fork, and export collections.
        - `EDITOR` — Can edit collections directly.
      title: GetCollectionRolesUserItemsRole
    GetCollectionRolesUserItems:
      type: object
      properties:
        role:
          $ref: '#/components/schemas/GetCollectionRolesUserItemsRole'
          description: |
            The role type:
            - `VIEWER` — Can view, fork, and export collections.
            - `EDITOR` — Can edit collections directly.
        id:
          type: number
          format: double
          description: The role's ID.
      description: Information about the user role.
      title: GetCollectionRolesUserItems
    getCollectionRoles:
      type: object
      properties:
        group:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionRolesGroupItems'
          description: A list of the collection's group roles.
        team:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionRolesTeamItems'
          description: A list of the collection's team roles.
        user:
          type: array
          items:
            $ref: '#/components/schemas/GetCollectionRolesUserItems'
          description: A list of the collection's user roles.
      description: Information about the collection's roles.
      title: getCollectionRoles
    GetCollectionRolesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRolesRequestUnauthorizedError
    GetCollectionRolesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRolesRequestForbiddenError
    commonErrorTypeTitle:
      type: object
      properties:
        title:
          type: string
          description: A short summary of the problem.
        type:
          type: string
          description: The type of error.
      title: commonErrorTypeTitle
    GetCollectionRolesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionRolesRequestInternalServerError
    UpdateCollectionRolesRolesItemsOp:
      type: string
      enum:
        - update
      description: The operation to perform on the path.
      title: UpdateCollectionRolesRolesItemsOp
    UpdateCollectionRolesRolesItemsPath:
      type: string
      enum:
        - /user
        - /group
        - /team
      description: The resource to perform the action on.
      title: UpdateCollectionRolesRolesItemsPath
    UpdateCollectionRolesRolesItemsValueItemsRole:
      type: string
      enum:
        - VIEWER
        - EDITOR
      description: |-
        The role type:
        - `VIEWER` — Can view, fork, and export collections.
        - `EDITOR` — Can edit collections directly.
      title: UpdateCollectionRolesRolesItemsValueItemsRole
    UpdateCollectionRolesRolesItemsValueItems:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The user, group, or team's ID.
        role:
          $ref: '#/components/schemas/UpdateCollectionRolesRolesItemsValueItemsRole'
          description: |-
            The role type:
            - `VIEWER` — Can view, fork, and export collections.
            - `EDITOR` — Can edit collections directly.
      required:
        - id
        - role
      description: Information about the updated role.
      title: UpdateCollectionRolesRolesItemsValueItems
    UpdateCollectionRolesRolesItems:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/UpdateCollectionRolesRolesItemsOp'
          description: The operation to perform on the path.
        path:
          $ref: '#/components/schemas/UpdateCollectionRolesRolesItemsPath'
          description: The resource to perform the action on.
        value:
          type: array
          items:
            $ref: '#/components/schemas/UpdateCollectionRolesRolesItemsValueItems'
      required:
        - op
        - path
        - value
      title: UpdateCollectionRolesRolesItems
    updateCollectionRoles:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UpdateCollectionRolesRolesItems'
      required:
        - roles
      title: updateCollectionRoles
    UpdateCollectionRolesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionRolesRequestUnauthorizedError
    UpdateCollectionRolesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionRolesRequestForbiddenError
    UpdateCollectionRolesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateCollectionRolesRequestInternalServerError
    GetSourceCollectionStatusCollectionCollectionUid:
      type: object
      properties:
        isSourceAhead:
          type: boolean
          description: If true, there is a difference between the forked collection and its source collection.
      description: >-
        Information about the forked collection. The object's name is the forked collection's UID
        (`userId`-`collectionId`).
      title: GetSourceCollectionStatusCollectionCollectionUid
    GetSourceCollectionStatusCollection:
      type: object
      properties:
        collectionUid:
          $ref: '#/components/schemas/GetSourceCollectionStatusCollectionCollectionUid'
          description: >-
            Information about the forked collection. The object's name is the forked collection's UID
            (`userId`-`collectionId`).
      title: GetSourceCollectionStatusCollection
    getSourceCollectionStatus:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/GetSourceCollectionStatusCollection'
      title: getSourceCollectionStatus
    ForkCollection400ErrorCollection:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: ForkCollection400ErrorCollection
    forkCollection400Error:
      type: object
      properties:
        collection:
          $ref: '#/components/schemas/ForkCollection400ErrorCollection'
      title: forkCollection400Error
    GetSourceCollectionStatusRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSourceCollectionStatusRequestInternalServerError
    collectionTransformFormat:
      type: string
      enum:
        - json
        - yaml
      default: json
      title: collectionTransformFormat
    transformCollectionToOpenAPI:
      type: object
      properties:
        output:
          type: string
          description: The collection's transformed output, in a stringified OpenAPI JSON or YAML format.
      title: transformCollectionToOpenAPI
    TransferCollectionItemsMode:
      type: string
      enum:
        - copy
        - move
      description: The transfer operation to perform.
      title: TransferCollectionItemsMode
    TransferCollectionItemsTargetModel:
      type: string
      enum:
        - collection
        - folder
        - request
      description: >-
        The collection, folder, or request that the items will be transferred to. For response transfers, use the
        `request` value.
      title: TransferCollectionItemsTargetModel
    TransferCollectionItemsTarget:
      type: object
      properties:
        id:
          type: string
          format: uid
          description: The UID of the destination collection, folder, or request.
        model:
          $ref: '#/components/schemas/TransferCollectionItemsTargetModel'
          description: >-
            The collection, folder, or request that the items will be transferred to. For response transfers, use the
            `request` value.
      required:
        - id
        - model
      description: Information about the item transfer's destination location.
      title: TransferCollectionItemsTarget
    TransferCollectionItemsLocationPosition:
      type: string
      enum:
        - start
        - end
        - before
        - after
      default: end
      description: The transferred item's position within the destination object.
      title: TransferCollectionItemsLocationPosition
    TransferCollectionItemsLocation:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
          format: uid
          description: For `before` or `after` positions, the model's UID.
        model:
          type:
            - string
            - 'null'
          description: >
            For `before` or `after` positions, the type of item (model) that the transferred item will be positioned by.
            One of: `folder`, `request`, or `response.`
        position:
          $ref: '#/components/schemas/TransferCollectionItemsLocationPosition'
          description: The transferred item's position within the destination object.
      required:
        - position
      description: |
        The transferred items' placement in the target destination:
        - For `start` or `end` — Do not include the `model` and `id` values.
        - For `before` or `after` — Include the `model` and `id` properties.
      title: TransferCollectionItemsLocation
    transferCollectionItems:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
            format: uid
          description: A list of collection request, response, or folder UIDs to transfer.
        mode:
          $ref: '#/components/schemas/TransferCollectionItemsMode'
          description: The transfer operation to perform.
        target:
          $ref: '#/components/schemas/TransferCollectionItemsTarget'
          description: Information about the item transfer's destination location.
        location:
          $ref: '#/components/schemas/TransferCollectionItemsLocation'
          description: |
            The transferred items' placement in the target destination:
            - For `start` or `end` — Do not include the `model` and `id` values.
            - For `before` or `after` — Include the `model` and `id` properties.
      required:
        - ids
        - mode
        - target
        - location
      title: transferCollectionItems
    transferCollectionItemsResponse:
      type: object
      properties:
        ids:
          type: array
          items:
            type: string
            format: uid
          description: A list of the transferred collection request, response, or folder UIDs.
      title: transferCollectionItemsResponse
    TransferCollectionFoldersRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: TransferCollectionFoldersRequestInternalServerError
    TransferCollectionRequestsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: TransferCollectionRequestsRequestInternalServerError
    TransferCollectionResponsesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: TransferCollectionResponsesRequestInternalServerError
    taskUid:
      type: string
      format: uid
      title: taskUid
    GetDuplicateCollectionTaskStatusRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetDuplicateCollectionTaskStatusRequestUnauthorizedError
    GetDuplicateCollectionTaskStatusRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetDuplicateCollectionTaskStatusRequestForbiddenError
    GetDuplicateCollectionTaskStatusRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetDuplicateCollectionTaskStatusRequestInternalServerError
    taskId:
      type: string
      title: taskId
    GetCollectionUpdatesTasksStatus:
      type: string
      enum:
        - successful
        - failed
        - in-progress
      description: The task's current status.
      title: GetCollectionUpdatesTasksStatus
    getCollectionUpdatesTasks:
      type: object
      properties:
        id:
          type: string
          description: The task's ID.
        status:
          $ref: '#/components/schemas/GetCollectionUpdatesTasksStatus'
          description: The task's current status.
      title: getCollectionUpdatesTasks
    GetCollectionUpdatesTasksRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionUpdatesTasksRequestUnauthorizedError
    GetCollectionUpdatesTasksRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionUpdatesTasksRequestForbiddenError
    GetCollectionUpdatesTasksRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetCollectionUpdatesTasksRequestInternalServerError
    threadId:
      type: integer
      title: threadId
    componentType:
      type: string
      enum:
        - OAS2
        - OAS3
        - OAS3_1
      description: The component's type. Corresponds to the specification that the component's content adheres to.
      title: componentType
    componentStatus:
      type: string
      enum:
        - active
        - archived
      description: >
        The component's lifecycle state:

        - `active` — The component is active and can be edited and published.

        - `archived` — The component is archived and read-only. Archived components can't be edited or published, but
        their existing versions remain accessible.
      title: componentStatus
    componentHasVersions:
      type: boolean
      title: componentHasVersions
    componentIncludeFields:
      type: string
      title: componentIncludeFields
    componentExpandLatestVersion:
      type: string
      title: componentExpandLatestVersion
    meta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
      title: meta
    componentVersionId:
      type: string
      description: The component version's ID.
      title: componentVersionId
    componentVersionData:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/componentVersionId'
        label:
          type: string
          description: The component version's label.
        url:
          type: string
          format: uri
          description: The URL where the component version can be accessed.
        format:
          type: string
          description: The component version's content format.
        publishedAt:
          type: string
          format: date-time
          description: The date and time at which the component version was published.
        content:
          type: string
          description: The version's content. This returns when you include the `include` parameter.
      description: Information about a component's version.
      title: componentVersionData
    ComponentDataLatestVersion:
      oneOf:
        - type: string
        - $ref: '#/components/schemas/componentVersionData'
      description: >
        Information about the component's latest version. This property only returns only when you pass the
        `latestVersion` value for the `include` parameter.


        To return detailed information about the component's latest version, pass the `latestVersion` value for the
        `expand` parameter.
      title: ComponentDataLatestVersion
    componentData:
      type: object
      properties:
        id:
          type: string
          description: The component's ID.
        name:
          type: string
          description: The component's name.
        type:
          $ref: '#/components/schemas/componentType'
        status:
          $ref: '#/components/schemas/componentStatus'
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the component was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the component was last updated.
        createdBy:
          type: string
          description: The ID of the user who created the component.
        updatedBy:
          type: string
          description: The ID of the user who last updated the component.
        hasVersions:
          type: boolean
          description: >-
            Whether the component has versions. Returns only when you pass the `hasVersions` value for the `include`
            parameter.
        latestVersion:
          $ref: '#/components/schemas/ComponentDataLatestVersion'
          description: >
            Information about the component's latest version. This property only returns only when you pass the
            `latestVersion` value for the `include` parameter.


            To return detailed information about the component's latest version, pass the `latestVersion` value for the
            `expand` parameter.
      description: Information about the component.
      title: componentData
    getAllComponents:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/meta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/componentData'
          description: A list of components.
      title: getAllComponents
    GetAllComponentsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllComponentsRequestUnauthorizedError
    GetAllComponentsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllComponentsRequestInternalServerError
    componentContentFormatData:
      type: string
      enum:
        - JSON
        - YAML
      description: The component's content format.
      title: componentContentFormatData
    createComponent:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-zA-Z0-9\-_.]+$
          minLength: 1
          maxLength: 60
          description: >-
            The component's name. This must be unique within the team and can only contain letters, digits, hyphens,
            underscores, and periods and can't exceed 60 characters.
        type:
          $ref: '#/components/schemas/componentType'
        content:
          type: string
          description: The component's content, up to a maximum of 500 KB (UTF-8).
        format:
          $ref: '#/components/schemas/componentContentFormatData'
          default: YAML
          description: The component's content format. Defaults to YAML.
      required:
        - name
        - type
        - content
      title: createComponent
    componentId:
      type: string
      description: The component's ID.
      title: componentId
    createComponentResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/componentId'
      description: Information about the component.
      title: createComponentResponse
    CreateComponentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentRequestUnauthorizedError
    CreateComponentRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentRequestForbiddenError
    CreateComponentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentRequestInternalServerError
    getComponent:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/componentData'
      title: getComponent
    GetComponentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentRequestUnauthorizedError
    GetComponentRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentRequestForbiddenError
    GetComponentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentRequestInternalServerError
    updateComponent:
      oneOf:
        - description: Any type
        - description: Any type
      title: updateComponent
    updateComponentResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/componentId'
        name:
          type: string
          description: The component's name.
        status:
          $ref: '#/components/schemas/componentStatus'
      description: Information about the component.
      title: updateComponentResponse
    UpdateComponentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentRequestUnauthorizedError
    UpdateComponentRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentRequestForbiddenError
    UpdateComponentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentRequestInternalServerError
    getComponentDraft:
      type: object
      properties:
        content:
          type: string
          description: The component's draft content.
        format:
          type: string
          description: The component draft's content format.
      title: getComponentDraft
    GetComponentDraftRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentDraftRequestUnauthorizedError
    GetComponentDraftRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentDraftRequestForbiddenError
    GetComponentDraftRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentDraftRequestInternalServerError
    updateComponentDraft:
      type: object
      properties:
        content:
          type: string
          description: The component's contents, up to a maximum of 500 KB (UTF-8).
        format:
          $ref: '#/components/schemas/componentContentFormatData'
      description: Information about the component draft.
      title: updateComponentDraft
    updateComponentDraftResponse:
      type: object
      properties:
        id:
          type: string
          description: The component draft's ID.
      description: Information about the component draft.
      title: updateComponentDraftResponse
    UpdateComponentDraftRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentDraftRequestUnauthorizedError
    UpdateComponentDraftRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentDraftRequestForbiddenError
    UpdateComponentDraftRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateComponentDraftRequestInternalServerError
    componentLibraryInclude:
      type: string
      title: componentLibraryInclude
    getComponentVersions:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/meta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/componentVersionData'
          description: A list of the component's versions.
      title: getComponentVersions
    GetComponentVersionsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionsRequestUnauthorizedError
    GetComponentVersionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionsRequestForbiddenError
    GetComponentVersionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionsRequestInternalServerError
    CreateComponentVersionSourceType:
      type: string
      enum:
        - draft
      description: The `draft` value.
      title: CreateComponentVersionSourceType
    CreateComponentVersionSource:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/CreateComponentVersionSourceType'
          description: The `draft` value.
      description: The source to publish the version from. Defaults to the component's current draft.
      title: CreateComponentVersionSource
    createComponentVersion:
      type: object
      properties:
        label:
          type: string
          pattern: ^[a-zA-Z0-9]([a-zA-Z0-9._+-]{0,58}[a-zA-Z0-9])?$
          minLength: 1
          maxLength: 60
          description: >-
            The component version's label. This must begin and end with an alphanumeric character and may only contain
            letters, digits, dots, underscores, plus signs, and hyphens and cannot exceed 60 characters.
        source:
          $ref: '#/components/schemas/CreateComponentVersionSource'
          description: The source to publish the version from. Defaults to the component's current draft.
      required:
        - label
      title: createComponentVersion
    createComponentVersionResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/componentVersionId'
      description: Information about the component version.
      title: createComponentVersionResponse
    CreateComponentVersionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentVersionRequestUnauthorizedError
    CreateComponentVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentVersionRequestForbiddenError
    CreateComponentVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateComponentVersionRequestInternalServerError
    GetComponentVersionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionRequestUnauthorizedError
    GetComponentVersionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionRequestForbiddenError
    GetComponentVersionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetComponentVersionRequestInternalServerError
    getEnvironmentsInfo:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the environment was last updated.
        owner:
          type: string
          description: The environment owner's ID.
        uid:
          type: string
          format: uid
          description: The environment's unique ID.
        isPublic:
          type: boolean
          description: If true, the environment is public and visible to all users.
      description: Information about the environment.
      title: getEnvironmentsInfo
    getEnvironments:
      type: object
      properties:
        environments:
          type: array
          items:
            $ref: '#/components/schemas/getEnvironmentsInfo'
          description: A list of environments.
      title: getEnvironments
    GetEnvironmentsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentsRequestUnauthorizedError
    GetEnvironmentsRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentsRequestNotFoundError
    GetEnvironmentsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentsRequestInternalServerError
    EnvironmentVariablesType:
      type: string
      enum:
        - secret
        - default
      description: |
        The variable's type:
        - `secret` — The variable value is masked.
        - `default` — The variable value is visible in plain text.
      title: EnvironmentVariablesType
    environmentVariables:
      type: object
      properties:
        enabled:
          type: boolean
          description: If true, the variable is enabled.
        key:
          type: string
          description: The variable's name.
        value:
          type: string
          description: The variable's value.
        type:
          $ref: '#/components/schemas/EnvironmentVariablesType'
          description: |
            The variable's type:
            - `secret` — The variable value is masked.
            - `default` — The variable value is visible in plain text.
        description:
          type: string
          maxLength: 512
          description: The variable's description.
      description: Information about the variable.
      title: environmentVariables
    EnvironmentVaultVariablesType:
      type: string
      enum:
        - secret
        - default
      description: |
        The variable's type:
        - `secret` — The variable value is masked.
        - `default` — The variable value is visible in plain text.
      title: EnvironmentVaultVariablesType
    environmentVaultVariables:
      type: object
      properties:
        enabled:
          type: boolean
          description: If true, the variable is enabled.
        key:
          type: string
          description: The variable's name.
        value:
          type: string
          description: The variable's value.
        type:
          $ref: '#/components/schemas/EnvironmentVaultVariablesType'
          description: |
            The variable's type:
            - `secret` — The variable value is masked.
            - `default` — The variable value is visible in plain text.
        secret:
          $ref: '#/components/schemas/environmentSecret'
        source:
          $ref: '#/components/schemas/environmentVariableSource'
        description:
          type: string
          maxLength: 512
          description: The variable's description.
      description: >-
        Information about the variable stored in the Postman Vault. This property only returns when a variable is
        defined as secret.
      title: environmentVaultVariables
    CreateEnvironmentEnvironmentValuesItems:
      oneOf:
        - $ref: '#/components/schemas/environmentVariables'
        - $ref: '#/components/schemas/environmentVaultVariables'
      title: CreateEnvironmentEnvironmentValuesItems
    CreateEnvironmentEnvironment:
      type: object
      properties:
        name:
          type: string
          description: The environment's name.
        values:
          type: array
          items:
            $ref: '#/components/schemas/CreateEnvironmentEnvironmentValuesItems'
          description: Information about the environment's variables.
      required:
        - name
      description: Information about the environment.
      title: CreateEnvironmentEnvironment
    createEnvironment:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/CreateEnvironmentEnvironment'
          description: Information about the environment.
      title: createEnvironment
    CreateEnvironmentResponseEnvironment:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        uid:
          type: string
          format: uid
          description: The environment's unique ID.
      description: Information about the environment.
      title: CreateEnvironmentResponseEnvironment
    createEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/CreateEnvironmentResponseEnvironment'
          description: Information about the environment.
      title: createEnvironmentResponse
    CreateEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateEnvironmentRequestBadRequestError
    CreateEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateEnvironmentRequestUnauthorizedError
    CreateEnvironmentRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateEnvironmentRequestForbiddenError
    CreateEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateEnvironmentRequestInternalServerError
    GetEnvironmentInfoValuesItems:
      oneOf:
        - $ref: '#/components/schemas/environmentVariables'
        - $ref: '#/components/schemas/environmentVaultVariables'
      title: GetEnvironmentInfoValuesItems
    getEnvironmentInfo:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        owner:
          type: string
          description: The ID of environment's owner.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the environment was last updated.
        values:
          type: array
          items:
            $ref: '#/components/schemas/GetEnvironmentInfoValuesItems'
          description: Information about the environment's variables.
        isPublic:
          type: boolean
          description: If true, the environment is public and visible to all users.
      description: Information about the environment.
      title: getEnvironmentInfo
    getEnvironment:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/getEnvironmentInfo'
      title: getEnvironment
    GetEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentRequestBadRequestError
    GetEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentRequestUnauthorizedError
    GetEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentRequestInternalServerError
    PutEnvironmentEnvironmentValuesItems:
      oneOf:
        - $ref: '#/components/schemas/environmentVariables'
        - $ref: '#/components/schemas/environmentVaultVariables'
      title: PutEnvironmentEnvironmentValuesItems
    PutEnvironmentEnvironment:
      type: object
      properties:
        name:
          type: string
          description: The environment's name.
        values:
          type: array
          items:
            $ref: '#/components/schemas/PutEnvironmentEnvironmentValuesItems'
          description: Information about the environment's variables.
      description: Information about the environment.
      title: PutEnvironmentEnvironment
    putEnvironment:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/PutEnvironmentEnvironment'
          description: Information about the environment.
      title: putEnvironment
    PutEnvironmentResponseEnvironment:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        uid:
          type: string
          format: uid
          description: The environment's unique ID.
      description: Information about the environment.
      title: PutEnvironmentResponseEnvironment
    putEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/PutEnvironmentResponseEnvironment'
          description: Information about the environment.
      title: putEnvironmentResponse
    PutEnvironmentRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutEnvironmentRequestBadRequestError
    PutEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutEnvironmentRequestUnauthorizedError
    PutEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PutEnvironmentRequestInternalServerError
    DeleteEnvironmentEnvironment:
      type: object
      properties:
        id:
          type: string
          description: The deleted environment's ID.
        uid:
          type: string
          format: uid
          description: The deleted environment's unique ID.
      description: Information about the environment.
      title: DeleteEnvironmentEnvironment
    deleteEnvironment:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/DeleteEnvironmentEnvironment'
          description: Information about the environment.
      title: deleteEnvironment
    DeleteEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteEnvironmentRequestUnauthorizedError
    DeleteEnvironmentRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteEnvironmentRequestNotFoundError
    DeleteEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteEnvironmentRequestInternalServerError
    PatchEnvironmentAddItemsValue:
      oneOf:
        - $ref: '#/components/schemas/environmentVariables'
        - $ref: '#/components/schemas/environmentVaultVariables'
      title: PatchEnvironmentAddItemsValue
    PatchEnvironmentAddItems:
      type: object
      properties:
        op:
          type: string
          description: The `add` operation.
        path:
          type: string
          description: >-
            The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update,
            in `/values/#` format, where `#` is the entry ID. The first record begins at the `0` value.
        value:
          $ref: '#/components/schemas/PatchEnvironmentAddItemsValue'
      required:
        - op
        - path
        - value
      title: PatchEnvironmentAddItems
    patchEnvironmentAdd:
      type: array
      items:
        $ref: '#/components/schemas/PatchEnvironmentAddItems'
      title: patchEnvironmentAdd
    PatchEnvironmentNameItems:
      type: object
      properties:
        op:
          type: string
          description: The `replace` operation.
        path:
          type: string
          description: The `/name` value.
        value:
          type: string
          description: The environment's updated name.
      required:
        - op
        - path
        - value
      description: Information about the environment.
      title: PatchEnvironmentNameItems
    patchEnvironmentName:
      type: array
      items:
        $ref: '#/components/schemas/PatchEnvironmentNameItems'
      title: patchEnvironmentName
    PatchEnvironmentReplaceItems:
      type: object
      properties:
        op:
          type: string
          description: The `replace` operation.
        path:
          type: string
          description: >
            The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update,
            in `/values/#/{value}` format, where:

            - `#` — The entry ID. The first record begins at the `0` value.

            - `{value}` — The variable property to update. Accepts `key`, `value`, `type`, and `enable`.
        value:
          type: string
          description: The variable's value.
      required:
        - op
        - path
        - value
      title: PatchEnvironmentReplaceItems
    patchEnvironmentReplace:
      type: array
      items:
        $ref: '#/components/schemas/PatchEnvironmentReplaceItems'
      title: patchEnvironmentReplace
    PatchEnvironmentRemoveItems:
      type: object
      properties:
        op:
          type: string
          description: The `remove` operation.
        path:
          type: string
          description: >-
            The [JSON Pointer syntax](https://datatracker.ietf.org/doc/html/rfc6901) that indicates the entry to update,
            in `/values/#` format, where `#` is the entry ID. The first record begins at the `0` value.
      required:
        - op
        - path
      title: PatchEnvironmentRemoveItems
    patchEnvironmentRemove:
      type: array
      items:
        $ref: '#/components/schemas/PatchEnvironmentRemoveItems'
      title: patchEnvironmentRemove
    Environments_patchEnvironment_Request:
      oneOf:
        - $ref: '#/components/schemas/patchEnvironmentAdd'
        - $ref: '#/components/schemas/patchEnvironmentName'
        - $ref: '#/components/schemas/patchEnvironmentReplace'
        - $ref: '#/components/schemas/patchEnvironmentRemove'
      title: Environments_patchEnvironment_Request
    PatchEnvironmentInfoValuesItems:
      oneOf:
        - $ref: '#/components/schemas/environmentVariables'
        - $ref: '#/components/schemas/environmentVaultVariables'
      title: PatchEnvironmentInfoValuesItems
    patchEnvironmentInfo:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        owner:
          type: string
          description: The ID of environment's owner.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the environment was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the environment was last updated.
        values:
          type: array
          items:
            $ref: '#/components/schemas/PatchEnvironmentInfoValuesItems'
          description: Information about the environment's variables.
        uid:
          type: string
          format: uid
          description: The environment's unique ID.
      description: Information about the environment.
      title: patchEnvironmentInfo
    patchEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/patchEnvironmentInfo'
      title: patchEnvironmentResponse
    PatchEnvironment400ErrorDetail:
      oneOf:
        - type: string
        - type: array
          items:
            type: string
      description: Details about the occurrence of the error.
      title: PatchEnvironment400ErrorDetail
    patchEnvironment400Error:
      type: object
      properties:
        title:
          type: string
          description: A short summary of the error.
        status:
          type: number
          format: double
          description: The error's HTTP status code.
        detail:
          $ref: '#/components/schemas/PatchEnvironment400ErrorDetail'
          description: Details about the occurrence of the error.
        type:
          type: string
          format: uri
          description: The error type.
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
      title: patchEnvironment400Error
    PatchEnvironmentRequestNotFoundError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchEnvironmentRequestNotFoundError
    PatchEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchEnvironmentRequestInternalServerError
    environmentUid:
      type: string
      format: uid
      title: environmentUid
    sortByCreatedAt:
      type: string
      enum:
        - createdAt
      title: sortByCreatedAt
    environmentForkInfo:
      type: object
      properties:
        forkId:
          type: string
          format: uid
          description: The forked environment's unique ID.
        forkName:
          type: string
          description: The forked environment's label.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the fork was created.
        createdBy:
          type: string
          description: The user who created the environment fork.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the fork was last updated.
      description: Information about the forked environment.
      title: environmentForkInfo
    environmentForksMeta:
      type: object
      properties:
        total:
          type: number
          format: double
          description: The total number of forked environments.
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: environmentForksMeta
    getEnvironmentForks:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/environmentForkInfo'
          description: A list of the environment's forks.
        meta:
          $ref: '#/components/schemas/environmentForksMeta'
      title: getEnvironmentForks
    GetEnvironmentForksRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentForksRequestUnauthorizedError
    GetEnvironmentForksRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetEnvironmentForksRequestInternalServerError
    forkEnvironment:
      type: object
      properties:
        forkName:
          type: string
          description: The forked environment's label.
      required:
        - forkName
      title: forkEnvironment
    ForkEnvironmentResponseEnvironment:
      type: object
      properties:
        uid:
          type: string
          format: uid
          description: The forked environment's ID.
        name:
          type: string
          description: The name of the forked environment.
        forkName:
          type: string
          description: The forked environment's label.
      description: Information about the forked environment.
      title: ForkEnvironmentResponseEnvironment
    forkEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/ForkEnvironmentResponseEnvironment'
          description: Information about the forked environment.
      title: forkEnvironmentResponse
    ForkEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ForkEnvironmentRequestUnauthorizedError
    ForkEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ForkEnvironmentRequestInternalServerError
    mergeEnvironmentFork:
      type: object
      properties:
        source:
          type: string
          format: uid
          description: The source environment's unique ID to merge data from.
        deleteSource:
          type: boolean
          default: false
          description: If true, the forked environment will be deleted.
      required:
        - source
      title: mergeEnvironmentFork
    MergeEnvironmentForkResponseEnvironment:
      type: object
      properties:
        uid:
          type: string
          format: uid
          description: The merged environment's ID.
      description: Information about the merged environment.
      title: MergeEnvironmentForkResponseEnvironment
    mergeEnvironmentForkResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/MergeEnvironmentForkResponseEnvironment'
          description: Information about the merged environment.
      title: mergeEnvironmentForkResponse
    MergeEnvironmentForkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MergeEnvironmentForkRequestUnauthorizedError
    MergeEnvironmentForkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MergeEnvironmentForkRequestInternalServerError
    pullEnvironment:
      type: object
      properties:
        source:
          type: string
          format: uid
          description: The source environment's unique ID to pull data from.
      required:
        - source
      title: pullEnvironment
    PullEnvironmentResponseEnvironment:
      type: object
      properties:
        uid:
          type: string
          format: uid
          description: The merged environment's unique ID.
      description: Information about the merged environment.
      title: PullEnvironmentResponseEnvironment
    pullEnvironmentResponse:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/PullEnvironmentResponseEnvironment'
          description: Information about the merged environment.
      title: pullEnvironmentResponse
    PullEnvironmentRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PullEnvironmentRequestUnauthorizedError
    PullEnvironmentRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PullEnvironmentRequestInternalServerError
    GetGroupsDataItems:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The group's ID.
        teamId:
          type: number
          format: double
          description: The group's Postman team ID.
        name:
          type: string
          description: The group's name.
        summary:
          type: string
          description: The group's summary.
        createdBy:
          type: number
          format: double
          description: The ID of ther user who created the group.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the group was updated.
        members:
          type: array
          items:
            type: number
            format: double
          description: The group members' IDs.
        roles:
          type: array
          items:
            type: string
          description: The group's roles.
      description: Information about the group.
      title: GetGroupsDataItems
    getGroups:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetGroupsDataItems'
          description: A list of Postman groups.
      title: getGroups
    GetGroupsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestUnauthorizedError
    GetGroupsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestForbiddenError
    GetGroupsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupsRequestInternalServerError
    groupId:
      type: integer
      title: groupId
    getGroup:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The group's ID.
        teamId:
          type: number
          format: double
          description: The group's Postman team ID.
        name:
          type: string
          description: The group's name.
        summary:
          type: string
          description: The group's summary.
        createdBy:
          type: number
          format: double
          description: The ID of ther user who created the group.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the group was updated.
        members:
          type: array
          items:
            type: number
            format: double
          description: The group members' IDs.
        roles:
          type: array
          items:
            type: string
          description: The group's roles.
        managers:
          type: array
          items:
            type: number
            format: double
          description: The group's managers.
      description: Information about the group.
      title: getGroup
    GetGroupRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetGroupRequestBadRequestError
    GetGroupRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestUnauthorizedError
    GetGroupRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestForbiddenError
    GetGroupRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGroupRequestInternalServerError
    JsonSchemaType:
      type: string
      enum:
        - json
      description: The `json` type value.
      title: JsonSchemaType
    JsonSchemaInput:
      type: object
      properties: {}
      description: >-
        An object that contains a valid JSON OpenAPI definition. For more information, read the [OpenAPI
        documentation](https://swagger.io/docs/specification/basic-structure/).
      title: JsonSchemaInput
    GenerateCollectionOptionsRequestNameSource:
      type: string
      enum:
        - Fallback
        - URL
      default: Fallback
      description: >
        Determines how the generated collection's requests are named. If the `Fallback` value is passed, then the
        request is named after one of the following values in the schema:

        - `summary`

        - `operationId`

        - `description`

        - `url`
      title: GenerateCollectionOptionsRequestNameSource
    GenerateCollectionOptionsIndentCharacter:
      type: string
      enum:
        - Tab
        - Space
      default: Space
      description: The option for setting the indentation character type.
      title: GenerateCollectionOptionsIndentCharacter
    GenerateCollectionOptionsFolderStrategy:
      type: string
      enum:
        - Paths
        - Tags
      default: Paths
      description: Whether to create folders based on the specification's `paths` or `tags` properties.
      title: GenerateCollectionOptionsFolderStrategy
    generateCollectionOptions:
      type: object
      properties:
        requestNameSource:
          $ref: '#/components/schemas/GenerateCollectionOptionsRequestNameSource'
          default: Fallback
          description: >
            Determines how the generated collection's requests are named. If the `Fallback` value is passed, then the
            request is named after one of the following values in the schema:

            - `summary`

            - `operationId`

            - `description`

            - `url`
        indentCharacter:
          $ref: '#/components/schemas/GenerateCollectionOptionsIndentCharacter'
          default: Space
          description: The option for setting the indentation character type.
        parametersResolution:
          type: string
          default: Schema
          description: >-
            Generated collections use examples for parameter generation by default. Any existing collections generated
            using the schema parameter generation will continue to sync using their existing strategy.
          deprecated: true
        folderStrategy:
          $ref: '#/components/schemas/GenerateCollectionOptionsFolderStrategy'
          default: Paths
          description: Whether to create folders based on the specification's `paths` or `tags` properties.
        includeAuthInfoInExample:
          type: boolean
          default: true
          description: If true, include the authentication parameters in the example request.
        enableOptionalParameters:
          type: boolean
          default: true
          description: If true, enables optional parameters in the collection and its requests.
        keepImplicitHeaders:
          type: boolean
          default: false
          description: If true, keep the implicit headers from the OpenAPI specification, which are removed by default.
        includeDeprecated:
          type: boolean
          default: true
          description: If true, includes all deprecated operations, parameters, and properties in generated collection.
        alwaysInheritAuthentication:
          type: boolean
          default: false
          description: Whether authentication details should be included in all requests, or always inherited from the collection.
        nestedFolderHierarchy:
          type: boolean
          default: false
          description: If true, creates subfolders in the generated collection based on the order of the endpoints' tags.
      description: >-
        The advanced creation options and their values. For more details, see Postman's [OpenAPI to Postman Collection
        Converter OPTIONS documentation](https://github.com/postmanlabs/openapi-to-postman/blob/develop/OPTIONS.md).
        These properties are case-sensitive.
      title: generateCollectionOptions
    jsonSchema:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/JsonSchemaType'
          description: The `json` type value.
        input:
          $ref: '#/components/schemas/JsonSchemaInput'
          description: >-
            An object that contains a valid JSON OpenAPI definition. For more information, read the [OpenAPI
            documentation](https://swagger.io/docs/specification/basic-structure/).
        options:
          $ref: '#/components/schemas/generateCollectionOptions'
      required:
        - type
        - input
      title: jsonSchema
    JsonStringifiedType:
      type: string
      enum:
        - string
      description: The `string` type value.
      title: JsonStringifiedType
    jsonStringified:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/JsonStringifiedType'
          description: The `string` type value.
        input:
          type: string
          description: The stringified OpenAPI definition.
        options:
          $ref: '#/components/schemas/generateCollectionOptions'
      required:
        - type
        - input
      title: jsonStringified
    Import_openApiDefinition_Request:
      oneOf:
        - $ref: '#/components/schemas/jsonSchema'
        - $ref: '#/components/schemas/jsonStringified'
      title: Import_openApiDefinition_Request
    ImportOpenApiDefinitionCollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
      title: ImportOpenApiDefinitionCollectionsItems
    importOpenApiDefinition:
      type: object
      properties:
        collections:
          type: array
          items:
            $ref: '#/components/schemas/ImportOpenApiDefinitionCollectionsItems'
      title: importOpenApiDefinition
    import400Error:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: import400Error
    ImportOpenApiDefinitionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ImportOpenApiDefinitionRequestUnauthorizedError
    ImportOpenApiDefinitionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ImportOpenApiDefinitionRequestInternalServerError
    teamIdResultsQuery:
      type: string
      title: teamIdResultsQuery
    GetMocksMocksItemsConfigDelayType:
      type: string
      enum:
        - fixed
      description: |
        The type of simulated delay value:
        - `fixed` — The delay value is a fixed value.
      title: GetMocksMocksItemsConfigDelayType
    GetMocksMocksItemsConfigDelayPreset:
      type: string
      enum:
        - '1'
        - '2'
      description: |
        The simulated fixed network delay value:
        - `1` — 2G (300 ms).
        - `2` — 3G (100 ms).
        The object does not return this value for custom delay values.
      title: GetMocksMocksItemsConfigDelayPreset
    GetMocksMocksItemsConfigDelay:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GetMocksMocksItemsConfigDelayType'
          description: |
            The type of simulated delay value:
            - `fixed` — The delay value is a fixed value.
        preset:
          $ref: '#/components/schemas/GetMocksMocksItemsConfigDelayPreset'
          description: |
            The simulated fixed network delay value:
            - `1` — 2G (300 ms).
            - `2` — 3G (100 ms).
            The object does not return this value for custom delay values.
        duration:
          type: integer
          description: The configured delay, in milliseconds.
      description: >-
        Information about the mock server's simulated network delay settings. This returns a null value if there are no
        configured network delay settings.
      title: GetMocksMocksItemsConfigDelay
    GetMocksMocksItemsConfig:
      type: object
      properties:
        delay:
          oneOf:
            - $ref: '#/components/schemas/GetMocksMocksItemsConfigDelay'
            - type: 'null'
          description: >-
            Information about the mock server's simulated network delay settings. This returns a null value if there are
            no configured network delay settings.
        headers:
          type: array
          items:
            type: string
          description: A list of the mock server's headers.
        matchBody:
          type: boolean
          description: If true, match the request body.
        matchQueryParams:
          type: boolean
          description: If true, match query parameters.
        matchWildcards:
          type: boolean
          description: If true, use wildcard variable matching.
        serverResponseId:
          type:
            - string
            - 'null'
          description: >-
            The ID of mock server's default response for requests. All calls to the mock server will return the defined
            response.
      description: Information about the mock server's configuration.
      title: GetMocksMocksItemsConfig
    GetMocksMocksItems:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
        owner:
          type: string
          description: The ID of mock server's owner.
        uid:
          type: string
          format: uid
          description: The mock server's unique ID.
        collection:
          type: string
          description: The unique ID of the mock's associated collection.
        mockUrl:
          type: string
          format: url
          description: The mock server URL.
        config:
          $ref: '#/components/schemas/GetMocksMocksItemsConfig'
          description: Information about the mock server's configuration.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was created.
        environment:
          type: string
          description: The mock server's associated environment ID.
        isPublic:
          type: boolean
          description: >-
            If true, the mock server is public and visible to all users. This field does not indicate the mock server's
            access control status.
        name:
          type: string
          description: The mock server's name.
        deactivated:
          type: boolean
          description: >-
            If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is
            deleted.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was last updated.
      description: Information about the mock server.
      title: GetMocksMocksItems
    getMocks:
      type: object
      properties:
        mocks:
          type: array
          items:
            $ref: '#/components/schemas/GetMocksMocksItems'
          description: A list of mock servers.
      title: getMocks
    GetMocksRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMocksRequestUnauthorizedError
    Mock500ErrorError:
      type: object
      properties:
        type:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: Mock500ErrorError
    mock500Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Mock500ErrorError'
      title: mock500Error
    CreateMockMock:
      type: object
      properties:
        collection:
          type: string
          format: uid
          description: The unique ID of the mock's associated collection.
        environment:
          type: string
          format: uid
          description: The unique ID of the mock's associated environment.
        name:
          type: string
          description: The mock server's name.
        private:
          type: boolean
          default: false
          description: >-
            If true, the mock server is set private. By default, mock servers are public and can receive requests from
            anyone and anywhere.
      required:
        - collection
      title: CreateMockMock
    createMock:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/CreateMockMock'
      title: createMock
    MockCreateUpdateResponseMockConfigDelayType:
      type: string
      enum:
        - fixed
      description: The `fixed` value.
      title: MockCreateUpdateResponseMockConfigDelayType
    MockCreateUpdateResponseMockConfigDelayPreset:
      type: string
      enum:
        - '1'
        - '2'
      description: |
        The simulated fixed network delay value:
        - `1` — 2G (300 ms).
        - `2` — 3G (100 ms).
        The object does not return this value for custom delay values.
      title: MockCreateUpdateResponseMockConfigDelayPreset
    MockCreateUpdateResponseMockConfigDelay:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/MockCreateUpdateResponseMockConfigDelayType'
          description: The `fixed` value.
        duration:
          type: integer
          description: For custom network delays, the custom configured delay, in milliseconds.
        preset:
          $ref: '#/components/schemas/MockCreateUpdateResponseMockConfigDelayPreset'
          description: |
            The simulated fixed network delay value:
            - `1` — 2G (300 ms).
            - `2` — 3G (100 ms).
            The object does not return this value for custom delay values.
      description: >-
        Information about the mock server's simulated network delay settings. This returns a null value if there are no
        configured network delay settings.
      title: MockCreateUpdateResponseMockConfigDelay
    MockCreateUpdateResponseMockConfig:
      type: object
      properties:
        matchBody:
          type: boolean
          description: If true, the mock server matches the request's body to the body of the saved examples.
        matchHeader:
          type: boolean
          description: >-
            If true, the mock server matches the request's headers in the `header` array to the headers of the saved
            examples.
        headers:
          type: array
          items:
            type: string
          description: A list of header key values.
        matchQueryParams:
          type: boolean
          description: If true, match query parameters to the saved examples.
        matchWildcards:
          type: boolean
          description: If true, use wildcard variable matching.
        delay:
          oneOf:
            - $ref: '#/components/schemas/MockCreateUpdateResponseMockConfigDelay'
            - type: 'null'
          description: >-
            Information about the mock server's simulated network delay settings. This returns a null value if there are
            no configured network delay settings.
        serverResponseId:
          type:
            - string
            - 'null'
          description: >-
            The ID of mock server's default response for requests. All calls to the mock server will return the defined
            response.
      description: Information about the mock server's configuration.
      title: MockCreateUpdateResponseMockConfig
    MockCreateUpdateResponseMock:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
        owner:
          type: string
          description: The ID of mock server's owner.
        uid:
          type: string
          format: uid
          description: The mock server's unique ID.
        collection:
          type: string
          description: The unique ID of the mock's associated collection.
        mockUrl:
          type: string
          format: url
          description: The mock server URL.
        name:
          type: string
          description: The mock server's name.
        config:
          $ref: '#/components/schemas/MockCreateUpdateResponseMockConfig'
          description: Information about the mock server's configuration.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was last updated.
        environment:
          type: string
          description: The unique ID of the mock's associated environment.
      description: Information about the mock server.
      title: MockCreateUpdateResponseMock
    mockCreateUpdateResponse:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/MockCreateUpdateResponseMock'
          description: Information about the mock server.
      title: mockCreateUpdateResponse
    CreateMockRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: CreateMockRequestBadRequestError
    CreateMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMockRequestUnauthorizedError
    mockId:
      type: string
      title: mockId
    GetMockMockConfigDelayType:
      type: string
      enum:
        - fixed
      description: |
        The type of simulated delay value:
        - `fixed` — The delay value is a fixed value.
      title: GetMockMockConfigDelayType
    GetMockMockConfigDelayPreset:
      type: string
      enum:
        - '1'
        - '2'
      description: |
        The simulated fixed network delay value:
        - `1` — 2G (300 ms).
        - `2` — 3G (100 ms).
        The object does not return this value for custom delay values.
      title: GetMockMockConfigDelayPreset
    GetMockMockConfigDelay:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/GetMockMockConfigDelayType'
          description: |
            The type of simulated delay value:
            - `fixed` — The delay value is a fixed value.
        preset:
          $ref: '#/components/schemas/GetMockMockConfigDelayPreset'
          description: |
            The simulated fixed network delay value:
            - `1` — 2G (300 ms).
            - `2` — 3G (100 ms).
            The object does not return this value for custom delay values.
        duration:
          type: integer
          description: The configured delay, in milliseconds.
      description: >-
        Information about the mock server's simulated network delay settings. This returns a null value if there are no
        configured network delay settings.
      title: GetMockMockConfigDelay
    GetMockMockConfig:
      type: object
      properties:
        headers:
          type: array
          items:
            type: string
          description: A list of the mock server's headers.
        matchBody:
          type: boolean
          description: If true, match the request body.
        matchQueryParams:
          type: boolean
          description: If true, match query parameters.
        matchWildcards:
          type: boolean
          description: If true, use wildcard variable matching.
        delay:
          oneOf:
            - $ref: '#/components/schemas/GetMockMockConfigDelay'
            - type: 'null'
          description: >-
            Information about the mock server's simulated network delay settings. This returns a null value if there are
            no configured network delay settings.
        serverResponseId:
          type:
            - string
            - 'null'
          description: >-
            The ID of mock server's default response for requests. All calls to the mock server will return the defined
            response.
      description: Information about the mock server's configuration.
      title: GetMockMockConfig
    GetMockMock:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
        owner:
          type: string
          description: The ID of mock server's owner.
        uid:
          type: string
          format: uid
          description: The mock server's unique ID.
        collection:
          type: string
          description: The unique ID of the mock's associated collection.
        mockUrl:
          type: string
          format: url
          description: The mock server URL.
        name:
          type: string
          description: The mock server's name.
        config:
          $ref: '#/components/schemas/GetMockMockConfig'
          description: Information about the mock server's configuration.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the mock server was last updated.
        isPublic:
          type: boolean
          description: >-
            If true, the mock server is public and visible to all users. This field does not indicate the mock server's
            access control status.
        deactivated:
          type: boolean
          description: >-
            If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is
            deleted.
        environment:
          type: string
          description: The mock server's associated environment ID.
      description: Information about the mock server.
      title: GetMockMock
    getMock:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/GetMockMock'
          description: Information about the mock server.
      title: getMock
    GetMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockRequestUnauthorizedError
    UpdateMockMockConfig:
      type: object
      properties:
        serverResponseId:
          type:
            - string
            - 'null'
          description: >-
            The server response ID. This sets the given server response as the default response for each request. To
            deactivate a server response, pass a null value.
      description: The mock server's configuration settings.
      title: UpdateMockMockConfig
    UpdateMockMock:
      type: object
      properties:
        name:
          type: string
          description: The mock server's name.
        environment:
          type: string
          format: uid
          description: The associated environment's unique ID.
        description:
          type: string
          description: The mock server's description.
        private:
          type: boolean
          default: false
          description: >-
            If true, the mock server is set private. By default, mock servers are public and can receive requests from
            anyone and anywhere.
        versionTag:
          type: string
          description: The API's version tag ID.
        collection:
          type: string
          description: The ID of the collection associated with the mock server.
        config:
          $ref: '#/components/schemas/UpdateMockMockConfig'
          description: The mock server's configuration settings.
      title: UpdateMockMock
    updateMock:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/UpdateMockMock'
      title: updateMock
    UpdateMockRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: UpdateMockRequestBadRequestError
    UpdateMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMockRequestUnauthorizedError
    DeleteMockMock:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
        uid:
          type: string
          format: uid
          description: The mock server's unique ID.
      description: Information about the mock server.
      title: DeleteMockMock
    deleteMock:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/DeleteMockMock'
          description: Information about the mock server.
      title: deleteMock
    DeleteMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMockRequestUnauthorizedError
    limitDefault100:
      type: number
      format: double
      default: 100
      title: limitDefault100
    untilDateTime:
      type: string
      format: date-time
      title: untilDateTime
    sinceDateTime:
      type: string
      format: date-time
      title: sinceDateTime
    mockResponseStatusCode:
      type: number
      format: double
      title: mockResponseStatusCode
    mockResponseType:
      type: string
      title: mockResponseType
    mockRequestMethod:
      type: string
      title: mockRequestMethod
    mockRequestPath:
      type: string
      title: mockRequestPath
    mockSortServedAt:
      type: string
      enum:
        - servedAt
      title: mockSortServedAt
    mockInclude:
      type: string
      title: mockInclude
    GetMockCallLogsCallLogsItemsRequestHeadersItems:
      type: object
      properties:
        key:
          type: string
          description: The request header's name.
        value:
          type: string
          description: The request header's value.
      title: GetMockCallLogsCallLogsItemsRequestHeadersItems
    GetMockCallLogsCallLogsItemsRequestBody:
      type: object
      properties:
        mode:
          type: string
          description: The request body's media type (mode).
        data:
          type: string
          description: The request body's contents.
      description: The request's body information.
      title: GetMockCallLogsCallLogsItemsRequestBody
    GetMockCallLogsCallLogsItemsRequest:
      type: object
      properties:
        method:
          type: string
          description: The request method.
        path:
          type: string
          description: The request's path.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsRequestHeadersItems'
          description: The request's headers.
        body:
          $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsRequestBody'
          description: The request's body information.
      description: The server response's request information.
      title: GetMockCallLogsCallLogsItemsRequest
    GetMockCallLogsCallLogsItemsResponseHeadersItemsDescription:
      type: object
      properties:
        content:
          type: string
          description: The response header description's content.
        type:
          type: string
          description: The response header description's media type.
      description: The response header's description information.
      title: GetMockCallLogsCallLogsItemsResponseHeadersItemsDescription
    GetMockCallLogsCallLogsItemsResponseHeadersItems:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsResponseHeadersItemsDescription'
          description: The response header's description information.
        key:
          type: string
          description: The response header's name.
        value:
          type: string
          description: The response header's value.
      title: GetMockCallLogsCallLogsItemsResponseHeadersItems
    GetMockCallLogsCallLogsItemsResponseBody:
      type: object
      properties:
        data:
          type: string
          description: The response body's contents.
      description: The response's body information.
      title: GetMockCallLogsCallLogsItemsResponseBody
    GetMockCallLogsCallLogsItemsResponse:
      type: object
      properties:
        type:
          type: string
          description: The type of response.
        statusCode:
          type: number
          format: double
          description: The response's status code.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsResponseHeadersItems'
          description: The response's headers.
        body:
          $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsResponseBody'
          description: The response's body information.
      description: The server response's response information.
      title: GetMockCallLogsCallLogsItemsResponse
    GetMockCallLogsCallLogsItems:
      type: object
      properties:
        id:
          type: string
          description: The server response's ID.
        responseName:
          type: string
          description: The server response's name.
        servedAt:
          type: string
          format: date-time
          description: The date and time at which the server response was served.
        request:
          $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsRequest'
          description: The server response's request information.
        response:
          $ref: '#/components/schemas/GetMockCallLogsCallLogsItemsResponse'
          description: The server response's response information.
      description: Information about the mock server's server response.
      title: GetMockCallLogsCallLogsItems
    GetMockCallLogsMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          format: base64
          description: The pagination cursor that points to the next record in the results set.
      description: The response's non-standard meta information.
      title: GetMockCallLogsMeta
    getMockCallLogs:
      type: object
      properties:
        call-logs:
          type: array
          items:
            $ref: '#/components/schemas/GetMockCallLogsCallLogsItems'
          description: A list of call logs.
        meta:
          $ref: '#/components/schemas/GetMockCallLogsMeta'
          description: The response's non-standard meta information.
      title: getMockCallLogs
    GetMockCallLogsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetMockCallLogsRequestBadRequestError
    GetMockCallLogsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockCallLogsRequestUnauthorizedError
    GetMockCallLogsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockCallLogsRequestInternalServerError
    PublishUnpublishMockResponseMock:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
      description: Information about the mock server.
      title: PublishUnpublishMockResponseMock
    publishUnpublishMockResponse:
      type: object
      properties:
        mock:
          $ref: '#/components/schemas/PublishUnpublishMockResponseMock'
          description: Information about the mock server.
      title: publishUnpublishMockResponse
    PublishMockRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: PublishMockRequestBadRequestError
    PublishMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PublishMockRequestUnauthorizedError
    UnpublishMockRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: UnpublishMockRequestBadRequestError
    UnpublishMockRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UnpublishMockRequestUnauthorizedError
    GetMockServerResponsesItems:
      type: object
      properties:
        id:
          type: string
          description: The server response's ID.
        name:
          type: string
          description: The server response's name.
        statusCode:
          type: number
          format: double
          description: The server response's 5xx HTTP response code.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the server response was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the server response was last updated.
        createdBy:
          type: string
          description: The user ID of the user who created the server response.
        updatedBy:
          type: string
          description: The user ID of the user who last updated the server response.
      description: Information about the server response.
      title: GetMockServerResponsesItems
    getMockServerResponses:
      type: array
      items:
        $ref: '#/components/schemas/GetMockServerResponsesItems'
      description: A list of the mock server's responses.
      title: getMockServerResponses
    GetMockServerResponsesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockServerResponsesRequestUnauthorizedError
    MockServerResponse404ErrorError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        header:
          type: string
          description: Information about the error.
        message:
          type: string
          description: The error message.
      title: MockServerResponse404ErrorError
    mockServerResponse404Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/MockServerResponse404ErrorError'
      title: mockServerResponse404Error
    GetMockServerResponsesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockServerResponsesRequestInternalServerError
    CreateMockServerResponseServerResponseHeadersItems:
      type: object
      properties:
        key:
          type: string
          description: The request header's key value.
        value:
          type: string
          description: The request header's value.
      title: CreateMockServerResponseServerResponseHeadersItems
    CreateMockServerResponseServerResponseLanguage:
      type: string
      enum:
        - text
        - javascript
        - json
        - html
        - xml
      description: The server response's body language type.
      title: CreateMockServerResponseServerResponseLanguage
    CreateMockServerResponseServerResponse:
      type: object
      properties:
        name:
          type: string
          description: The server response's name.
        statusCode:
          type: integer
          description: The server response's 5xx HTTP response code. This property only accepts 5xx values.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/CreateMockServerResponseServerResponseHeadersItems'
          description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
        language:
          oneOf:
            - $ref: '#/components/schemas/CreateMockServerResponseServerResponseLanguage'
            - type: 'null'
          description: The server response's body language type.
        body:
          type: string
          description: The server response's body that returns when calling the mock server.
      required:
        - name
        - statusCode
      title: CreateMockServerResponseServerResponse
    createMockServerResponse:
      type: object
      properties:
        serverResponse:
          $ref: '#/components/schemas/CreateMockServerResponseServerResponse'
      title: createMockServerResponse
    MockServerResponseHeadersItems:
      type: object
      properties:
        key:
          type: string
          description: The request header's key value.
        value:
          type: string
          description: The request header's value.
      title: MockServerResponseHeadersItems
    mockServerResponse:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the server response was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the server response was last updated.
        id:
          type: string
          description: The server response's ID.
        name:
          type: string
          description: The server response's name.
        statusCode:
          type: number
          format: double
          description: The server response's 5xx HTTP response code.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/MockServerResponseHeadersItems'
          description: >-
            The server response's request headers key-value pairs, such as Content-Type, Accept, encoding, and other
            information.
        language:
          type:
            - string
            - 'null'
          description: The server response's body language type.
        body:
          type: string
          description: The server response's body that returns when calling the mock server.
        createdBy:
          type: string
          description: The user ID of the user who created the server response.
        updatedBy:
          type: string
          description: The user ID of the user who last updated the server response.
        mock:
          type: string
          description: The associated mock server's ID.
      description: Information about the mock server's response.
      title: mockServerResponse
    CreateMockServerResponseRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: CreateMockServerResponseRequestBadRequestError
    CreateMockServerResponseRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMockServerResponseRequestUnauthorizedError
    CreateMockServerResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMockServerResponseRequestInternalServerError
    serverResponseId:
      type: string
      title: serverResponseId
    GetMockServerResponseRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockServerResponseRequestUnauthorizedError
    GetMockServerResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMockServerResponseRequestInternalServerError
    UpdateMockServerResponseServerResponseHeadersItems:
      type: object
      properties:
        key:
          type: string
          description: The request header's key value.
        value:
          type: string
          description: The request header's value. This value defines the corresponding value for the header key.
      description: Information about the key-value pair.
      title: UpdateMockServerResponseServerResponseHeadersItems
    UpdateMockServerResponseServerResponseLanguage:
      type: string
      enum:
        - text
        - javascript
        - json
        - html
        - xml
      description: The server response's body language type.
      title: UpdateMockServerResponseServerResponseLanguage
    UpdateMockServerResponseServerResponse:
      type: object
      properties:
        name:
          type: string
          description: The server response's name.
        statusCode:
          type: integer
          description: >-
            The server response's 5xx HTTP response code. This property only accepts [5xx
            values](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml).
        headers:
          type: array
          items:
            $ref: '#/components/schemas/UpdateMockServerResponseServerResponseHeadersItems'
          description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
        language:
          oneOf:
            - $ref: '#/components/schemas/UpdateMockServerResponseServerResponseLanguage'
            - type: 'null'
          description: The server response's body language type.
        body:
          type: string
          description: The server response's body that returns when you call the mock server.
      title: UpdateMockServerResponseServerResponse
    updateMockServerResponse:
      type: object
      properties:
        serverResponse:
          $ref: '#/components/schemas/UpdateMockServerResponseServerResponse'
      title: updateMockServerResponse
    UpdateMockServerResponseRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: UpdateMockServerResponseRequestBadRequestError
    UpdateMockServerResponseRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMockServerResponseRequestUnauthorizedError
    UpdateMockServerResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMockServerResponseRequestInternalServerError
    DeleteMockServerResponseHeadersItems:
      type: object
      properties:
        key:
          type: string
          description: The request header's key value.
        value:
          type: string
          description: The request header's value.
      title: DeleteMockServerResponseHeadersItems
    DeleteMockServerResponseLanguage:
      type: string
      enum:
        - text
        - javascript
        - json
        - html
        - xml
      description: The server response's body language type.
      title: DeleteMockServerResponseLanguage
    deleteMockServerResponse:
      type: object
      properties:
        id:
          type: string
          description: The server response's ID.
        name:
          type: string
          description: The server response's name.
        statusCode:
          type: number
          format: double
          description: The server response's 5xx HTTP response code.
        headers:
          type: array
          items:
            $ref: '#/components/schemas/DeleteMockServerResponseHeadersItems'
          description: The server response's request headers, such as Content-Type, Accept, encoding, and other information.
        language:
          oneOf:
            - $ref: '#/components/schemas/DeleteMockServerResponseLanguage'
            - type: 'null'
          description: The server response's body language type.
        body:
          type: string
          description: The server response's body that returns when calling the mock server.
        createdBy:
          type: string
          description: The user ID of the user who created the server response.
        updatedBy:
          type: string
          description: The user ID of the user who last updated the server response.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the server response was created.
      description: Information about the deleted server response.
      title: deleteMockServerResponse
    DeleteMockServerResponseRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMockServerResponseRequestUnauthorizedError
    DeleteMockServerResponseRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMockServerResponseRequestInternalServerError
    active:
      type: boolean
      default: false
      title: active
    owner:
      type: integer
      title: owner
    limitDefault25:
      type: integer
      maximum: 25
      default: 25
      title: limitDefault25
    GetMonitorsMonitorsItems:
      type: object
      properties:
        id:
          type: string
          description: The monitor's ID.
        name:
          type: string
          description: The monitor's name.
        active:
          type: boolean
          description: Whether the monitor is active (`true`) or inactive (`false`).
        uid:
          type: string
          format: uid
          description: The monitor's unique ID.
        owner:
          type: integer
          description: The ID of the user that created the monitor.
        collectionUid:
          type: string
          description: The unique ID of the monitor's associated collection.
        environmentUid:
          type: string
          description: The unique ID of the monitor's associated environment.
      description: Information about the monitor.
      title: GetMonitorsMonitorsItems
    GetMonitorsMeta:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
        limit:
          type: integer
          description: The maximum number of records in the paginated response.
      description: The response's meta information for paginated results.
      title: GetMonitorsMeta
    getMonitors:
      type: object
      properties:
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/GetMonitorsMonitorsItems'
          description: A list of monitors.
        meta:
          $ref: '#/components/schemas/GetMonitorsMeta'
          description: The response's meta information for paginated results.
      title: getMonitors
    GetMonitorsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetMonitorsRequestBadRequestError
    GetMonitorsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorsRequestUnauthorizedError
    GetMonitorsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorsRequestForbiddenError
    GetMonitorsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorsRequestInternalServerError
    monitorRetry:
      type: object
      properties:
        attempts:
          type: number
          format: double
          minimum: 1
          maximum: 2
          description: >-
            The number of times to reattempt a monitor run if it fails or errors. This may impact your [monitor
            usage](https://learning.postman.com/docs/monitoring-your-api/monitor-usage/#view-monitor-usage).
      description: Information about the monitor's retry settings.
      title: monitorRetry
    monitorOptions:
      type: object
      properties:
        followRedirects:
          type: boolean
          description: If true, follow redirects enabled.
        requestDelay:
          type: number
          format: double
          minimum: 1
          maximum: 900000
          description: The monitor's request delay value, in milliseconds.
        requestTimeout:
          type: number
          format: double
          minimum: 1
          maximum: 900000
          description: The monitor's request timeout value, in milliseconds.
        strictSSL:
          type: boolean
          description: If true, strict SSL enabled.
      description: Information about the monitor's option settings.
      title: monitorOptions
    monitorSchedule:
      type: object
      properties:
        cron:
          type: string
          description: |
            The monitor's run frequency, based on the given POSIX cron pattern. For example:
            - Every 5 minutes — `*/5 * * * *`
            - Every 30 minutes — `*/30 * * * *`
            - Every hour — `0 */1 * * *`
            - Every 6 hours — `0 */6 * * *`
            - Every day at 5 pm — `0 17 * * *`
            - Every Monday at 12 pm — `0 12 * * MON`
            - Every weekday (Mon — Fri) at 6 am — `0 6 * * MON-FRI`
        timezone:
          type: string
          description: The monitor's [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
      description: Information about the monitor's schedule.
      title: monitorSchedule
    MonitorDistributionItemsRegion:
      type: string
      enum:
        - us-east
        - us-west
        - ap-southeast
        - ca-central
        - eu-central
        - sa-east
        - uk
        - us-east-staticip
        - us-west-staticip
      description: The assigned distribution region.
      title: MonitorDistributionItemsRegion
    MonitorDistributionItems:
      type: object
      properties:
        region:
          $ref: '#/components/schemas/MonitorDistributionItemsRegion'
          description: The assigned distribution region.
      title: MonitorDistributionItems
    monitorDistribution:
      type: array
      items:
        $ref: '#/components/schemas/MonitorDistributionItems'
      description: >-
        A list of the monitor's [geographic
        regions](https://learning.postman.com/docs/monitoring-your-api/setting-up-monitor/#add-regions).
      title: monitorDistribution
    MonitorNotificationsOnErrorItems:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The email address of the user to notify on monitor error.
      title: MonitorNotificationsOnErrorItems
    MonitorNotificationsOnFailureItems:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The email address of the user to notify on monitor failure.
      title: MonitorNotificationsOnFailureItems
    monitorNotifications:
      type: object
      properties:
        onError:
          type: array
          items:
            $ref: '#/components/schemas/MonitorNotificationsOnErrorItems'
        onFailure:
          type: array
          items:
            $ref: '#/components/schemas/MonitorNotificationsOnFailureItems'
      description: Information about the monitor's notification settings.
      title: monitorNotifications
    CreateMonitorMonitor:
      type: object
      properties:
        name:
          type: string
          description: The monitor's name.
        active:
          type: boolean
          default: true
          description: If true, the monitor is active and makes calls to the specified URL.
        notificationLimit:
          type: number
          format: double
          minimum: 1
          maximum: 99
          description: Stop email notifications after the given number consecutive failures.
        collection:
          type: string
          description: The unique ID of the monitor's associated collection.
        environment:
          type: string
          description: The unique ID of the monitor's associated environment.
        retry:
          $ref: '#/components/schemas/monitorRetry'
        options:
          $ref: '#/components/schemas/monitorOptions'
        schedule:
          $ref: '#/components/schemas/monitorSchedule'
        distribution:
          $ref: '#/components/schemas/monitorDistribution'
        notifications:
          $ref: '#/components/schemas/monitorNotifications'
      required:
        - name
        - collection
        - schedule
      description: Information about the monitor.
      title: CreateMonitorMonitor
    createMonitor:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/CreateMonitorMonitor'
          description: Information about the monitor.
      title: createMonitor
    CreateUpdateMonitorResponseMonitor:
      type: object
      properties:
        id:
          type: string
          description: The monitor's ID.
        name:
          type: string
          description: The monitor's name.
        active:
          type: boolean
          default: true
          description: If true, the monitor is active and makes calls to the specified URL.
        uid:
          type: string
          format: uid
          description: The monitor's unique ID.
      description: Information about the monitor.
      title: CreateUpdateMonitorResponseMonitor
    createUpdateMonitorResponse:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/CreateUpdateMonitorResponseMonitor'
          description: Information about the monitor.
      title: createUpdateMonitorResponse
    CreateMonitorRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: CreateMonitorRequestBadRequestError
    CreateMonitorRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMonitorRequestUnauthorizedError
    CreateMonitorRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMonitorRequestForbiddenError
    CreateMonitorRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateMonitorRequestInternalServerError
    monitorId:
      type: string
      title: monitorId
    GetMonitorMonitorSchedule:
      type: object
      properties:
        cron:
          type: string
          description: The monitor's POSIX cron frequency value.
        nextRun:
          type: string
          format: date-time
          description: The date and time of monitor's next scheduled run.
        timezone:
          type: string
          description: The monitor's timezone.
      description: Information about the monitor's schedule.
      title: GetMonitorMonitorSchedule
    MonitorRunStatsAssertions:
      type: object
      properties:
        total:
          type: number
          format: double
          description: The total number of tests performed.
        failed:
          type: number
          format: double
          description: The total number of test failures.
      description: Information about the monitor's tests.
      title: MonitorRunStatsAssertions
    MonitorRunStatsRequests:
      type: object
      properties:
        total:
          type: number
          format: double
          description: The total number of requests.
        failed:
          type: number
          format: double
          description: The number of request failures.
      description: Information about the monitor's requests.
      title: MonitorRunStatsRequests
    monitorRunStats:
      type: object
      properties:
        assertions:
          $ref: '#/components/schemas/MonitorRunStatsAssertions'
          description: Information about the monitor's tests.
        requests:
          $ref: '#/components/schemas/MonitorRunStatsRequests'
          description: Information about the monitor's requests.
        runCount:
          type: integer
          description: The number of monitor runs across the selected monitor regions.
        errorCount:
          type: integer
          description: The number of errors encountered during the monitor's run.
        abortedCount:
          type: integer
          description: The number of runs terminated.
        responseLatency:
          type: integer
          description: The total time it took to run the monitor, in milliseconds.
        responseSize:
          type: integer
          description: The total response size. This includes the runs in all the selected regions.
      description: Information about the monitor run's stats.
      title: monitorRunStats
    monitorLastRun:
      type: object
      properties:
        status:
          type: string
          description: The monitor's status after its last run.
        startedAt:
          type: string
          format: date-time
          description: The date and time at which the monitor's previous run started.
        finishedAt:
          type: string
          format: date-time
          description: The date and time at which the monitor's previous run completed.
        stats:
          $ref: '#/components/schemas/monitorRunStats'
      description: Information about the monitor's previous run.
      title: monitorLastRun
    GetMonitorMonitor:
      type: object
      properties:
        id:
          type: string
          description: The monitor's ID.
        name:
          type: string
          description: The monitor's name.
        uid:
          type: string
          format: uid
          description: The monitor's unique ID.
        owner:
          type: integer
          description: The ID of monitor's owner.
        active:
          type: boolean
          default: true
          description: If true, the monitor is active and makes calls to the specified URL.
        notificationLimit:
          type: number
          format: double
          minimum: 1
          maximum: 99
          description: Stop email notifications after the given number consecutive failures.
        collectionUid:
          type: string
          format: uid
          description: The unique ID of the monitor's associated collection.
        environmentUid:
          type: string
          format: uid
          description: The unique ID of the monitor's associated environment.
        jobId:
          type: string
          description: The job ID of the monitor's latest run.
        options:
          $ref: '#/components/schemas/monitorOptions'
        notifications:
          $ref: '#/components/schemas/monitorNotifications'
        distribution:
          $ref: '#/components/schemas/monitorDistribution'
        schedule:
          $ref: '#/components/schemas/GetMonitorMonitorSchedule'
          description: Information about the monitor's schedule.
        retry:
          $ref: '#/components/schemas/monitorRetry'
        lastRun:
          $ref: '#/components/schemas/monitorLastRun'
      description: Information about the monitor.
      title: GetMonitorMonitor
    getMonitor:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/GetMonitorMonitor'
          description: Information about the monitor.
      title: getMonitor
    GetMonitorRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorRequestUnauthorizedError
    GetMonitorRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorRequestForbiddenError
    GetMonitorRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMonitorRequestInternalServerError
    UpdateMonitorMonitor:
      type: object
      properties:
        name:
          type: string
          description: The monitor's name.
        active:
          type: boolean
          default: true
          description: If true, the monitor is active and makes calls to the specified URL.
        notificationLimit:
          type: number
          format: double
          minimum: 1
          maximum: 99
          description: Stop email notifications after the given number consecutive failures.
        retry:
          $ref: '#/components/schemas/monitorRetry'
        options:
          $ref: '#/components/schemas/monitorOptions'
        schedule:
          $ref: '#/components/schemas/monitorSchedule'
        distribution:
          $ref: '#/components/schemas/monitorDistribution'
        notifications:
          $ref: '#/components/schemas/monitorNotifications'
      description: Information about the monitor.
      title: UpdateMonitorMonitor
    updateMonitor:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/UpdateMonitorMonitor'
          description: Information about the monitor.
      title: updateMonitor
    UpdateMonitorRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorNameMessage'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: UpdateMonitorRequestBadRequestError
    UpdateMonitorRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMonitorRequestUnauthorizedError
    UpdateMonitorRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMonitorRequestForbiddenError
    UpdateMonitorRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateMonitorRequestInternalServerError
    DeleteMonitorMonitor:
      type: object
      properties:
        id:
          type: string
          description: The monitor's ID.
        uid:
          type: string
          format: uid
          description: The monitor's unique ID.
      description: Information about the monitor.
      title: DeleteMonitorMonitor
    deleteMonitor:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/DeleteMonitorMonitor'
          description: Information about the monitor.
      title: deleteMonitor
    DeleteMonitorRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMonitorRequestUnauthorizedError
    DeleteMonitorRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMonitorRequestForbiddenError
    DeleteMonitorRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteMonitorRequestInternalServerError
    async:
      type: boolean
      default: false
      title: async
    monitorRunInfo:
      type: object
      properties:
        jobId:
          type: string
          description: The monitor's run job ID.
        collectionUid:
          type: string
          format: uid
          description: The unique ID of the monitor's associated collection.
        environmentUid:
          type: string
          format: uid
          description: The unique ID of the monitor's associated environment.
        monitorId:
          type: string
          description: The monitor's ID.
        name:
          type: string
          description: The monitor's name.
        status:
          type: string
          description: The monitor run's status.
        startedAt:
          type: string
          format: date-time
          description: The date and time at which the monitor run began.
        finishedAt:
          type: string
          format: date-time
          description: The date and time at which the monitor's run completed.
      description: Information about the monitor.
      title: monitorRunInfo
    MonitorRunExecutionsItemsItem:
      type: object
      properties:
        name:
          type: string
          description: The executed item's name.
      description: Information about the executed item.
      title: MonitorRunExecutionsItemsItem
    monitorRunRequests:
      type: object
      properties:
        method:
          type: string
          description: The HTTP request method.
        url:
          type: string
          format: url
          description: The request's URL.
        body:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the request body, such as Content-Length.
        headers:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the request headers, such as Content-Type, Accept, encoding, and other information.
        timestamp:
          type: string
          description: The date and time of the request.
      description: Information about the monitor run's requests.
      title: monitorRunRequests
    monitorRunResponses:
      type: object
      properties:
        body:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the request body, such as Content-Length.
        code:
          type: number
          format: double
          description: The response's HTTP status code.
        headers:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the response headers, such as Content-Type, Accept, encoding, and other information.
        responseSize:
          type: number
          format: double
          description: The response size, in bytes.
        responseTime:
          type: number
          format: double
          description: The response time, in milliseconds.
      description: Information about the monitor run's response.
      title: monitorRunResponses
    MonitorRunErrorsItems:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: MonitorRunErrorsItems
    monitorRunErrors:
      type: array
      items:
        $ref: '#/components/schemas/MonitorRunErrorsItems'
      description: If the execution encounter errors, a list of errors and their information.
      title: monitorRunErrors
    MonitorRunExecutionsItems:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The execution ID.
        item:
          $ref: '#/components/schemas/MonitorRunExecutionsItemsItem'
          description: Information about the executed item.
        request:
          $ref: '#/components/schemas/monitorRunRequests'
        response:
          $ref: '#/components/schemas/monitorRunResponses'
        errors:
          $ref: '#/components/schemas/monitorRunErrors'
      title: MonitorRunExecutionsItems
    monitorRunExecutions:
      type: array
      items:
        $ref: '#/components/schemas/MonitorRunExecutionsItems'
      description: Information about the monitor run's executions.
      title: monitorRunExecutions
    RunMonitorRunFailuresItems:
      type: object
      properties: {}
      title: RunMonitorRunFailuresItems
    RunMonitorRun:
      type: object
      properties:
        info:
          $ref: '#/components/schemas/monitorRunInfo'
        stats:
          $ref: '#/components/schemas/monitorRunStats'
        executions:
          $ref: '#/components/schemas/monitorRunExecutions'
        failures:
          type: array
          items:
            $ref: '#/components/schemas/RunMonitorRunFailuresItems'
          description: If the monitor run failed, information about the run's failures.
      description: >-
        Information about the monitor run. If you pass the `async=true` query parameter, the response does not return
        the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run, call the
        GET `/monitors/{id}` endpoint.
      title: RunMonitorRun
    runMonitor:
      type: object
      properties:
        run:
          $ref: '#/components/schemas/RunMonitorRun'
          description: >-
            Information about the monitor run. If you pass the `async=true` query parameter, the response does not
            return the `stats`, `executions`, and `failures` responses. To get this information for an asynchronous run,
            call the GET `/monitors/{id}` endpoint.
      title: runMonitor
    RunMonitorRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RunMonitorRequestUnauthorizedError
    RunMonitorRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RunMonitorRequestForbiddenError
    RunMonitorRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RunMonitorRequestInternalServerError
    runnerId:
      type: string
      title: runnerId
    runnerMeta:
      type: object
      properties:
        model:
          type: string
          description: The `runnerInstance` value.
        action:
          type: string
          description: The `find` value.
        url:
          type: string
          format: uri-reference
          description: The reference URL to the resource.
        nextCursor:
          type: string
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: runnerMeta
    runnerInstance:
      type: object
      properties:
        id:
          type: string
          description: The runner instance's ID.
        hostname:
          type: string
          description: The hostname of the machine where the runner instance is running.
        uniqueId:
          type: string
          description: The runner instance's unique ID.
        cliVersion:
          type: string
          description: >-
            The version of the [Postman CLI](https://learning.postman.com/docs/postman-cli/postman-cli-overview/) used
            to start the runner instance.
        osType:
          type: string
          description: The operating system of the machine where the runner instance is running.
        runnerId:
          type: string
          description: The runner's ID.
        lastPingedAt:
          type: string
          format: date-time
          description: The last date and time the runner instance sent results to the Postman cloud.
      description: Information about the runner instance.
      title: runnerInstance
    getRunnerInstances:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/runnerMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/runnerInstance'
          description: A list of all runner instances.
      title: getRunnerInstances
    runnerErrorTypeTitleDetailCreatedAt:
      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.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        createdAt:
          type: string
          description: The date and time at which the error occurred.
      title: runnerErrorTypeTitleDetailCreatedAt
    GetRunnerInstancesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerInstancesRequestUnauthorizedError
    GetRunnerInstancesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerInstancesRequestForbiddenError
    GetRunnerInstancesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerInstancesRequestInternalServerError
    getRunnerMetrics:
      type: object
      properties:
        lastPingAt:
          type: string
          description: The last date and time the runner sent results to the Postman cloud.
        oldestQueuedRunAgeSeconds:
          type: integer
          description: The age of the monitor, in seconds, that has been waiting the longest to run in the runner.
        queueDepth:
          type: integer
          description: The number of pending Postman monitor runs in the runner's queue.
      description: The runner instance's metrics information.
      title: getRunnerMetrics
    GetRunnerMetricsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerMetricsRequestUnauthorizedError
    GetRunnerMetricsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerMetricsRequestForbiddenError
    GetRunnerMetricsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetRunnerMetricsRequestInternalServerError
    generateOauthToken:
      type: object
      properties:
        grant_type:
          type: string
          description: The `client_credentials` OAuth grant type.
        installationAuthId:
          type: string
          description: The client's installation authentication ID.
        jwt:
          type: string
          description: >-
            A signed JWT token. The token must include `iss` (issuer), `aud` (audience), `iat` (issued at), `exp`
            (expiration timestamp), and `jti` (JWT ID).
      required:
        - grant_type
        - installationAuthId
        - jwt
      title: generateOauthToken
    GenerateOauthTokenResponseTokenType:
      type: string
      enum:
        - Bearer
      description: The `Bearer` token type.
      title: GenerateOauthTokenResponseTokenType
    generateOauthTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: A Postman OAuth 2.0 access token.
        expires_in:
          type: integer
          description: The time the token expires, in milliseconds.
        token_type:
          $ref: '#/components/schemas/GenerateOauthTokenResponseTokenType'
          description: The `Bearer` token type.
      title: generateOauthTokenResponse
    oauthTokenError:
      type: object
      properties:
        error:
          type: string
          description: The type of error.
        error_description:
          type: string
          description: Information about the error.
      title: oauthTokenError
    GenerateOauthTokenRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateOauthTokenRequestInternalServerError
    revokeOauthToken:
      type: object
      properties:
        token:
          type: string
          description: The Postman OAuth 2.0 access token to revoke.
      required:
        - token
      title: revokeOauthToken
    revokeOauthTokenResponse:
      type: object
      properties:
        success:
          type: string
          description: The `true` value.
      title: revokeOauthTokenResponse
    RevokeOauthTokenRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RevokeOauthTokenRequestInternalServerError
    GenerateToolConfigLanguage:
      type: string
      enum:
        - javascript
        - typescript
        - python
      description: The programming language to use.
      title: GenerateToolConfigLanguage
    GenerateToolConfigAgentFramework:
      type: string
      enum:
        - openai
        - mistral
        - gemini
        - anthropic
        - langchain
        - autogen
      description: The AI agent framework to use. Note that the `autogen` framework only supports the `python` language.
      title: GenerateToolConfigAgentFramework
    GenerateToolConfig:
      type: object
      properties:
        language:
          $ref: '#/components/schemas/GenerateToolConfigLanguage'
          description: The programming language to use.
        agentFramework:
          $ref: '#/components/schemas/GenerateToolConfigAgentFramework'
          description: The AI agent framework to use. Note that the `autogen` framework only supports the `python` language.
      required:
        - language
        - agentFramework
      description: Information about the request.
      title: GenerateToolConfig
    generateTool:
      type: object
      properties:
        requestId:
          type: string
          description: The public collection's request ID.
        collectionId:
          type: string
          format: uid
          description: The Public API Network collection's ID.
        config:
          $ref: '#/components/schemas/GenerateToolConfig'
          description: Information about the request.
      required:
        - requestId
        - collectionId
        - config
      title: generateTool
    GenerateToolResponseData:
      type: object
      properties:
        text:
          type: string
          description: The generated tool code.
      description: The generated response data.
      title: GenerateToolResponseData
    generateToolResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GenerateToolResponseData'
          description: The generated response data.
      title: generateToolResponse
    postbot400Error:
      type: object
      properties:
        detail:
          type: string
          description: Details about the occurrence of the error.
        status:
          type: number
          format: double
          description: The error's HTTP status code.
        title:
          type: string
          description: A short summary of the error.
        type:
          type: string
          format: uri
          description: The error type.
      title: postbot400Error
    GenerateToolRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateToolRequestInternalServerError
    elementTypeQuery:
      type: string
      enum:
        - workspace
      title: elementTypeQuery
    panElementName:
      type: string
      title: panElementName
    panSummary:
      type: string
      title: panSummary
    panElementDescription:
      type: string
      title: panElementDescription
    panAddedBy:
      type: integer
      title: panAddedBy
    sortCreatedUpdatedAt:
      type: string
      enum:
        - createdAt
        - updatedAt
      title: sortCreatedUpdatedAt
    offset:
      type: integer
      default: 0
      title: offset
    limitDefault1000:
      type: integer
      default: 1000
      title: limitDefault1000
    panParentFolderId:
      type: integer
      default: 0
      title: panParentFolderId
      deprecated: true
    GetPanElementsElementsItems:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the element was created.
        createdBy:
          type: integer
          description: The user who created the element.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the element was last updated.
        updatedBy:
          type: integer
          description: The user ID of the user who updated the element.
        addedAt:
          type: string
          format: date-time
          description: >-
            The date and time at which the element was published to your team's Private API Network. This value is the
            same as the `updatedAt` value.
        addedBy:
          type: integer
          description: The user ID of the user who published the element.
        description:
          type:
            - string
            - 'null'
          description: The element's description.
        id:
          type: string
          description: The element's ID.
        name:
          type: string
          description: The element's name.
        summary:
          type:
            - string
            - 'null'
          description: The element's summary.
        type:
          type: string
          description: The `workspace` element type.
        parentFolderId:
          type: integer
          description: The `0` value.
          deprecated: true
        href:
          type: string
          format: url
          description: The element's HREF.
      description: Information about the Private API Network element.
      title: GetPanElementsElementsItems
    GetPanElementsFoldersItems:
      type: object
      properties: {}
      title: GetPanElementsFoldersItems
      deprecated: true
    panMetadata:
      type: object
      properties:
        limit:
          type: integer
          maximum: 1000
          description: >-
            The maximum number of elements returned. If the value exceeds the maximum value of `1000`, then the system
            uses the `1000` value.
        offset:
          type: integer
          description: The zero-based offset of the first item returned.
        totalCount:
          type: integer
          description: The total number of elements.
      description: The response's non-standard meta information.
      title: panMetadata
    getPanElements:
      type: object
      properties:
        elements:
          type: array
          items:
            $ref: '#/components/schemas/GetPanElementsElementsItems'
          description: A list of Private API Network elements.
        folders:
          type: array
          items:
            $ref: '#/components/schemas/GetPanElementsFoldersItems'
          description: This property is deprecated and only returns an empty array.
          deprecated: true
        meta:
          $ref: '#/components/schemas/panMetadata'
      title: getPanElements
    ListPrivateNetworkWorkspacesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkWorkspacesRequestUnauthorizedError
    ListPrivateNetworkWorkspacesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkWorkspacesRequestForbiddenError
    ListPrivateNetworkWorkspacesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkWorkspacesRequestInternalServerError
    PanCreateWorkspaceWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        parentFolderId:
          type: integer
          default: 0
          description: The `0` value.
          deprecated: true
      required:
        - id
      title: PanCreateWorkspaceWorkspace
    panCreateWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/PanCreateWorkspaceWorkspace'
      required:
        - workspace
      title: panCreateWorkspace
    PanElementCreatedType:
      type: string
      enum:
        - workspace
      description: The `workspace` element.
      title: PanElementCreatedType
    panElementCreated:
      type: object
      properties:
        addedAt:
          type: string
          format: date-time
          description: The date and time at which the element was added.
        addedBy:
          type: integer
          description: The user who added the element.
        createdBy:
          type: integer
          description: The user who created the element.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the element was created.
        updatedBy:
          type: integer
          description: The user who last updated the element.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the element was last updated.
        type:
          $ref: '#/components/schemas/PanElementCreatedType'
          description: The `workspace` element.
        id:
          type: string
          description: The element's ID
        name:
          type: string
          description: The element's name.
        summary:
          type:
            - string
            - 'null'
          description: The element's summary.
        description:
          type:
            - string
            - 'null'
          description: The element's description.
        href:
          type: string
          format: url
          description: The element's Postman URL.
        parentFolderId:
          type:
            - integer
            - 'null'
          description: This property is deprecated.
          deprecated: true
      description: Information about the Private API Network element.
      title: panElementCreated
    AddWorkspaceToPrivateNetworkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AddWorkspaceToPrivateNetworkRequestUnauthorizedError
    AddWorkspaceToPrivateNetworkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AddWorkspaceToPrivateNetworkRequestForbiddenError
    panError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: panError
    AddWorkspaceToPrivateNetworkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: AddWorkspaceToPrivateNetworkRequestInternalServerError
    UpdatePanWorkspaceWorkspace:
      type: object
      properties:
        parentFolderId:
          type: integer
          description: The workspace's new parent folder ID.
          deprecated: true
      title: UpdatePanWorkspaceWorkspace
      deprecated: true
    updatePanWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/UpdatePanWorkspaceWorkspace'
          deprecated: true
      title: updatePanWorkspace
      deprecated: true
    Private API Network_updatePanElementOrFolder_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Private API Network_updatePanElementOrFolder_Response_200
    UpdatePanElementOrFolderRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdatePanElementOrFolderRequestUnauthorizedError
    UpdatePanElementOrFolderRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdatePanElementOrFolderRequestForbiddenError
    UpdatePanElementOrFolderRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdatePanElementOrFolderRequestInternalServerError
    DeletePanElementWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The element's ID.
      description: The Private API Network `workspace` element type.
      title: DeletePanElementWorkspace
    deletePanElement:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/DeletePanElementWorkspace'
          description: The Private API Network `workspace` element type.
      title: deletePanElement
    RemoveWorkspaceFromPrivateNetworkRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/panError'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RemoveWorkspaceFromPrivateNetworkRequestBadRequestError
    RemoveWorkspaceFromPrivateNetworkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RemoveWorkspaceFromPrivateNetworkRequestUnauthorizedError
    RemoveWorkspaceFromPrivateNetworkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RemoveWorkspaceFromPrivateNetworkRequestForbiddenError
    RemoveWorkspaceFromPrivateNetworkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RemoveWorkspaceFromPrivateNetworkRequestInternalServerError
    panRequestedBy:
      type: integer
      title: panRequestedBy
    panRequestStatus:
      type: string
      enum:
        - pending
        - denied
      title: panRequestStatus
    GetAllPanAddElementRequestsRequestsItemsStatus:
      type: string
      enum:
        - pending
        - denied
      description: The request's status.
      title: GetAllPanAddElementRequestsRequestsItemsStatus
    PanRequestElementType:
      type: string
      enum:
        - workspace
      description: The `workspace` element type.
      title: PanRequestElementType
    panRequestElement:
      type: object
      properties:
        id:
          type: string
          description: The element's ID.
        type:
          $ref: '#/components/schemas/PanRequestElementType'
          description: The `workspace` element type.
        name:
          type: string
          description: The element's name.
        summary:
          type:
            - string
            - 'null'
          description: The element's short summary.
        description:
          type:
            - string
            - 'null'
          description: The element's description.
      description: Information about the requested element.
      title: panRequestElement
    panRequestResponse:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which request was denied.
        createdBy:
          type: integer
          description: The ID of the user who denied the request.
        message:
          type: string
          description: The request's response message.
      description: >-
        Information about the response to the element's request. This object only returns when the request is denied
        with a message.
      title: panRequestResponse
    GetAllPanAddElementRequestsRequestsItems:
      type: object
      properties:
        id:
          type: integer
          description: The request's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the request was created.
        createdBy:
          type: integer
          description: The ID of the user who created the request.
        message:
          type: string
          description: The user's optional message included in the request.
        status:
          $ref: '#/components/schemas/GetAllPanAddElementRequestsRequestsItemsStatus'
          description: The request's status.
        element:
          $ref: '#/components/schemas/panRequestElement'
        response:
          $ref: '#/components/schemas/panRequestResponse'
      description: Information about the request.
      title: GetAllPanAddElementRequestsRequestsItems
    getAllPanAddElementRequests:
      type: object
      properties:
        requests:
          type: array
          items:
            $ref: '#/components/schemas/GetAllPanAddElementRequestsRequestsItems'
          description: A list of requests to add elements to the Private API Network.
        meta:
          $ref: '#/components/schemas/panMetadata'
      title: getAllPanAddElementRequests
    ListPrivateNetworkAddRequestsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/panError'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkAddRequestsRequestBadRequestError
    ListPrivateNetworkAddRequestsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkAddRequestsRequestUnauthorizedError
    ListPrivateNetworkAddRequestsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkAddRequestsRequestForbiddenError
    ListPrivateNetworkAddRequestsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ListPrivateNetworkAddRequestsRequestInternalServerError
    panRequestId:
      type: integer
      title: panRequestId
    RespondPanElementAddRequestBodyStatus:
      type: string
      enum:
        - denied
        - approved
      description: The request's approval status.
      title: RespondPanElementAddRequestBodyStatus
    RespondPanElementAddRequestBodyResponse:
      type: object
      properties:
        message:
          type: string
          description: A message that details why the user's request was denied.
      description: If the request is denied, the response to the user's request.
      title: RespondPanElementAddRequestBodyResponse
    respondPanElementAddRequestBody:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/RespondPanElementAddRequestBodyStatus'
          description: The request's approval status.
        response:
          $ref: '#/components/schemas/RespondPanElementAddRequestBodyResponse'
          description: If the request is denied, the response to the user's request.
      required:
        - status
      title: respondPanElementAddRequestBody
    RespondPanElementAddRequestApproveRequestItemsStatus:
      type: string
      enum:
        - approved
        - denied
      description: The request's status.
      title: RespondPanElementAddRequestApproveRequestItemsStatus
    RespondPanElementAddRequestApproveRequestItemsElementType:
      type: string
      enum:
        - workspace
      description: The `workspace` element type.
      title: RespondPanElementAddRequestApproveRequestItemsElementType
    RespondPanElementAddRequestApproveRequestItemsElement:
      type: object
      properties:
        id:
          type: string
          description: The element's ID.
        name:
          type: string
          description: The element's name.
        summary:
          type:
            - string
            - 'null'
          description: The element's short summary.
        description:
          type:
            - string
            - 'null'
          description: The element's description.
        type:
          $ref: '#/components/schemas/RespondPanElementAddRequestApproveRequestItemsElementType'
          description: The `workspace` element type.
        createdBy:
          type: integer
          description: The ID of the user who added the element to the Private API Network.
        createdAt:
          type: string
          format: date-time
          description: The date and time the element was added to the Private API Network.
      description: Information about the requested element.
      title: RespondPanElementAddRequestApproveRequestItemsElement
    RespondPanElementAddRequestApproveRequestItems:
      type: object
      properties:
        id:
          type: integer
          description: The request's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the request was created.
        createdBy:
          type: integer
          description: The ID of the user who created the request.
        message:
          type: string
          description: The user's optional message included in the request.
        status:
          $ref: '#/components/schemas/RespondPanElementAddRequestApproveRequestItemsStatus'
          description: The request's status.
        element:
          $ref: '#/components/schemas/RespondPanElementAddRequestApproveRequestItemsElement'
          description: Information about the requested element.
      description: Information about the Private API Network request.
      title: RespondPanElementAddRequestApproveRequestItems
    respondPanElementAddRequestApprove:
      type: object
      properties:
        request:
          type: array
          items:
            $ref: '#/components/schemas/RespondPanElementAddRequestApproveRequestItems'
          description: A list of Private API Network requests.
      title: respondPanElementAddRequestApprove
    RespondPanElementAddRequestDenyRequestItemsStatus:
      type: string
      enum:
        - approved
        - denied
      description: The request's status.
      title: RespondPanElementAddRequestDenyRequestItemsStatus
    RespondPanElementAddRequestDenyRequestItems:
      type: object
      properties:
        id:
          type: integer
          description: The request's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the request was created.
        createdBy:
          type: integer
          description: The ID of the user who created the request.
        message:
          type: string
          description: The user's optional message included in the request.
        status:
          $ref: '#/components/schemas/RespondPanElementAddRequestDenyRequestItemsStatus'
          description: The request's status.
        element:
          $ref: '#/components/schemas/panRequestElement'
        response:
          $ref: '#/components/schemas/panRequestResponse'
      description: Information about the Private API Network request.
      title: RespondPanElementAddRequestDenyRequestItems
    respondPanElementAddRequestDeny:
      type: object
      properties:
        request:
          type: array
          items:
            $ref: '#/components/schemas/RespondPanElementAddRequestDenyRequestItems'
          description: A list of Private API Network requests.
      title: respondPanElementAddRequestDeny
    Private API Network_respondPrivateNetworkAddRequest_Response_200:
      oneOf:
        - $ref: '#/components/schemas/respondPanElementAddRequestApprove'
        - $ref: '#/components/schemas/respondPanElementAddRequestDeny'
      title: Private API Network_respondPrivateNetworkAddRequest_Response_200
    RespondPrivateNetworkAddRequestRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/panError'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RespondPrivateNetworkAddRequestRequestBadRequestError
    RespondPrivateNetworkAddRequestRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RespondPrivateNetworkAddRequestRequestUnauthorizedError
    RespondPrivateNetworkAddRequestRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RespondPrivateNetworkAddRequestRequestForbiddenError
    RespondPrivateNetworkAddRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: RespondPrivateNetworkAddRequestRequestInternalServerError
    pullRequestId:
      type: string
      title: pullRequestId
    PullRequestGetSource:
      type: object
      properties:
        id:
          type: string
          description: The pull request's source ID.
        name:
          type: string
          description: The source element's name.
        forkName:
          type: string
          description: The name of the fork created from the source element.
        exists:
          type: boolean
          description: If true, whether the element is present and not deleted.
      description: Information about the pull request's source (parent) element.
      title: PullRequestGetSource
    PullRequestGetDestination:
      type: object
      properties:
        id:
          type: string
          description: The destination element's ID.
        name:
          type: string
          description: The destination element's name.
        exists:
          type: boolean
          description: If true, whether the element is present and not deleted.
      description: Information about the pull request destination element.
      title: PullRequestGetDestination
    PullRequestGetMergeStatus:
      type: string
      enum:
        - inactive
        - inprogress
        - failed
      description: |
        The pull request's current merge status:
        - `inactive` — There is no merge in progress.
        - `inprogress` — The pull request is currently merging.
        - `failed` — The pull request's merge failed.
      title: PullRequestGetMergeStatus
    PullRequestGetMerge:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/PullRequestGetMergeStatus'
          description: |
            The pull request's current merge status:
            - `inactive` — There is no merge in progress.
            - `inprogress` — The pull request is currently merging.
            - `failed` — The pull request's merge failed.
      description: Information about the current progress of the pull request's merge.
      title: PullRequestGetMerge
    PullRequestGetReviewersItems:
      type: object
      properties:
        id:
          type: string
          description: The reviewer's user ID.
        status:
          type: string
          description: |
            The reviewer's review status response. One of:
            - `approved`
            - `declined`
      title: PullRequestGetReviewersItems
    pullRequestGet:
      type: object
      properties:
        createdAt:
          type: string
          description: The date and time at which the pull request was created.
        updatedAt:
          type: string
          description: The date and time at which the pull request was updated.
        id:
          type: string
          description: The pull request's ID.
        title:
          type: string
          description: The pull request's title.
        description:
          type: string
          description: The pull request's description.
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
        updatedBy:
          type: string
          description: The ID of the user who last updated the pull request.
        comment:
          type: string
          description: If the pull request is a `decline` status, an optional comment about why the pull request was declined.
        fortkType:
          type: string
          description: The type of element the pull request was forked from.
        source:
          $ref: '#/components/schemas/PullRequestGetSource'
          description: Information about the pull request's source (parent) element.
        destination:
          $ref: '#/components/schemas/PullRequestGetDestination'
          description: Information about the pull request destination element.
        status:
          type: string
          description: |
            The pull request's current review status:
            - `open` — The pull request is still open.
            - `approved` — The pull request was approved by its reviewers.
            - `declined` — The pull request was not approved by its reviewers.
        merge:
          $ref: '#/components/schemas/PullRequestGetMerge'
          description: Information about the current progress of the pull request's merge.
        reviewers:
          type: array
          items:
            $ref: '#/components/schemas/PullRequestGetReviewersItems'
          description: Information about the reviewers assigned to the pull request.
      title: pullRequestGet
    GetPullRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetPullRequestRequestInternalServerError
    pullRequestUpdate:
      type: object
      properties:
        title:
          type: string
          description: The pull request's updated title.
        description:
          type: string
          description: The updated pull request description.
        reviewers:
          type: array
          items:
            type: string
          description: >-
            An updated list of the pull request's assigned reviewers. This replaces all existing users assigned to the
            pull request with those you pass in the request body.
      required:
        - title
        - reviewers
      title: pullRequestUpdate
    PullRequestUpdatedStatus:
      type: string
      enum:
        - open
        - approved
        - declined
        - merged
      description: The pull request's status.
      title: PullRequestUpdatedStatus
    pullRequestUpdated:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the pull request was created.
        createdBy:
          type: string
          description: The ID of the user who created the pull request.
        description:
          type: string
          description: The pull request's description.
        destinationId:
          type: string
          format: uid
          description: The pull request's merge destination ID.
        forkType:
          type: string
          description: The type of forked element.
        id:
          type: string
          description: The pull request's ID.
        sourceId:
          type: string
          format: uid
          description: The unique ID of the source element.
        status:
          $ref: '#/components/schemas/PullRequestUpdatedStatus'
          description: The pull request's status.
        title:
          type: string
          description: The pull request's title.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the pull request was updated.
      title: pullRequestUpdated
    UpdatePullRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdatePullRequestRequestInternalServerError
    PullRequestReviewAction:
      type: string
      enum:
        - approve
        - decline
        - merge
        - unapprove
      description: |
        The action to perform on the pull request:
        - `approve` — Approve the pull request for merge.
        - `decline` — Decline the pull request.
        - `merge` — Merge the pull request into its parent element.
        - `unapprove` — Revokes a pull request's `approve` status. This action does not decline the pull request.
      title: PullRequestReviewAction
    pullRequestReview:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/PullRequestReviewAction'
          description: |
            The action to perform on the pull request:
            - `approve` — Approve the pull request for merge.
            - `decline` — Decline the pull request.
            - `merge` — Merge the pull request into its parent element.
            - `unapprove` — Revokes a pull request's `approve` status. This action does not decline the pull request.
        comment:
          type: string
          description: If the pull request is a `decline` status, an optoinal comment about why the pull request was declined.
      required:
        - action
      title: pullRequestReview
    PullRequestReviewReponseReviewedBy:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The user's ID.
        name:
          type: string
          description: The user's name.
        username:
          type: string
          description: The user's username.
      description: Information about the user who reviewed the pull request review.
      title: PullRequestReviewReponseReviewedBy
    pullRequestReviewReponse:
      type: object
      properties:
        id:
          type: string
          description: The pull request's ID.
        reviewedBy:
          $ref: '#/components/schemas/PullRequestReviewReponseReviewedBy'
          description: Information about the user who reviewed the pull request review.
        status:
          type: string
          description: |
            The pull request's current review status:
            - `open` — The pull request is still open.
            - `approved` — The pull request was approved by its reviewers.
            - `declined` — The pull request was not approved by its reviewers.
            - `merged` — The pull request was merged.
        updatedAt:
          type: string
          description: The date and time at which the pull request was updated.
      title: pullRequestReviewReponse
    ReviewPullRequestRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ReviewPullRequestRequestInternalServerError
    startIndex:
      type: number
      format: double
      minimum: 1
      default: 1
      title: startIndex
    count:
      type: number
      format: double
      default: 100
      title: count
    scimGroupFilter:
      type: string
      title: scimGroupFilter
    ScimGroupResourceMembersItems:
      type: object
      properties:
        value:
          type: string
          description: The resource value.
        display:
          type: string
          description: The resource's display name.
      description: Information about the group's members.
      title: ScimGroupResourceMembersItems
    ScimGroupResourceMeta:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type.
        created:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the group was last modified.
      description: The response's non-standard meta information.
      title: ScimGroupResourceMeta
    scimGroupResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The group's SCIM ID.
        displayName:
          type: string
          description: The group's display name.
        members:
          type: array
          items:
            $ref: '#/components/schemas/ScimGroupResourceMembersItems'
          description: A list of the group's members.
        externalId:
          type: string
          description: The group's external ID.
        meta:
          $ref: '#/components/schemas/ScimGroupResourceMeta'
          description: The response's non-standard meta information.
      description: The SCIM group resource object.
      title: scimGroupResource
    getScimGroupResources:
      type: object
      properties:
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/scimGroupResource'
          description: A list of group resources.
        itemsPerPage:
          type: number
          format: double
          description: The number of items per response page.
        schemas:
          type: array
          items:
            type: string
        startIndex:
          type: number
          format: double
          description: The index entry by which the returned results begin.
        totalResults:
          type: number
          format: double
          description: The total number of results found.
      title: getScimGroupResources
    scimError:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        detail:
          type: string
          description: Information about the error.
        status:
          type: string
          format: http-status-code
          description: The HTTP status code.
      title: scimError
    CreateScimGroupMembersItems:
      type: object
      properties:
        value:
          type: string
          description: The user's SCIM ID.
        display:
          type: string
          description: The user's display name.
      description: Information about the group's members.
      title: CreateScimGroupMembersItems
    createScimGroup:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        displayName:
          type: string
          description: The group's display name.
        members:
          type: array
          items:
            $ref: '#/components/schemas/CreateScimGroupMembersItems'
          description: A list of the group's members.
      title: createScimGroup
    CreateScimGroupResponseMembersItems:
      type: object
      properties:
        value:
          type: string
          description: The user's SCIM ID.
        display:
          type: string
          description: The user's display name.
      description: Information about the group's members.
      title: CreateScimGroupResponseMembersItems
    CreateScimGroupResponseMeta:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the group was last modified.
        resourceType:
          type: string
          description: The SCIM resource type.
      description: The response's non-standard meta information.
      title: CreateScimGroupResponseMeta
    createScimGroupResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The group's SCIM ID.
        displayName:
          type: string
          description: The group's display name.
        externalId:
          type: string
          description: The group's external ID.
        members:
          type: array
          items:
            $ref: '#/components/schemas/CreateScimGroupResponseMembersItems'
          description: A list of the group's members.
        meta:
          $ref: '#/components/schemas/CreateScimGroupResponseMeta'
          description: The response's non-standard meta information.
      title: createScimGroupResponse
    scimErrorScimType:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        scimType:
          type: string
          description: The SCIM error type.
        detail:
          type: string
          description: Information about the error.
        status:
          type: string
          format: http-status-code
          description: The HTTP status code.
      title: scimErrorScimType
    CreateScimGroupRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/scimErrorScimType'
        - $ref: '#/components/schemas/scimError'
      title: CreateScimGroupRequestBadRequestError
    scimId:
      type: string
      title: scimId
    GetScimGroupResourceMembersItems:
      type: object
      properties:
        value:
          type: string
          description: The member's SCIM ID.
        display:
          type: string
          description: The member's display name.
      description: Information about the group's members.
      title: GetScimGroupResourceMembersItems
    GetScimGroupResourceMeta:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type.
        created:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the group was last modified.
      description: The response's non-standard meta information.
      title: GetScimGroupResourceMeta
    getScimGroupResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The group's SCIM ID.
        displayName:
          type: string
          description: The group's display name.
        members:
          type: array
          items:
            $ref: '#/components/schemas/GetScimGroupResourceMembersItems'
          description: A list of the group's members.
        externalId:
          type: string
          description: The group's external ID.
        meta:
          $ref: '#/components/schemas/GetScimGroupResourceMeta'
          description: The response's non-standard meta information.
      title: getScimGroupResource
    ScimUpdateGroupOperationsItemsOp:
      type: string
      enum:
        - replace
        - remove
        - add
      description: The operation to perform.
      title: ScimUpdateGroupOperationsItemsOp
    ScimUpdateGroupOperationsItemsValue:
      type: object
      properties:
        id:
          type: string
          description: The group's ID.
        displayName:
          type: string
          description: The group's name.
      description: The performed operation's value.
      title: ScimUpdateGroupOperationsItemsValue
    ScimUpdateGroupOperationsItems:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/ScimUpdateGroupOperationsItemsOp'
          description: The operation to perform.
        path:
          type: string
          description: The operation's path. Include this value when you update a group's members.
        value:
          $ref: '#/components/schemas/ScimUpdateGroupOperationsItemsValue'
          description: The performed operation's value.
      title: ScimUpdateGroupOperationsItems
    scimUpdateGroup:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        Operations:
          type: array
          items:
            $ref: '#/components/schemas/ScimUpdateGroupOperationsItems'
          description: Information about the group update operation.
      title: scimUpdateGroup
    ScimUpdateGroupResponseMeta:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type.
        created:
          type: string
          format: date-time
          description: The date and time at which the group was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the group was last modified.
      description: The response's non-standard meta information.
      title: ScimUpdateGroupResponseMeta
    scimUpdateGroupResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The group's ID.
        displayName:
          type: string
          description: The group's name.
        externalId:
          type: string
          description: The group's external ID.
        meta:
          $ref: '#/components/schemas/ScimUpdateGroupResponseMeta'
          description: The response's non-standard meta information.
      title: scimUpdateGroupResponse
    ScimUpdateGroupRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/scimErrorScimType'
        - $ref: '#/components/schemas/scimError'
      title: ScimUpdateGroupRequestBadRequestError
    GetScimResourceTypesItemsSchemaExtensionsItems:
      type: object
      properties:
        schema:
          type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        required:
          type: boolean
          description: If true, the resource must include this schema extension.
      title: GetScimResourceTypesItemsSchemaExtensionsItems
    GetScimResourceTypesItems:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The resource's ID.
        name:
          type: string
          description: The resource's friendly name.
        endpoint:
          type: string
          description: The resource's endpoint.
        description:
          type: string
          description: The resource's description.
        schema:
          type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        schemaExtensions:
          type: array
          items:
            $ref: '#/components/schemas/GetScimResourceTypesItemsSchemaExtensionsItems'
          description: Information about the resource's schema extensions.
      title: GetScimResourceTypesItems
    getScimResourceTypes:
      type: array
      items:
        $ref: '#/components/schemas/GetScimResourceTypesItems'
      title: getScimResourceTypes
    GetScimResourceTypesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetScimResourceTypesRequestUnauthorizedError
    GetScimServiceProviderConfigPatch:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about patch configuration.
      title: GetScimServiceProviderConfigPatch
    GetScimServiceProviderConfigBulk:
      type: object
      properties:
        maxOperations:
          type: number
          format: double
          description: The total number of maximum operations allowed for bulk operations.
        maxPayloadSize:
          type: number
          format: double
          description: The maximum payload allowed for bulk operations.
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about bulk configuration.
      title: GetScimServiceProviderConfigBulk
    GetScimServiceProviderConfigFilter:
      type: object
      properties:
        maxResults:
          type: number
          format: double
          description: The total number of maximum results allowed for filter operations.
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about the filter configuration.
      title: GetScimServiceProviderConfigFilter
    GetScimServiceProviderConfigChangePassword:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about the change password configuration.
      title: GetScimServiceProviderConfigChangePassword
    GetScimServiceProviderConfigSort:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: Information about the sort configuration.
      title: GetScimServiceProviderConfigSort
    GetScimServiceProviderConfigAuthenticationSchemesItems:
      type: object
      properties:
        description:
          type: string
          description: The scheme's description.
        name:
          type: string
          description: The scheme's friendly name.
        specUri:
          type: string
          format: url
          description: A link to the scheme's specification documentation.
        type:
          type: string
          description: The scheme's type.
      description: Information about the scheme.
      title: GetScimServiceProviderConfigAuthenticationSchemesItems
    GetScimServiceProviderConfigEtag:
      type: object
      properties:
        supported:
          type: boolean
          description: If true, the feature is supported.
      description: >-
        Information about the [entity tag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) (Etag) HTTP
        response header configuration.
      title: GetScimServiceProviderConfigEtag
    GetScimServiceProviderConfigMeta:
      type: object
      properties:
        resourceType:
          type: string
        location:
          type: string
          format: url
      description: The response's non-standard meta information.
      title: GetScimServiceProviderConfigMeta
    getScimServiceProviderConfig:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        documentationUri:
          type: string
          format: url
          description: A link to the URI's documentation.
        patch:
          $ref: '#/components/schemas/GetScimServiceProviderConfigPatch'
          description: Information about patch configuration.
        bulk:
          $ref: '#/components/schemas/GetScimServiceProviderConfigBulk'
          description: Information about bulk configuration.
        filter:
          $ref: '#/components/schemas/GetScimServiceProviderConfigFilter'
          description: Information about the filter configuration.
        changePassword:
          $ref: '#/components/schemas/GetScimServiceProviderConfigChangePassword'
          description: Information about the change password configuration.
        sort:
          $ref: '#/components/schemas/GetScimServiceProviderConfigSort'
          description: Information about the sort configuration.
        authenticationSchemes:
          type: array
          items:
            $ref: '#/components/schemas/GetScimServiceProviderConfigAuthenticationSchemesItems'
          description: A list of authentication schemes.
        etag:
          $ref: '#/components/schemas/GetScimServiceProviderConfigEtag'
          description: >-
            Information about the [entity tag](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) (Etag)
            HTTP response header configuration.
        meta:
          $ref: '#/components/schemas/GetScimServiceProviderConfigMeta'
          description: The response's non-standard meta information.
      description: Information about Postman's SCIM API configurations and supported operations.
      title: getScimServiceProviderConfig
    scimUserFilter:
      type: string
      title: scimUserFilter
    ScimUserResourceName:
      type: object
      properties:
        givenName:
          type: string
          description: The team member's first name.
        familyName:
          type: string
          description: The team member's last name.
      description: Information about the Postman team member.
      title: ScimUserResourceName
    ScimUserResourceMeta:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type.
        created:
          type: string
          format: date-time
          description: The date and time at which the team member was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the team member was last modified.
      description: The response's non-standard meta information.
      title: ScimUserResourceMeta
    scimUserResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The team member's SCIM ID.
        userName:
          type: string
          description: The team member's SCIM username.
        name:
          $ref: '#/components/schemas/ScimUserResourceName'
          description: Information about the Postman team member.
        externalId:
          type: string
          description: The team member's external ID.
        active:
          type: boolean
          description: If true, the team member is active.
        meta:
          $ref: '#/components/schemas/ScimUserResourceMeta'
          description: The response's non-standard meta information.
      description: The SCIM user resource object.
      title: scimUserResource
    scimUserResources:
      type: object
      properties:
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/scimUserResource'
          description: A list of user resources.
        itemsPerPage:
          type: number
          format: double
          description: The number of items per response page.
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        startIndex:
          type: number
          format: double
          description: The index entry by which the returned results begin.
        totalResults:
          type: number
          format: double
          description: The total number of results found.
      title: scimUserResources
    CreateScimUserName:
      type: object
      properties:
        givenName:
          type: string
          description: The user's first name.
        familyName:
          type: string
          description: The user's last name.
      description: Information about the user's name.
      title: CreateScimUserName
    createScimUser:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        userName:
          type: string
          description: The user's username.
        active:
          type: boolean
          description: If true, activates the user. This lets them authenticate in to your Postman team.
        externalId:
          type: string
          description: The user's external ID.
        groups:
          type: array
          items:
            type: string
          description: A list of groups to assign the user to.
        locale:
          type: string
          description: The user's [IETF language tag](https://datatracker.ietf.org/doc/html/rfc5646).
        name:
          $ref: '#/components/schemas/CreateScimUserName'
          description: Information about the user's name.
      title: createScimUser
    CreateScimUserResponseName:
      type: object
      properties:
        givenName:
          type: string
          description: The user's first name.
        familyName:
          type: string
          description: The user's last name.
      title: CreateScimUserResponseName
    CreateScimUserResponseMetaResourceType:
      type: string
      enum:
        - User
      description: The SCIM resource type.
      title: CreateScimUserResponseMetaResourceType
    CreateScimUserResponseMeta:
      type: object
      properties:
        created:
          type: string
          format: date-time
          description: The date and time at which the user was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the user was last modified.
        resourceType:
          $ref: '#/components/schemas/CreateScimUserResponseMetaResourceType'
          description: The SCIM resource type.
      description: The response's non-standard meta information.
      title: CreateScimUserResponseMeta
    createScimUserResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The user's SCIM ID.
        userName:
          type: string
          format: email
          description: The user's username.
        name:
          $ref: '#/components/schemas/CreateScimUserResponseName'
        externalId:
          type: string
          description: The user's external ID.
        active:
          type: boolean
          description: If true, the user is active.
        meta:
          $ref: '#/components/schemas/CreateScimUserResponseMeta'
          description: The response's non-standard meta information.
      title: createScimUserResponse
    CreateScimUserRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/scimErrorScimType'
        - $ref: '#/components/schemas/scimError'
      title: CreateScimUserRequestBadRequestError
    ScimUserResourceResponseName:
      type: object
      properties:
        givenName:
          type: string
          description: The team member's first name.
        familyName:
          type: string
          description: The team member's last name.
      description: Information about the Postman team member.
      title: ScimUserResourceResponseName
    ScimUserResourceResponseMeta:
      type: object
      properties:
        resourceType:
          type: string
          description: The resource type.
        created:
          type: string
          format: date-time
          description: The date and time at which the team member was created.
        lastModified:
          type: string
          format: date-time
          description: The date and time at which the team member was last modified.
      description: The response's non-standard meta information.
      title: ScimUserResourceResponseMeta
    scimUserResourceResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        id:
          type: string
          description: The team member's SCIM ID.
        userName:
          type: string
          description: The team member's SCIM username.
        name:
          $ref: '#/components/schemas/ScimUserResourceResponseName'
          description: Information about the Postman team member.
        externalId:
          type: string
          description: The team member's external ID.
        active:
          type: boolean
          description: If true, the team member is active.
        meta:
          $ref: '#/components/schemas/ScimUserResourceResponseMeta'
          description: The response's non-standard meta information.
      title: scimUserResourceResponse
    UpdateScimUserName:
      type: object
      properties:
        givenName:
          type: string
          description: The user's first name.
        familyName:
          type: string
          description: The user's last name.
      description: Information about the user's name.
      title: UpdateScimUserName
    updateScimUser:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        userName:
          type: string
          format: email
          description: The user's email address.
        name:
          $ref: '#/components/schemas/UpdateScimUserName'
          description: Information about the user's name.
        active:
          type: boolean
          description: >
            Sets the user's `active` state:

            - `true` — Activates the user. This lets them authenticate in to your Postman team.

            - `false` — Removes the user from your Postman team and deactivates the account. This blocks the user from
            authenticating in to Postman.
      title: updateScimUser
    UpdateScimUserRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/scimError'
        - $ref: '#/components/schemas/scimErrorScimType'
      title: UpdateScimUserRequestBadRequestError
    UpdateScimUserPatchOneOf0OperationsItemsOp:
      type: string
      enum:
        - replace
      description: The operation to perform.
      title: UpdateScimUserPatchOneOf0OperationsItemsOp
    UpdateScimUserPatchOneOf0OperationsItemsValue:
      type: object
      properties:
        active:
          type: boolean
          description: >
            Sets the user's `active` state:

            - `true` — Activates the user. This lets them authenticate in to your Postman team.

            - `false` — Removes the user from your Postman team and deactivates the account. This blocks the user from
            authenticating in to Postman.
      description: The performed operation's value.
      title: UpdateScimUserPatchOneOf0OperationsItemsValue
    UpdateScimUserPatchOneOf0OperationsItems:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf0OperationsItemsOp'
          description: The operation to perform.
        value:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf0OperationsItemsValue'
          description: The performed operation's value.
      title: UpdateScimUserPatchOneOf0OperationsItems
    UpdateScimUserPatch0:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        Operations:
          type: array
          items:
            $ref: '#/components/schemas/UpdateScimUserPatchOneOf0OperationsItems'
          description: Information about the user update operation.
      title: UpdateScimUserPatch0
    UpdateScimUserPatchOneOf1OperationsItemsOp:
      type: string
      enum:
        - replace
      description: The operation to perform. Accepts the `replace` value.
      title: UpdateScimUserPatchOneOf1OperationsItemsOp
    UpdateScimUserPatchOneOf1OperationsItemsPath:
      type: string
      enum:
        - userName
      description: The operation's path. Accepts the `userName` value.
      title: UpdateScimUserPatchOneOf1OperationsItemsPath
    UpdateScimUserPatchOneOf1OperationsItems:
      type: object
      properties:
        op:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf1OperationsItemsOp'
          description: The operation to perform. Accepts the `replace` value.
        path:
          $ref: '#/components/schemas/UpdateScimUserPatchOneOf1OperationsItemsPath'
          description: The operation's path. Accepts the `userName` value.
        value:
          type: string
          format: email
          description: The user's email address.
      title: UpdateScimUserPatchOneOf1OperationsItems
    UpdateScimUserPatch1:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          description: The [SCIM schema URI](https://www.iana.org/assignments/scim/scim.xhtml).
        Operations:
          type: array
          items:
            $ref: '#/components/schemas/UpdateScimUserPatchOneOf1OperationsItems'
          description: Information about the user update operation.
      title: UpdateScimUserPatch1
    updateScimUserPatch:
      oneOf:
        - $ref: '#/components/schemas/UpdateScimUserPatch0'
        - $ref: '#/components/schemas/UpdateScimUserPatch1'
      title: updateScimUserPatch
    UpdateScimUserPatchRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/scimError'
        - $ref: '#/components/schemas/scimErrorScimType'
      title: UpdateScimUserPatchRequestBadRequestError
    sdkId:
      type: string
      description: The SDK's ID.
      title: sdkId
    sdkBuildStatus:
      type: string
      enum:
        - queued
        - in_progress
        - succeeded
        - failed
      description: |
        The SDK's build lifecycle:
        - `queued` — Accepted but not yet started.
        - `in_progress` — The SDK generation is running and in progress.
        - `succeeded` — The archive is built and available for download.
        - `failed` — The SDK generation failed. For information, check the `error` response.
      title: sdkBuildStatus
    sdkLanguage:
      type: string
      enum:
        - typescript
        - python
        - go
        - java
        - csharp
        - ruby
        - php
        - kotlin
        - rust
        - cli
      description: The target output language for the generated SDK.
      title: sdkLanguage
    sdkSourceId:
      type: string
      title: sdkSourceId
    elementType-2:
      type: string
      enum:
        - collection
        - spec
      description: The type of Postman element.
      title: elementType-2
    sdkSource:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/elementType-2'
        id:
          type: string
          description: The ID of the Postman Collection or specification in Postman.
      required:
        - type
        - id
      description: The collection or specification that the SDK is generated from.
      title: sdkSource
    sdkErrorBuildStatusFailure:
      type: object
      properties:
        code:
          type: string
          description: The build failure's error code.
        message:
          type: string
          description: Information about the build failure.
      required:
        - code
        - message
      description: Information about the SDK build's status when `buildStatus` is `failed`.
      title: sdkErrorBuildStatusFailure
    sdkGitConnectionPRStatus:
      type: string
      enum:
        - open
        - merged
        - closed
      description: The lifecycle status of a pull request.
      title: sdkGitConnectionPRStatus
    sdkPullRequest:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: The pull request's URL.
        status:
          $ref: '#/components/schemas/sdkGitConnectionPRStatus'
        sdkId:
          $ref: '#/components/schemas/sdkId'
      required:
        - url
        - status
        - sdkId
      description: >-
        If the SDK was shipped (or proposed for shipping) through a Git connection, this is a compact representation of
        the pull request that shipped it. Otherwise, this returns a `null` value.
      title: sdkPullRequest
    sdk:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/sdkId'
        language:
          $ref: '#/components/schemas/sdkLanguage'
        source:
          $ref: '#/components/schemas/sdkSource'
        workspaceId:
          type: string
          description: The ID of the workspace that owns the SDK, derived from the source entity.
        version:
          type: string
          description: >-
            The generated SDK's semantic version ID. This value is automatically assigned by the release/changelog
            pipeline.
        buildStatus:
          $ref: '#/components/schemas/sdkBuildStatus'
        error:
          $ref: '#/components/schemas/sdkErrorBuildStatusFailure'
        pullRequest:
          $ref: '#/components/schemas/sdkPullRequest'
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the SDK was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the SDK was last updated.
      required:
        - id
        - language
        - source
        - workspaceId
        - buildStatus
        - createdAt
        - updatedAt
      description: Information about the generated SDK.
      title: sdk
    metaNextCursorTotal:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
        total:
          type: integer
          minimum: 0
          description: The number of records found.
      description: The response's meta information for paginated results.
      title: metaNextCursorTotal
    sdkList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/sdk'
          description: A list of SDKs.
        meta:
          $ref: '#/components/schemas/metaNextCursorTotal'
      required:
        - data
        - meta
      title: sdkList
    SDKs_getSdks_Response_200:
      oneOf:
        - $ref: '#/components/schemas/sdkList'
      title: SDKs_getSdks_Response_200
    sdkError:
      type: object
      properties:
        type:
          type: string
          format: uri
          description: The [URI reference](https://www.rfc-editor.org/rfc/rfc3986) that identifies the type of problem.
        title:
          type: string
          description: A short summary of the problem.
        status:
          type: integer
          description: The error's HTTP status code.
        detail:
          type: string
          description: Information about the error.
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem.
        requestId:
          type: string
          description: The request's ID.
      required:
        - type
        - title
        - status
      title: sdkError
    GetSdksRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdksRequestUnauthorizedError
    GetSdksRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdksRequestForbiddenError
    GetSdksRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdksRequestInternalServerError
    sdkAuthorData:
      type: object
      properties:
        name:
          type: string
          description: The author's name.
        email:
          type: string
          format: email
          description: The author's email address.
      required:
        - name
      description: Information about the author of the generated SDK.
      title: sdkAuthorData
    httpCodesToRetry:
      type: integer
      minimum: 200
      maximum: 599
      description: An HTTP status code.
      title: httpCodesToRetry
    SdkRetryOptionsHttpMethodsToRetryItems:
      type: string
      enum:
        - GET
        - POST
        - PUT
        - DELETE
        - PATCH
        - HEAD
        - OPTIONS
        - CONNECT
        - TRACE
      title: SdkRetryOptionsHttpMethodsToRetryItems
    sdkRetryOptions:
      type: object
      properties:
        enabled:
          type: boolean
          default: true
          description: If true, the generated SDK includes retry behavior.
        maxAttempts:
          type: integer
          default: 3
          description: The maximum number of attempts to try before giving up.
        retryDelay:
          type: integer
          default: 150
          description: The base wait between attempts, in milliseconds.
        maxDelay:
          type: integer
          minimum: 0
          description: The maximum wait between attempts, in milliseconds.
        backOffFactor:
          type: number
          format: double
          exclusiveMinimum: 0
          description: The exponent base used to compute exponential backoff between attempts.
        retryDelayJitter:
          type: integer
          minimum: 0
          description: The maximum random jitter added to wait times, in milliseconds.
        httpCodesToRetry:
          type: array
          items:
            $ref: '#/components/schemas/httpCodesToRetry'
          description: A list of HTTP status codes that the SDK attempts its retries on.
        httpMethodsToRetry:
          type: array
          items:
            $ref: '#/components/schemas/SdkRetryOptionsHttpMethodsToRetryItems'
          description: A list of the HTTP methods that the SDK attempts its retries on.
      required:
        - retryDelay
      description: >-
        Retry behavior baked into the generated SDK's HTTP client. A power-user option; sensible defaults apply for any
        field left unset.
      title: sdkRetryOptions
    typescriptOptions:
      type: object
      properties:
        npmOrg:
          type: string
          description: An npm organization's scope. Don't include a trailing slash.
        npmName:
          type: string
          description: The unscoped npm package's name.
      description: TypeScript-specific SDK generation options.
      title: typescriptOptions
    pythonOptions:
      type: object
      properties:
        pypiPackageName:
          type: string
          description: The PyPI package's name.
      description: Python-specific SDK generation options.
      title: pythonOptions
    goOptions:
      type: object
      properties:
        goModuleName:
          type: string
          description: The Go module path written into the `go.mod` definition file.
      description: Go-specific SDK generation options.
      title: goOptions
    javaOptions:
      type: object
      properties:
        groupId:
          type: string
          description: The Maven group ID written into the `pom.xml` dependencies file.
        artifactId:
          type: string
          description: The Maven artifact ID written into the `pom.xml` dependencies file.
      description: Java-specific SDK generation options.
      title: javaOptions
    csharpOptions:
      type: object
      properties:
        packageId:
          type: string
          description: The NuGet package's ID.
      description: C#-specific SDK generation options.
      title: csharpOptions
    rubyOptions:
      type: object
      properties:
        gemName:
          type: string
          description: The RubyGems gem's name.
      description: Ruby-specific generation options.
      title: rubyOptions
    phpOptions:
      type: object
      properties:
        packageName:
          type: string
          description: The composer package name, in `vendor/package` format.
      description: PHP-specific SDK generation options.
      title: phpOptions
    kotlinOptions:
      type: object
      properties:
        groupId:
          type: string
          description: The Maven group ID written into the `pom.xml` dependencies file.
        artifactId:
          type: string
          description: The Maven artifact ID written into the `pom.xml` dependencies file.
      description: Kotlin-specific SDK generation options.
      title: kotlinOptions
    rustOptions:
      type: object
      properties:
        packageName:
          type: string
          description: The crates.io package's name.
      description: Rust-specific SDK generation options.
      title: rustOptions
    cliOptions:
      type: object
      properties:
        goModuleName:
          type: string
          description: The Go module's path for the generated CLI.
      description: CLI-specific SDK generation options.
      title: cliOptions
    createSdk:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/sdkSource'
        language:
          $ref: '#/components/schemas/sdkLanguage'
        sdkVersion:
          type: string
          description: >-
            An optional override for the SDK version. If this isn't provided, the next version is resolved from the
            latest auto-pull request.
        authors:
          type: array
          items:
            $ref: '#/components/schemas/sdkAuthorData'
          description: A list of package authors written into the generated manifest.
        retry:
          $ref: '#/components/schemas/sdkRetryOptions'
        typescriptOptions:
          $ref: '#/components/schemas/typescriptOptions'
        pythonOptions:
          $ref: '#/components/schemas/pythonOptions'
        goOptions:
          $ref: '#/components/schemas/goOptions'
        javaOptions:
          $ref: '#/components/schemas/javaOptions'
        csharpOptions:
          $ref: '#/components/schemas/csharpOptions'
        rubyOptions:
          $ref: '#/components/schemas/rubyOptions'
        phpOptions:
          $ref: '#/components/schemas/phpOptions'
        kotlinOptions:
          $ref: '#/components/schemas/kotlinOptions'
        rustOptions:
          $ref: '#/components/schemas/rustOptions'
        cliOptions:
          $ref: '#/components/schemas/cliOptions'
      required:
        - source
        - language
      description: >
        **Note:**


        - Only the object passed in the request body that matches the value in the `language` property gets read, and
        all other objects are ignored.

        - The language option object is optional. When the language identifier is omitted, it's derived from the
        `source` element name and its workspace.
      title: createSdk
    SDKs_createSdk_Response_202:
      type: object
      properties: {}
      description: Empty response body
      title: SDKs_createSdk_Response_202
    CreateSdkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkRequestUnauthorizedError
    CreateSdkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkRequestForbiddenError
    CreateSdkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkRequestInternalServerError
    GetSdkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkRequestUnauthorizedError
    GetSdkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkRequestForbiddenError
    GetSdkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkRequestInternalServerError
    DeleteSdkRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteSdkRequestUnauthorizedError
    DeleteSdkRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteSdkRequestForbiddenError
    DeleteSdkRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteSdkRequestInternalServerError
    sdkDownload:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/sdkId'
        language:
          $ref: '#/components/schemas/sdkLanguage'
        url:
          type: string
          format: uri
          description: A short-lived signed URL to the generated SDK archive (zip).
        expiresAt:
          type: string
          format: date-time
          description: The date and time at which the signed URL expires.
      required:
        - id
        - language
        - url
        - expiresAt
      title: sdkDownload
    GetSdkDownloadUrlRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkDownloadUrlRequestUnauthorizedError
    GetSdkDownloadUrlRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkDownloadUrlRequestForbiddenError
    GetSdkDownloadUrlRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkDownloadUrlRequestInternalServerError
    sdkGitConnectionStatus:
      type: string
      enum:
        - active
        - disconnected
        - inaccessible
      description: >
        The lifecycle status of the Git connection:

        - `active` — The connection is live and all opened pull requests ship SDK updates into the repository.

        - `disconnected` — The connection was explicitly disconnected by the owner, and no pull requests can be opened.
        The historical record is preserved.

        - `inaccessible` — Access to the repository was revoked or its no longer reachable.
      title: sdkGitConnectionStatus
    sdkGitConnectionRepositoryUrl:
      type: string
      format: uri
      description: Filter results by the canonical URL of the target Git repository.
      title: sdkGitConnectionRepositoryUrl
    sdkGitConnectionId:
      type: string
      description: The Git connection's ID.
      title: sdkGitConnectionId
    autoUpdatePullRequestsEnabled:
      type: boolean
      description: >
        If true, pull requests are opened automatically whenever the source changes or a new version of the SDK
        generator is released. If false, pull requests are opened automatically, but only for manually-triggered SDK
        regeneration. If `autoUpdatePullRequestsEnabled` isn't set, the default behavior depends on the user's Postman
        plan:


        - **Enterprise** plan users — Defaults to the `true` value.

        - **Team** plan users and read only — Defaults to the `false` value.
      title: autoUpdatePullRequestsEnabled
    simpleSdkGitConnectionPullRequest:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: The pull request's URL.
        status:
          $ref: '#/components/schemas/sdkGitConnectionPRStatus'
        sdkId:
          $ref: '#/components/schemas/sdkId'
      required:
        - url
        - status
        - sdkId
      title: simpleSdkGitConnectionPullRequest
    sdkGitConnection:
      type: object
      properties:
        sdkGitConnectionId:
          $ref: '#/components/schemas/sdkGitConnectionId'
        source:
          $ref: '#/components/schemas/sdkSource'
        language:
          $ref: '#/components/schemas/sdkLanguage'
        status:
          $ref: '#/components/schemas/sdkGitConnectionStatus'
        repositoryUrl:
          type: string
          format: uri
          description: The canonical URL of the target Git repository.
        targetBranch:
          type: string
          default: main
          description: The branch the SDK is published to. This defaults to the `main` value.
        autoUpdatePullRequestsEnabled:
          $ref: '#/components/schemas/autoUpdatePullRequestsEnabled'
        sdk:
          $ref: '#/components/schemas/sdk'
        pullRequests:
          type: array
          items:
            $ref: '#/components/schemas/simpleSdkGitConnectionPullRequest'
          description: >-
            A list of SDK update pull requests on the Git connection, in order of newest first by its `updatedAt`
            property. This returns an empty value if no pull requests have been opened yet. For full pull request
            details, use the GET `/sdk-git-connections/{sdkGitConnectionId}/pull-requests` endpoint.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the Git connection was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the Git connection was last updated.
      required:
        - sdkGitConnectionId
        - source
        - language
        - status
        - repositoryUrl
        - targetBranch
        - autoUpdatePullRequestsEnabled
        - pullRequests
        - createdAt
        - updatedAt
      description: Information about the SDK's Git connection to a Postman element.
      title: sdkGitConnection
    sdkGitConnectionList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/sdkGitConnection'
          description: A list of SDK Git connections.
        meta:
          $ref: '#/components/schemas/metaNextCursorTotal'
      required:
        - data
        - meta
      title: sdkGitConnectionList
    GetSdkGitConnectionsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionsRequestUnauthorizedError
    GetSdkGitConnectionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionsRequestForbiddenError
    GetSdkGitConnectionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionsRequestInternalServerError
    createSdkGitConnection:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/sdkSource'
        language:
          $ref: '#/components/schemas/sdkLanguage'
        repositoryUrl:
          type: string
          format: uri
          description: The canonical URL of the target Git repository.
        targetBranch:
          type: string
          default: main
          description: The branch the SDK is published to. Defaults to `main`.
        autoUpdatePullRequestsEnabled:
          $ref: '#/components/schemas/autoUpdatePullRequestsEnabled'
      required:
        - source
        - language
        - repositoryUrl
      title: createSdkGitConnection
    CreateSdkGitConnectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkGitConnectionRequestUnauthorizedError
    CreateSdkGitConnectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkGitConnectionRequestForbiddenError
    CreateSdkGitConnectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSdkGitConnectionRequestInternalServerError
    GetSdkGitConnectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionRequestUnauthorizedError
    GetSdkGitConnectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionRequestForbiddenError
    GetSdkGitConnectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionRequestInternalServerError
    UpdateSdkGitConnectionStatus:
      type: string
      enum:
        - active
        - disconnected
      description: The updated SDK Git connection lifecycle state.
      title: UpdateSdkGitConnectionStatus
    updateSdkGitConnection:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/UpdateSdkGitConnectionStatus'
          description: The updated SDK Git connection lifecycle state.
        autoUpdatePullRequestsEnabled:
          $ref: '#/components/schemas/autoUpdatePullRequestsEnabled'
      required:
        - status
      title: updateSdkGitConnection
    UpdateSdkGitConnectionRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSdkGitConnectionRequestUnauthorizedError
    UpdateSdkGitConnectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSdkGitConnectionRequestForbiddenError
    UpdateSdkGitConnectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSdkGitConnectionRequestInternalServerError
    sdkGitConnectionPullRequest:
      type: object
      properties:
        number:
          type: integer
          minimum: 1
          description: The pull request's ID.
        url:
          type: string
          format: uri
          description: The pull request's URL.
        status:
          $ref: '#/components/schemas/sdkGitConnectionPRStatus'
        sdk:
          $ref: '#/components/schemas/sdk'
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the pull request was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the pull request was last updated.
      required:
        - number
        - url
        - status
        - createdAt
        - updatedAt
      description: Information about a pull request that shipped the SDK update.
      title: sdkGitConnectionPullRequest
    sdkGitConnectionPullRequestList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/sdkGitConnectionPullRequest'
          description: A list of SDK update pull requests on the Git connection.
        meta:
          $ref: '#/components/schemas/metaNextCursorTotal'
      required:
        - data
        - meta
      title: sdkGitConnectionPullRequestList
    GetSdkGitConnectionPullRequestsRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionPullRequestsRequestUnauthorizedError
    GetSdkGitConnectionPullRequestsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionPullRequestsRequestForbiddenError
    GetSdkGitConnectionPullRequestsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSdkGitConnectionPullRequestsRequestInternalServerError
    limitDefault10Max25:
      type: integer
      minimum: 1
      maximum: 25
      default: 10
      title: limitDefault10Max25
    SearchPostmanResourcesElementType:
      type: string
      enum:
        - requests
        - collections
        - workspaces
        - environments
        - documents
        - flows
        - specs
      description: The type of Postman resource to search for.
      title: SearchPostmanResourcesElementType
    SearchPostmanResourcesOwnership:
      type: string
      enum:
        - organization
        - external
        - all
      default: organization
      description: |
        The ownership scope for search results. One of:
        - `organization` (default) — Resources owned by the user's team.
        - `external` — Resources not owned by the user's team.
        - `all` — All resources regardless of ownership.
      title: SearchPostmanResourcesOwnership
    searchFilterPrivateApiNetwork:
      type: object
      properties:
        $eq:
          type: boolean
          description: If true, return only resources that are part of the Private API Network.
        $ne:
          type: boolean
          description: If true, exclude resources that are part of the Private API Network.
      description: Filters by private API network membership. Supported for all element types.
      title: searchFilterPrivateApiNetwork
    searchFilterPublisherIsVerified:
      type: object
      properties:
        $eq:
          type: boolean
          description: If true, return only results from verified publishers.
        $ne:
          type: boolean
          description: If true, exclude results from verified publishers.
      description: Filters by publisher verification status. Supported for all element types.
      title: searchFilterPublisherIsVerified
    SearchFilterVisibilityEq:
      type: string
      enum:
        - internal
        - public
        - partner
      description: The visibility value to match.
      title: SearchFilterVisibilityEq
    SearchFilterVisibilityNe:
      type: string
      enum:
        - internal
        - public
        - partner
      description: The visibility value to exclude.
      title: SearchFilterVisibilityNe
    searchFilterVisibility:
      type: object
      properties:
        $eq:
          $ref: '#/components/schemas/SearchFilterVisibilityEq'
          description: The visibility value to match.
        $ne:
          $ref: '#/components/schemas/SearchFilterVisibilityNe'
          description: The visibility value to exclude.
      description: |
        Filters by workspace visibility. Supported for all element types. One of:
        - `internal` — Only visible to the organization's team members.
        - `public` — Visible to all Postman users.
        - `partner` — Visible to assigned external partner users.
      title: searchFilterVisibility
    searchFilterWorkspaceId:
      type: object
      properties:
        $eq:
          type: string
          description: The workspace ID to match.
        $ne:
          type: string
          description: The workspace ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/workspaceId'
          description: A list of workspace IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/workspaceId'
          description: A list of workspace IDs to exclude.
      description: Filters by workspace ID. Supported for all element types.
      title: searchFilterWorkspaceId
    searchFilterCollectionId:
      type: object
      properties:
        $eq:
          type: string
          description: The collection ID to match.
        $ne:
          type: string
          description: The collection ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/collectionUid'
          description: A list of collection IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/collectionUid'
          description: A list of collection IDs to exclude.
      description: Filters by collection ID. Supported for `requests` and `collections` only.
      title: searchFilterCollectionId
    tagName:
      type: string
      title: tagName
    searchFilterTags:
      type: object
      properties:
        $eq:
          type: string
          description: The tag to match.
        $ne:
          type: string
          description: The tag to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/tagName'
          description: A list of tags to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/tagName'
          description: A list of tags to exclude.
      description: Filters by tags. Supported for `workspaces` and `collections`.
      title: searchFilterTags
    httpMethod:
      type: string
      title: httpMethod
    searchFilterRequestHttpMethod:
      type: object
      properties:
        $eq:
          type: string
          description: The HTTP method to match.
        $ne:
          type: string
          description: The HTTP method to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/httpMethod'
          description: A list of HTTP methods to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/httpMethod'
          description: A list of HTTP methods to exclude.
      description: Filters by HTTP method (for example, `GET` or `POST`). Supported for `requests` only.
      title: searchFilterRequestHttpMethod
    searchFilterRequestId:
      type: object
      properties:
        $eq:
          type: string
          description: The request ID to match.
        $ne:
          type: string
          description: The request ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/collectionRequestId'
          description: A list of request IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/collectionRequestId'
          description: A list of request IDs to exclude.
      description: Filters by request ID. Supported for `requests` only.
      title: searchFilterRequestId
    searchFilterSpecId:
      type: object
      properties:
        $eq:
          type: string
          description: The specification ID to match.
        $ne:
          type: string
          description: The specification ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/specId'
          description: A list of specification IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/specId'
          description: A list of specification IDs to exclude.
      description: Filters by specification ID. Supported for `specs` only.
      title: searchFilterSpecId
    flowId:
      type: string
      title: flowId
    searchFilterFlowId:
      type: object
      properties:
        $eq:
          type: string
          description: The flow ID to match.
        $ne:
          type: string
          description: The flow ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/flowId'
          description: A list of flow IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/flowId'
          description: A list of flow IDs to exclude.
      description: Filters by flow ID. Supported for `flows` only.
      title: searchFilterFlowId
    workspaceDocumentId:
      type: string
      title: workspaceDocumentId
    searchFilterWorkspaceDocuments:
      type: object
      properties:
        $eq:
          type: string
          description: The workspace document ID to match.
        $ne:
          type: string
          description: The workspace document ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/workspaceDocumentId'
          description: A list of workspace document IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/workspaceDocumentId'
          description: A list of workspace document IDs to exclude.
      description: Filters by workspace document ID. Supported for workspace documents.
      title: searchFilterWorkspaceDocuments
    searchFilterEnvironmentId:
      type: object
      properties:
        $eq:
          type: string
          description: The environment ID to match.
        $ne:
          type: string
          description: The environment ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/environmentId'
          description: A list of environment IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/environmentId'
          description: A list of environment IDs to exclude.
      description: Filters by environment ID. Supported for `environments` only.
      title: searchFilterEnvironmentId
    createdByString:
      type: string
      title: createdByString
    searchFilterCreatedBy:
      type: object
      properties:
        $eq:
          type: string
          description: The creator ID to match.
        $ne:
          type: string
          description: The creator ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/createdByString'
          description: A list of creator IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/createdByString'
          description: A list of creator IDs to exclude.
      description: Filters by the resource creator's user ID. Supported for all element types.
      title: searchFilterCreatedBy
    organizationIdString:
      type: string
      title: organizationIdString
    searchFilterOrgId:
      type: object
      properties:
        $eq:
          type: string
          description: The organization ID to match.
        $ne:
          type: string
          description: The organization ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/organizationIdString'
          description: A list of organization IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/organizationIdString'
          description: A list of organization IDs to exclude.
      description: Filters by organization ID. Supported for all element types.
      title: searchFilterOrgId
    teamIdString:
      type: string
      title: teamIdString
    searchFilterTeamId:
      type: object
      properties:
        $eq:
          type: string
          description: The team ID to match.
        $ne:
          type: string
          description: The team ID to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/teamIdString'
          description: A list of team IDs to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/teamIdString'
          description: A list of team IDs to exclude.
      description: Filters by team ID. Supported for all element types.
      title: searchFilterTeamId
    searchFilterGitConnected:
      type: object
      properties:
        $eq:
          type: boolean
          description: If true, return only resources connected to Git.
        $ne:
          type: boolean
          description: If true, exclude resources connected to Git.
      description: >-
        Filters by Git connection status. Supported for `workspaces`, `collections`, `requests`, `environments`,
        `specs`, `flows`, and `documents`.
      title: searchFilterGitConnected
    collectionRequestResourceType:
      type: string
      title: collectionRequestResourceType
    searchFilterRequestResourceType:
      type: object
      properties:
        $eq:
          type: string
          description: The resource type to match.
        $ne:
          type: string
          description: The resource type to exclude.
        $in:
          type: array
          items:
            $ref: '#/components/schemas/collectionRequestResourceType'
          description: A list of resource types to match.
        $nin:
          type: array
          items:
            $ref: '#/components/schemas/collectionRequestResourceType'
          description: A list of resource types to exclude.
      description: Filters by resource type variant (for example, `http` or `grpc`). Supported for `requests` only.
      title: searchFilterRequestResourceType
    searchFilters:
      type: object
      properties:
        privateNetwork:
          $ref: '#/components/schemas/searchFilterPrivateApiNetwork'
        publisherIsVerified:
          $ref: '#/components/schemas/searchFilterPublisherIsVerified'
        visibility:
          $ref: '#/components/schemas/searchFilterVisibility'
        workspaceId:
          $ref: '#/components/schemas/searchFilterWorkspaceId'
        collectionId:
          $ref: '#/components/schemas/searchFilterCollectionId'
        tags:
          $ref: '#/components/schemas/searchFilterTags'
        method:
          $ref: '#/components/schemas/searchFilterRequestHttpMethod'
        requestId:
          $ref: '#/components/schemas/searchFilterRequestId'
        specificationId:
          $ref: '#/components/schemas/searchFilterSpecId'
        flowId:
          $ref: '#/components/schemas/searchFilterFlowId'
        documentId:
          $ref: '#/components/schemas/searchFilterWorkspaceDocuments'
        environmentId:
          $ref: '#/components/schemas/searchFilterEnvironmentId'
        createdBy:
          $ref: '#/components/schemas/searchFilterCreatedBy'
        organizationId:
          $ref: '#/components/schemas/searchFilterOrgId'
        teamId:
          $ref: '#/components/schemas/searchFilterTeamId'
        isGitConnected:
          $ref: '#/components/schemas/searchFilterGitConnected'
        type:
          $ref: '#/components/schemas/searchFilterRequestResourceType'
      description: A single filter condition.
      title: searchFilters
    searchFilterAndOperation:
      type: array
      items:
        $ref: '#/components/schemas/searchFilters'
      description: A list of filter conditions that must all be true. Each item must contain exactly one filter.
      title: searchFilterAndOperation
    SearchPostmanResourcesFilters:
      type: object
      properties:
        $and:
          $ref: '#/components/schemas/searchFilterAndOperation'
      required:
        - $and
      description: The search filters to narrow results.
      title: SearchPostmanResourcesFilters
    searchPostmanResources:
      type: object
      properties:
        q:
          type: string
          description: The search query text. This is case-insensitive.
        elementType:
          $ref: '#/components/schemas/SearchPostmanResourcesElementType'
          description: The type of Postman resource to search for.
        ownership:
          $ref: '#/components/schemas/SearchPostmanResourcesOwnership'
          default: organization
          description: |
            The ownership scope for search results. One of:
            - `organization` (default) — Resources owned by the user's team.
            - `external` — Resources not owned by the user's team.
            - `all` — All resources regardless of ownership.
        filters:
          $ref: '#/components/schemas/SearchPostmanResourcesFilters'
          description: The search filters to narrow results.
      required:
        - elementType
      title: searchPostmanResources
    searchMetaData:
      type: object
      properties:
        nextCursor:
          type: string
          description: The pagination cursor that points to the next record in the results set.
        q:
          type: string
          description: The search query text.
        total:
          type: integer
          description: The number of records found.
      description: Pagination metadata for the search results.
      title: searchMetaData
    searchResourceTeamData:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
          description: The team's ID.
        name:
          type:
            - string
            - 'null'
          description: The team's name.
      description: >-
        Information about the team associated with the resource. This returns a null value for the `user` publisher
        type.
      title: searchResourceTeamData
    searchRequestsCollectionData:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
      description: Information about the collection containing the resource. Returns only for requests.
      title: searchRequestsCollectionData
    searchResourceWorkspacesData:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        name:
          type: string
          description: The workspace's name.
      description: Information about the workspace containing the resource.
      title: searchResourceWorkspacesData
    searchResourceOrganizationData:
      type: object
      properties:
        id:
          type:
            - string
            - 'null'
          description: The organization's ID.
        name:
          type:
            - string
            - 'null'
          description: The organization's name.
        isVerified:
          type: boolean
          description: If true, the organization is verified by Postman.
      description: >-
        Information about the organization that published the resource. This returns a null value for the `user`
        publisher type.
      title: searchResourceOrganizationData
    searchResourceWebData:
      type: object
      properties:
        href:
          type: string
          format: uri
          description: The URL to view the resource in the Postman web app.
      description: The link to view the resource in the Postman web app.
      title: searchResourceWebData
    searchResourceLinksSelfData:
      type: object
      properties:
        href:
          type: string
          format: uri
          description: The URL to access the resource through the Postman API.
      description: The link to the resource through the Postman API.
      title: searchResourceLinksSelfData
    searchResourceLinksData:
      type: object
      properties:
        web:
          $ref: '#/components/schemas/searchResourceWebData'
        self:
          $ref: '#/components/schemas/searchResourceLinksSelfData'
      description: Information about the resource's hypermedia links.
      title: searchResourceLinksData
    searchPostmanResourcesResponseData:
      type: object
      properties:
        id:
          type: string
          description: The resource's ID.
        name:
          type: string
          description: The resource's name.
        method:
          type: string
          description: The request's HTTP method. Returns only for requests.
        type:
          type: string
          description: >-
            The resource type variant. For requests, returns the protocol. For workspace documents, the document's
            format, such as Markdown. Returns only for requests and documents.
        description:
          type: string
          description: A brief description of the resource, if available.
        summary:
          type: string
          description: A brief summary of the resource, if available. Returns only for workspaces and collections.
        url:
          type: string
          format: uri
          description: The request URL of the resource. Returns only for requests.
        isPinnedToWorkspace:
          type: boolean
          description: If true, the workspace document is pinned to its workspace. Returns only for workspace documents.
        tags:
          type: array
          items:
            $ref: '#/components/schemas/tagName'
          description: A list of tags associated with the resource. Returns only for workspaces and collections.
        specificationId:
          type: string
          description: The specification's ID. Returns only for specifications.
        specificationType:
          type: string
          description: The specification's type. Returns only for specifications.
        specificationName:
          type: string
          description: The specification's name. Returns only for specifications.
        isPrivateNetworkEntity:
          type: boolean
          description: Whether the resource is part of a private API network.
        createdBy:
          type: string
          description: The ID of the user who created the resource.
        team:
          $ref: '#/components/schemas/searchResourceTeamData'
        isGitConnected:
          type: boolean
          description: >-
            If true, the resource is connected to Git. Returns only for workspaces, collections, requests,
            specifications, and flows.
        collection:
          $ref: '#/components/schemas/searchRequestsCollectionData'
        workspace:
          $ref: '#/components/schemas/searchResourceWorkspacesData'
        organization:
          $ref: '#/components/schemas/searchResourceOrganizationData'
        links:
          $ref: '#/components/schemas/searchResourceLinksData'
      description: Information about the Postman resource.
      title: searchPostmanResourcesResponseData
    searchPostmanResourcesResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/searchMetaData'
        data:
          type: array
          items:
            $ref: '#/components/schemas/searchPostmanResourcesResponseData'
          description: A list of Postman elements that match the search query and filters.
      title: searchPostmanResourcesResponse
    SearchPostmanResourcesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SearchPostmanResourcesRequestInternalServerError
    include:
      type: string
      title: include
    DetectedSecretsQueriesRequestStatusesItems:
      type: string
      enum:
        - FALSE_POSITIVE
        - ACCEPTED_RISK
        - REVOKED
      description: |
        The secret resolution status type:
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: DetectedSecretsQueriesRequestStatusesItems
    DetectedSecretsQueriesRequestResourcesItemsType:
      type: string
      enum:
        - collection
        - environment
        - extensible-collection
        - globals
        - example
        - request
        - folder
        - extensible-collection-meta
        - extensible-request
        - extensible-folder
        - extensible-example
        - extensible-message
      description: The type of resource.
      title: DetectedSecretsQueriesRequestResourcesItemsType
    DetectedSecretsQueriesRequestResourcesItems:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/DetectedSecretsQueriesRequestResourcesItemsType'
          description: The type of resource.
        ids:
          type: array
          items:
            type: string
          description: A list of resource IDs.
      title: DetectedSecretsQueriesRequestResourcesItems
    DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems:
      type: string
      enum:
        - team
        - public
      description: The type of visibility setting.
      title: DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems
    detectedSecretsQueriesRequest:
      type: object
      properties:
        resolved:
          type: boolean
          description: If true, return secrets with a `resolved` status.
        secretTypes:
          type: array
          items:
            type: string
          description: A list of secrets types to query. For a list of valid IDs, use the GET `/secret-types` endpoint.
        statuses:
          type: array
          items:
            $ref: '#/components/schemas/DetectedSecretsQueriesRequestStatusesItems'
          description: A list of the types of resolution statuses to query.
        resources:
          type: array
          items:
            $ref: '#/components/schemas/DetectedSecretsQueriesRequestResourcesItems'
          description: A list of resources to query. If you use this query, you cannot also pass the `workspaceIds` query.
        workspaceIds:
          type: array
          items:
            type: string
          description: A list of workspaces IDs to query. If you use this query, you cannot also pass the `resources` query.
        workspaceVisibilities:
          type: array
          items:
            $ref: '#/components/schemas/DetectedSecretsQueriesRequestWorkspaceVisibilitiesItems'
          description: >-
            A list of workspace [visibility
            settings](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
            to query. This currently supports the `team` and `public` settings.
      title: detectedSecretsQueriesRequest
    DetectedSecretsQueriesMeta:
      type: object
      properties:
        limit:
          type: number
          format: double
          description: The maximum number of records in the paginated response.
        nextCursor:
          type:
            - string
            - 'null'
          format: base64
          description: The pagination cursor that points to the next record in the results set.
        total:
          type: number
          format: double
          description: >-
            The number of records that match the defined criteria. This is only returned when the `include` query
            parameter is passed with the `meta.total` value.
      description: The response's meta information for paginated results.
      title: DetectedSecretsQueriesMeta
    DetectedSecretsQueriesDataItemsWorkspaceVisibility:
      type: string
      enum:
        - personal
        - private
        - team
        - public
      description: >-
        The workspace's [visibility
        setting](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility).
      title: DetectedSecretsQueriesDataItemsWorkspaceVisibility
    DetectedSecretsQueriesDataItemsResolution:
      type: string
      enum:
        - FALSE_POSITIVE
        - ACCEPTED_RISK
        - REVOKED
        - ACTIVE
      description: |
        The secret's current status:
        - `ACTIVE` — The secret is active.
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: DetectedSecretsQueriesDataItemsResolution
    DetectedSecretsQueriesDataItems:
      type: object
      properties:
        detectedAt:
          type: string
          format: date-time
          description: The date and time at which the secret was first detected.
        secretType:
          type: string
          description: The type of the secret.
        workspaceVisibility:
          $ref: '#/components/schemas/DetectedSecretsQueriesDataItemsWorkspaceVisibility'
          description: >-
            The workspace's [visibility
            setting](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility).
        secretHash:
          type: string
          description: The SHA-256 hash of the detected secret.
        workspaceId:
          type: string
          description: The ID of the workspace that contains the secret.
        resourceType:
          type: string
          description: If querying by resource, the resource type.
        resourceId:
          type: string
          description: If querying by resource, the resource's ID.
        secretId:
          type: string
          description: The detected secret's ID.
        obfuscatedSecret:
          type: string
          description: The secret's obfuscated value.
        resolution:
          $ref: '#/components/schemas/DetectedSecretsQueriesDataItemsResolution'
          description: |
            The secret's current status:
            - `ACTIVE` — The secret is active.
            - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
            - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
            - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
        occurrences:
          type: number
          format: double
          description: The number of times the secret was found in the workspace.
      title: DetectedSecretsQueriesDataItems
    detectedSecretsQueries:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/DetectedSecretsQueriesMeta'
          description: The response's meta information for paginated results.
        data:
          type: array
          items:
            $ref: '#/components/schemas/DetectedSecretsQueriesDataItems'
      title: detectedSecretsQueries
    commonErrorTypeTitleStatusInstance:
      type: object
      properties:
        type:
          type: string
          description: The type of error.
        title:
          type: string
          description: A short summary of the problem.
        status:
          type: integer
          description: The HTTP status code generated by the origin server.
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
      title: commonErrorTypeTitleStatusInstance
    DetectedSecretsQueriesRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: DetectedSecretsQueriesRequestBadRequestError
    DetectedSecretsQueriesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      title: DetectedSecretsQueriesRequestForbiddenError
    secretId:
      type: string
      title: secretId
    UpdateSecretResolutionsRequestResolution:
      type: string
      enum:
        - FALSE_POSITIVE
        - REVOKED
        - ACCEPTED_RISK
      description: |
        The secret's updated resolution status:
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: UpdateSecretResolutionsRequestResolution
    updateSecretResolutionsRequest:
      type: object
      properties:
        resolution:
          $ref: '#/components/schemas/UpdateSecretResolutionsRequestResolution'
          description: |
            The secret's updated resolution status:
            - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
            - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
            - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
        workspaceId:
          type: string
          description: The ID of the workspace that contains the secret.
      required:
        - resolution
        - workspaceId
      title: updateSecretResolutionsRequest
    UpdateSecretResolutionsResolution:
      type: string
      enum:
        - FALSE_POSITIVE
        - ACCEPTED_RISK
        - REVOKED
        - ACTIVE
      description: |
        The secret's current resolution status:
        - `ACTIVE` — The secret is active.
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: UpdateSecretResolutionsResolution
    UpdateSecretResolutionsHistoryItemsResolution:
      type: string
      enum:
        - FALSE_POSITIVE
        - ACCEPTED_RISK
        - REVOKED
        - ACTIVE
      description: |
        The secret's updated resolution status:
        - `ACTIVE` — The secret is active.
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: UpdateSecretResolutionsHistoryItemsResolution
    UpdateSecretResolutionsHistoryItems:
      type: object
      properties:
        actor:
          type: number
          format: double
          description: The ID of the user that updated the secret's resolution status.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the resolution status was updated.
        resolution:
          $ref: '#/components/schemas/UpdateSecretResolutionsHistoryItemsResolution'
          description: |
            The secret's updated resolution status:
            - `ACTIVE` — The secret is active.
            - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
            - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
            - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: UpdateSecretResolutionsHistoryItems
    updateSecretResolutions:
      type: object
      properties:
        secretHash:
          type: string
          description: The SHA-256 hash of the detected secret.
        workspaceId:
          type: string
          description: The ID of the workspace that contains the secret.
        resolution:
          $ref: '#/components/schemas/UpdateSecretResolutionsResolution'
          description: |
            The secret's current resolution status:
            - `ACTIVE` — The secret is active.
            - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
            - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
            - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
        history:
          type: array
          items:
            $ref: '#/components/schemas/UpdateSecretResolutionsHistoryItems'
          description: The history of the secret's resolution status changes.
      title: updateSecretResolutions
    UpdateDetectedSecretResolutionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      title: UpdateDetectedSecretResolutionsRequestForbiddenError
    resourceType:
      type: string
      enum:
        - collection
        - environment
        - extensible-collection
        - globals
        - example
        - request
        - folder
        - extensible-collection-meta
        - extensible-request
        - extensible-folder
        - extensible-example
        - extensible-message
      title: resourceType
    GetSecretsLocationsDataItems:
      type: object
      properties:
        isResourceDeleted:
          type: boolean
          description: If true, the resource in which the secret was found was deleted.
        leakedBy:
          type: integer
          description: The ID of the user who exposed the secret.
        location:
          type: string
          description: The location where the secret was found.
        occurrences:
          type: integer
          description: The number of times the secret occurs in the location.
        parentResourceId:
          type: string
          format: uid
          description: >-
            The parent resource's unique ID. If the resource is a request, folder, or example, this value is a
            collection ID. If the resource is a collection, globals, or environment, this is the resource's ID.
        resourceId:
          type: string
          format: uid
          description: The unique ID of the resource where the secret was detected.
        resourceType:
          type: string
          description: The type of resource in which the secret was detected.
        detectedAt:
          type: string
          format: date-time
          description: The date and time at which the secret was detected.
        url:
          type: string
          description: The URL to the resource that contains the secret.
      description: Information about the secret finding locations.
      title: GetSecretsLocationsDataItems
    GetSecretsLocationsMetaActivityFeedItemsStatus:
      type: string
      enum:
        - FALSE_POSITIVE
        - ACCEPTED_RISK
        - REVOKED
        - ACTIVE
      description: |
        The secret's current resolution status:
        - `ACTIVE` — The secret is active.
        - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
        - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
        - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: GetSecretsLocationsMetaActivityFeedItemsStatus
    GetSecretsLocationsMetaActivityFeedItems:
      type: object
      properties:
        resolvedAt:
          type: string
          format: date-time
          description: The date and time at which the resolution status was last updated.
        resolvedBy:
          type: integer
          description: The ID of the user that updated the secret's resolution status.
        status:
          $ref: '#/components/schemas/GetSecretsLocationsMetaActivityFeedItemsStatus'
          description: |
            The secret's current resolution status:
            - `ACTIVE` — The secret is active.
            - `FALSE_POSITIVE` — The discovered secret is not an actual secret.
            - `REVOKED` — The secret is valid, but the user rotated their key to resolve the issue.
            - `ACCEPTED_RISK` — The Secret Scanner found the secret, but user accepts the risk of publishing it.
      title: GetSecretsLocationsMetaActivityFeedItems
    GetSecretsLocationsMeta:
      type: object
      properties:
        activityFeed:
          type: array
          items:
            $ref: '#/components/schemas/GetSecretsLocationsMetaActivityFeedItems'
          description: The history of the secret's resolution status changes.
        cursor:
          type: string
          description: The pointer to the first record of the set of paginated results.
        limit:
          type: integer
          description: The maximum number of rows to return in the response.
        nextCursor:
          type:
            - string
            - 'null'
          description: The Base64-encoded value that points to the next record in the results set.
        obfuscatedSecret:
          type: string
          description: The secret's obfuscated value.
        secretHash:
          type: string
          description: The secret's SHA-256 hash.
        secretType:
          type: string
          description: The type of thesecret.
        total:
          type: integer
          description: The total number of discovered secret locations.
      title: GetSecretsLocationsMeta
    getSecretsLocations:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetSecretsLocationsDataItems'
        meta:
          $ref: '#/components/schemas/GetSecretsLocationsMeta'
      title: getSecretsLocations
    GetDetectedSecretsLocationsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      title: GetDetectedSecretsLocationsRequestForbiddenError
    GetSecretTypesDataItemsType:
      type: string
      enum:
        - DEFAULT
        - TEAM_REGEX
      description: >
        The origin of the secret type:

        - `DEFAULT` — Supported by default in Postman.

        - `TEAM_REGEX` — A custom regex added by an Admin or Super Admin user in the **Configure Alerts** section of the
        [**Team Settings**](https://learning.postman.com/docs/administration/team-settings/) interface.
      title: GetSecretTypesDataItemsType
    GetSecretTypesDataItems:
      type: object
      properties:
        name:
          type: string
          description: The name of the secret type.
        id:
          type: string
          description: The ID of the secret type.
        type:
          $ref: '#/components/schemas/GetSecretTypesDataItemsType'
          description: >
            The origin of the secret type:

            - `DEFAULT` — Supported by default in Postman.

            - `TEAM_REGEX` — A custom regex added by an Admin or Super Admin user in the **Configure Alerts** section of
            the [**Team Settings**](https://learning.postman.com/docs/administration/team-settings/) interface.
      description: Information about the secret type.
      title: GetSecretTypesDataItems
    GetSecretTypesMeta:
      type: object
      properties:
        total:
          type: integer
          description: The total number of supported secrets.
      title: GetSecretTypesMeta
    getSecretTypes:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetSecretTypesDataItems'
        meta:
          $ref: '#/components/schemas/GetSecretTypesMeta'
      title: getSecretTypes
    GetSecretTypesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleStatusInstance'
      title: GetSecretTypesRequestForbiddenError
    serviceAccountApiKey:
      type: string
      title: serviceAccountApiKey
    generateServiceAccountTokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: The JWT access token to use to authenticate downstream service-to-service requests.
      title: generateServiceAccountTokenResponse
    GenerateServiceAccountTokenRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GenerateServiceAccountTokenRequestBadRequestError
    GenerateServiceAccountTokenRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateServiceAccountTokenRequestInternalServerError
    GetMigrationStatusStatus:
      type: string
      enum:
        - COMPLETED
        - FAILED
      description: The status of the migration.
      title: GetMigrationStatusStatus
    GetMigrationStatusDetails0:
      type: object
      properties:
        workspaceId:
          type: string
          description: The ID of the workspace the definition was migrated to.
      description: Information about the migration.
      title: GetMigrationStatusDetails0
    GetMigrationStatusDetails1:
      type: object
      properties:
        reason:
          type: string
          description: The reason the migration failed.
      description: Information about the migration.
      title: GetMigrationStatusDetails1
    getMigrationStatusDetails:
      oneOf:
        - $ref: '#/components/schemas/GetMigrationStatusDetails0'
        - $ref: '#/components/schemas/GetMigrationStatusDetails1'
      title: getMigrationStatusDetails
    getMigrationStatus:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/GetMigrationStatusStatus'
          description: The status of the migration.
        details:
          $ref: '#/components/schemas/getMigrationStatusDetails'
      title: getMigrationStatus
    GetMigrationStatus400ErrorError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        details:
          type: object
          additionalProperties:
            description: Any type
          description: Information about the error.
      title: GetMigrationStatus400ErrorError
    getMigrationStatus400Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/GetMigrationStatus400ErrorError'
      title: getMigrationStatus400Error
    GetMigrationStatusRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetMigrationStatusRequestForbiddenError
    GetMigrationStatusRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetMigrationStatusRequestInternalServerError
    migrateApiToSpecHubExistingWorkspace:
      type: object
      properties:
        workspaceId:
          type: string
          description: The ID of an existing workspace to migrate the definition to.
      required:
        - workspaceId
      title: migrateApiToSpecHubExistingWorkspace
    MigrateApiToSpecHubNewWorkspaceWorkspaceInfo:
      type: object
      properties:
        name:
          type: string
          description: The name of the workspace to create and migrate the definition to.
      required:
        - name
      description: Information about the new workspace.
      title: MigrateApiToSpecHubNewWorkspaceWorkspaceInfo
    migrateApiToSpecHubNewWorkspace:
      type: object
      properties:
        workspaceInfo:
          $ref: '#/components/schemas/MigrateApiToSpecHubNewWorkspaceWorkspaceInfo'
          description: Information about the new workspace.
      required:
        - workspaceInfo
      title: migrateApiToSpecHubNewWorkspace
    MigrateGitConnectedApiToSpecHubWorkspaceInfo:
      type: object
      properties:
        name:
          type: string
          description: The name of the workspace to create and migrate the definition to.
      required:
        - name
      description: Information about the new workspace.
      title: MigrateGitConnectedApiToSpecHubWorkspaceInfo
    MigrateGitConnectedApiToSpecHubGitInfo:
      type: object
      properties:
        path:
          type: string
          description: >-
            The directory path in the remote mono-repo containing the API's collections and definitions. This property
            expects an absolute path and only contains alphanumeric characters, slashes, hyphens, underscores, and
            periods. It cannot contain  path traversal sequences (\..\).
      required:
        - path
      description: Information about the connected remote Git mono-repo.
      title: MigrateGitConnectedApiToSpecHubGitInfo
    migrateGitConnectedApiToSpecHub:
      type: object
      properties:
        workspaceInfo:
          $ref: '#/components/schemas/MigrateGitConnectedApiToSpecHubWorkspaceInfo'
          description: Information about the new workspace.
        gitInfo:
          $ref: '#/components/schemas/MigrateGitConnectedApiToSpecHubGitInfo'
          description: Information about the connected remote Git mono-repo.
      required:
        - workspaceInfo
        - gitInfo
      title: migrateGitConnectedApiToSpecHub
    migrateApiToSpecHub:
      oneOf:
        - $ref: '#/components/schemas/migrateApiToSpecHubExistingWorkspace'
        - $ref: '#/components/schemas/migrateApiToSpecHubNewWorkspace'
        - $ref: '#/components/schemas/migrateGitConnectedApiToSpecHub'
      title: migrateApiToSpecHub
    migrateToSpecHubResponse:
      type: object
      properties:
        message:
          type: string
          description: The operation's message.
        success:
          type: boolean
          description: If true, the migration succeeded.
      title: migrateToSpecHubResponse
    MigrateApiToSpecHub400ErrorTitleMessageError:
      type: object
      properties:
        title:
          type: string
          description: A short summary of the problem.
        message:
          type: string
          description: The error message.
      title: MigrateApiToSpecHub400ErrorTitleMessageError
    migrateApiToSpecHub400ErrorTitleMessage:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageError'
      title: migrateApiToSpecHub400ErrorTitleMessage
    MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails:
      type: object
      properties:
        workspaceId:
          type: string
          description: The workspace's ID.
      description: Information about the error.
      title: MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails
    MigrateApiToSpecHub400ErrorTitleMessageDetailsError:
      type: object
      properties:
        title:
          type: string
          description: A short summary of the problem.
        details:
          $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageDetailsErrorDetails'
          description: Information about the error.
        message:
          type: string
          description: The error message.
      title: MigrateApiToSpecHub400ErrorTitleMessageDetailsError
    migrateApiToSpecHub400ErrorTitleMessageDetails:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTitleMessageDetailsError'
      title: migrateApiToSpecHub400ErrorTitleMessageDetails
    MigrateApiToSpecHub400ErrorTypeNameMessageTitleError:
      type: object
      properties:
        type:
          type: string
          description: A short summary of the problem.
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        title:
          type: string
          description: A short summary of the problem.
      title: MigrateApiToSpecHub400ErrorTypeNameMessageTitleError
    migrateApiToSpecHub400ErrorTypeNameMessageTitle:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/MigrateApiToSpecHub400ErrorTypeNameMessageTitleError'
      title: migrateApiToSpecHub400ErrorTypeNameMessageTitle
    MigrateApiToSpecHubRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessage'
        - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTitleMessageDetails'
        - $ref: '#/components/schemas/migrateApiToSpecHub400ErrorTypeNameMessageTitle'
      title: MigrateApiToSpecHubRequestBadRequestError
    MigrateApiToSpecHubRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: MigrateApiToSpecHubRequestForbiddenError
    MigrateApiToSpecHubRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: MigrateApiToSpecHubRequestInternalServerError
    elementTypeSpec:
      type: string
      enum:
        - spec
      title: elementTypeSpec
    GeneratedSpecCollectionDataState:
      type: string
      enum:
        - in-sync
        - out-of-sync
        - sync-in-progress
      description: The sync state of the collection and its API specification.
      title: GeneratedSpecCollectionDataState
    generatedSpecCollectionData:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        state:
          $ref: '#/components/schemas/GeneratedSpecCollectionDataState'
          description: The sync state of the collection and its API specification.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection was generated.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection was updated.
        createdBy:
          type: integer
          description: The user ID of the user that generated the collection.
        updatedBy:
          type: integer
          description: The ID of the user who updated the collection.
      description: Information about the collection's API specification.
      title: generatedSpecCollectionData
    metaData:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          format: base64
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: metaData
    getGeneratedCollectionSpecs:
      type: object
      properties:
        specs:
          type: array
          items:
            $ref: '#/components/schemas/generatedSpecCollectionData'
          description: A list of the collection's generated API specficiations.
        meta:
          $ref: '#/components/schemas/metaData'
      title: getGeneratedCollectionSpecs
    GetGeneratedCollectionSpecsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetGeneratedCollectionSpecsRequestForbiddenError
    GetGeneratedCollectionSpecsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetGeneratedCollectionSpecsRequestInternalServerError
    GenerateSpecFromCollectionType:
      type: string
      enum:
        - OPENAPI:2.0
        - OPENAPI:3.0
        - OPENAPI:3.1
      description: The specification's type.
      title: GenerateSpecFromCollectionType
    GenerateSpecFromCollectionFormat:
      type: string
      enum:
        - JSON
        - YAML
      description: The format of the API specification.
      title: GenerateSpecFromCollectionFormat
    generateSpecFromCollection:
      type: object
      properties:
        name:
          type: string
          description: The API specification's name.
        type:
          $ref: '#/components/schemas/GenerateSpecFromCollectionType'
          description: The specification's type.
        format:
          $ref: '#/components/schemas/GenerateSpecFromCollectionFormat'
          description: The format of the API specification.
      required:
        - name
      title: generateSpecFromCollection
    generateTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The created task ID. You can use this ID to track the status of the task.
        url:
          type: string
          description: The URL to get or poll the status of a generated spec task.
      title: generateTaskResponse
    GenerateSpecFromCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GenerateSpecFromCollectionRequestForbiddenError
    GenerateSpecFromCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateSpecFromCollectionRequestInternalServerError
    SyncCollectionWithSpecRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleMessageDetail'
      title: SyncCollectionWithSpecRequestForbiddenError
    SyncCollectionWithSpecRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SyncCollectionWithSpecRequestInternalServerError
    elementType:
      type: string
      enum:
        - collections
        - specs
      title: elementType
    elementId:
      oneOf:
        - type: string
        - type: string
          format: uid
      title: elementId
    GetAsyncTaskStatusMetaModel:
      type: string
      enum:
        - collection
        - spec
      description: The model for which the task is performing the operation.
      title: GetAsyncTaskStatusMetaModel
    GetAsyncTaskStatusMeta:
      type: object
      properties:
        action:
          type: string
          description: The task's action.
        model:
          $ref: '#/components/schemas/GetAsyncTaskStatusMetaModel'
          description: The model for which the task is performing the operation.
      description: The response's non-standard meta information.
      title: GetAsyncTaskStatusMeta
    AsyncSpecTaskStatusResourcesItems:
      type: object
      properties:
        id:
          type: string
          description: The ID of the assigned resource.
        url:
          type: string
          description: The task's assigned resource URL.
      title: AsyncSpecTaskStatusResourcesItems
    asyncSpecTaskStatus:
      type: object
      properties:
        resources:
          type: array
          items:
            $ref: '#/components/schemas/AsyncSpecTaskStatusResourcesItems'
      description: Information about the task's resources.
      title: asyncSpecTaskStatus
    GetAsyncTaskStatusStatus:
      type: string
      enum:
        - pending
        - failed
        - completed
      description: The task's current status.
      title: GetAsyncTaskStatusStatus
    getAsyncTaskStatus:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/GetAsyncTaskStatusMeta'
          description: The response's non-standard meta information.
        details:
          $ref: '#/components/schemas/asyncSpecTaskStatus'
        status:
          $ref: '#/components/schemas/GetAsyncTaskStatusStatus'
          description: The task's current status.
      title: getAsyncTaskStatus
    GetAsyncTaskStatusFailedMetaModel:
      type: string
      enum:
        - collection
        - spec
      description: The model for which the task is performing the operation.
      title: GetAsyncTaskStatusFailedMetaModel
    GetAsyncTaskStatusFailedMeta:
      type: object
      properties:
        action:
          type: string
          description: The task's action.
        model:
          $ref: '#/components/schemas/GetAsyncTaskStatusFailedMetaModel'
          description: The model for which the task is performing the operation.
      description: The response's non-standard meta information.
      title: GetAsyncTaskStatusFailedMeta
    GetAsyncTaskStatusFailedStatus:
      type: string
      enum:
        - failed
      description: The task's current status.
      title: GetAsyncTaskStatusFailedStatus
    getAsyncTaskStatusFailed:
      type: object
      properties:
        details:
          type: string
          description: Details about the generation error.
        meta:
          $ref: '#/components/schemas/GetAsyncTaskStatusFailedMeta'
          description: The response's non-standard meta information.
        status:
          $ref: '#/components/schemas/GetAsyncTaskStatusFailedStatus'
          description: The task's current status.
      title: getAsyncTaskStatusFailed
    Specs_getAsyncSpecTaskStatus_Response_200:
      oneOf:
        - $ref: '#/components/schemas/getAsyncTaskStatus'
        - $ref: '#/components/schemas/getAsyncTaskStatusFailed'
      title: Specs_getAsyncSpecTaskStatus_Response_200
    GetAsyncSpecTaskStatusRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetAsyncSpecTaskStatusRequestForbiddenError
    GetAsyncSpecTaskStatusRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAsyncSpecTaskStatusRequestInternalServerError
    specType:
      type: string
      enum:
        - OPENAPI:2.0
        - OPENAPI:3.0
        - OPENAPI:3.1
        - ASYNCAPI:2.0
        - ASYNCAPI:3.0
        - PROTOBUF:2
        - PROTOBUF:3
        - GRAPHQL
        - SMITHY:2.0
      description: The type of API specification.
      title: specType
    GetAllSpecsSpecsItems:
      type: object
      properties:
        id:
          type: string
          description: The specification's ID.
        name:
          type: string
          description: The specification's name.
        type:
          $ref: '#/components/schemas/specType'
        createdBy:
          type: integer
          description: The user ID of the user that created the specification.
        updatedBy:
          type: integer
          description: The ID of the user who updated the specification.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the specification was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the specification was updated.
      description: Information about the API specification.
      title: GetAllSpecsSpecsItems
    getAllSpecs:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/metaData'
        specs:
          type: array
          items:
            $ref: '#/components/schemas/GetAllSpecsSpecsItems'
          description: A list of API specifications.
      title: getAllSpecs
    GetAllSpecsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetAllSpecsRequestForbiddenError
    GetAllSpecsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllSpecsRequestInternalServerError
    CreateSpecFilesItemsOneOf0Type:
      type: string
      enum:
        - DEFAULT
        - ROOT
      description: >
        The type of file. This property is required when creating multi-file specifications:

        - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and
        references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

        - `DEFAULT` — A file referenced by the `ROOT` file.
      title: CreateSpecFilesItemsOneOf0Type
    CreateSpecFilesItems0:
      type: object
      properties:
        path:
          type: string
          description: The file's path. Accepts .json, .yaml, and .proto types.
        content:
          type: string
          description: The file's stringified contents.
        type:
          $ref: '#/components/schemas/CreateSpecFilesItemsOneOf0Type'
          description: >
            The type of file. This property is required when creating multi-file specifications:

            - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec
            and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

            - `DEFAULT` — A file referenced by the `ROOT` file.
      required:
        - path
        - content
        - type
      title: CreateSpecFilesItems0
    CreateSpecFilesItems1:
      type: object
      properties:
        path:
          type: string
          description: The file's path. Accepts .json, .yaml, .proto, .graphql, and .smithy file types.
        content:
          type: string
          description: The file's stringified contents.
      required:
        - path
        - content
      title: CreateSpecFilesItems1
    CreateSpecFilesItems:
      oneOf:
        - $ref: '#/components/schemas/CreateSpecFilesItems0'
        - $ref: '#/components/schemas/CreateSpecFilesItems1'
      title: CreateSpecFilesItems
    createSpec:
      type: object
      properties:
        name:
          type: string
          description: The specification's name.
        type:
          $ref: '#/components/schemas/specType'
        files:
          type: array
          items:
            $ref: '#/components/schemas/CreateSpecFilesItems'
          description: A list of the specification's files and their contents.
      required:
        - name
        - type
        - files
      title: createSpec
    createSpecResponse:
      type: object
      properties:
        name:
          type: string
          description: The API specification's name.
        type:
          $ref: '#/components/schemas/specType'
        id:
          type: string
          description: The specification's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the specification file was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was last updated.
        createdBy:
          type: integer
          description: The user ID of the user that created the file.
        updatedBy:
          type: integer
          description: The user ID of the user that last updated the specification file.
      title: createSpecResponse
    CreateSpecRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: CreateSpecRequestForbiddenError
    CreateSpecRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSpecRequestInternalServerError
    fileFormat:
      type: string
      enum:
        - json
        - yaml
        - proto
        - graphql
        - smithy
      description: The specification's file format.
      title: fileFormat
    specData:
      type: object
      properties:
        id:
          type: string
          description: The specification's ID.
        fileFormat:
          $ref: '#/components/schemas/fileFormat'
        name:
          type: string
          description: The specification's name.
        type:
          $ref: '#/components/schemas/specType'
        createdBy:
          type: integer
          description: The user ID of the user that created the specification.
        updatedBy:
          type: integer
          description: The ID of the user who updated the specification.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the specification was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the specification was updated.
      description: Information about the API specification.
      title: specData
    GetSpecRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecRequestForbiddenError
    GetSpecRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecRequestInternalServerError
    DeleteSpecRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: DeleteSpecRequestForbiddenError
    DeleteSpecRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteSpecRequestInternalServerError
    updateSpecProperties:
      type: object
      properties:
        name:
          type: string
          description: The spec's name.
      required:
        - name
      title: updateSpecProperties
    updateSpecPropertiesResponse:
      type: object
      properties:
        id:
          type: string
          description: The specification's ID.
        type:
          $ref: '#/components/schemas/specType'
        createdBy:
          type: integer
          description: The ID of the user that created the specification.
        updatedBy:
          type: integer
          description: The ID of the user that last updated the specification.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the specification was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the specification was last updated.
        name:
          type: string
          description: The API specification's name.
      title: updateSpecPropertiesResponse
    UpdateSpecPropertiesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: UpdateSpecPropertiesRequestForbiddenError
    UpdateSpecPropertiesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSpecPropertiesRequestInternalServerError
    ApiSpecSyncOptionsSyncOptions:
      type: object
      properties:
        syncExamples:
          type: boolean
          default: true
          description: >-
            If true, updates made to examples in the specification or to example values in the generated collection stay
            synchronized.
        deleteOrphanedRequests:
          type: boolean
          default: true
          description: If true, deletes requests and endpoints that no longer exist in the source during sync.
      description: Information about the specification sync options.
      title: ApiSpecSyncOptionsSyncOptions
    apiSpecSyncOptions:
      type: object
      properties:
        syncOptions:
          $ref: '#/components/schemas/ApiSpecSyncOptionsSyncOptions'
          description: Information about the specification sync options.
      title: apiSpecSyncOptions
    UpdateSpecSyncOptionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: UpdateSpecSyncOptionsRequestForbiddenError
    UpdateSpecSyncOptionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSpecSyncOptionsRequestInternalServerError
    Specs_getSpecDefinition_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Specs_getSpecDefinition_Response_200
    GetSpecDefinitionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecDefinitionRequestForbiddenError
    GetSpecDefinitionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecDefinitionRequestInternalServerError
    SpecFileDataType:
      type: string
      enum:
        - ROOT
        - DEFAULT
      description: |
        The type of file:
        - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files.
        - `DEFAULT` — A file referenced by the `ROOT` file.
      title: SpecFileDataType
    specFileData:
      type: object
      properties:
        id:
          type: string
          description: The file's ID.
        path:
          type: string
          description: The file's path.
        name:
          type: string
          description: The file's name.
        createdBy:
          type: integer
          description: The user ID of the user that created the file.
        updatedBy:
          type: integer
          description: The ID of the user who updated the file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was updated.
        type:
          $ref: '#/components/schemas/SpecFileDataType'
          description: |
            The type of file:
            - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files.
            - `DEFAULT` — A file referenced by the `ROOT` file.
      description: Information about the API specification file.
      title: specFileData
    getSpecFiles:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/specFileData'
          description: A list of the API specification's files.
        meta:
          $ref: '#/components/schemas/metaData'
      description: Information about the specification's files.
      title: getSpecFiles
    GetSpecFilesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecFilesRequestForbiddenError
    GetSpecFilesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecFilesRequestInternalServerError
    createSpecFile:
      type: object
      properties:
        path:
          type: string
          description: The file's path. Accepts JSON or YAML files.
        content:
          type: string
          description: The file's stringified contents.
      required:
        - path
        - content
      title: createSpecFile
    CreateUpdateSpecFileResponseType:
      type: string
      enum:
        - DEFAULT
        - ROOT
      default: DEFAULT
      description: >
        The type of file:

        - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and
        references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

        - `DEFAULT` — A file referenced by the `ROOT` file.
      title: CreateUpdateSpecFileResponseType
    createUpdateSpecFileResponse:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        createdBy:
          type: integer
          description: The user ID of the user that created the file.
        id:
          type: string
          description: The file's ID.
        path:
          type: string
          description: The file's path.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was updated.
        updatedBy:
          type: integer
          description: The ID of the user who updated the file.
        type:
          $ref: '#/components/schemas/CreateUpdateSpecFileResponseType'
          default: DEFAULT
          description: >
            The type of file:

            - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec
            and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

            - `DEFAULT` — A file referenced by the `ROOT` file.
      description: Information about the API specification file.
      title: createUpdateSpecFileResponse
    CreateSpecFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: CreateSpecFileRequestForbiddenError
    CreateSpecFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSpecFileRequestInternalServerError
    filePath:
      type: string
      title: filePath
    GetSpecFileType:
      type: string
      enum:
        - ROOT
        - DEFAULT
      description: |
        The type of file:
        - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files.
        - `DEFAULT` — A file referenced by the `ROOT` file.
      title: GetSpecFileType
    getSpecFile:
      type: object
      properties:
        id:
          type: string
          description: The file's ID.
        name:
          type: string
          description: The file's name.
        path:
          type: string
          description: The file's path.
        createdBy:
          type: integer
          description: The user ID of the user that created the file.
        updatedBy:
          type: integer
          description: The ID of the user who updated the file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was updated.
        type:
          $ref: '#/components/schemas/GetSpecFileType'
          description: |
            The type of file:
            - `ROOT` — A file containing the full OpenAPI structure and references other (DEFAULT) spec files.
            - `DEFAULT` — A file referenced by the `ROOT` file.
        content:
          type: string
          description: The file's stringified contents.
      description: Information about the API specification file.
      title: getSpecFile
    GetSpecFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecFileRequestForbiddenError
    GetSpecFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecFileRequestInternalServerError
    DeleteSpecFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: DeleteSpecFileRequestForbiddenError
    DeleteSpecFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteSpecFileRequestInternalServerError
    UpdateSpecFileType:
      type: string
      enum:
        - DEFAULT
        - ROOT
      description: >
        The type of file:

        - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and
        references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

        - `DEFAULT` — A file referenced by the `ROOT` file.
      title: UpdateSpecFileType
    updateSpecFile:
      type: object
      properties:
        name:
          type: string
          description: The file's name.
        type:
          $ref: '#/components/schemas/UpdateSpecFileType'
          description: >
            The type of file:

            - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec
            and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

            - `DEFAULT` — A file referenced by the `ROOT` file.
        content:
          type: string
          description: The specification's stringified contents.
      description: >-
        You must pass one of the accepted values in this request body. Also, this request body does not accept multiple
        properties in a single call. For example, you cannot pass both the `content` and `type` property at the same
        time.
      title: updateSpecFile
    UpdateSpecFileRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: UpdateSpecFileRequestForbiddenError
    UpdateSpecFileRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateSpecFileRequestInternalServerError
    elementTypeCollection:
      type: string
      enum:
        - collection
      title: elementTypeCollection
    SpecCollectionDataState:
      type: string
      enum:
        - in-sync
        - out-of-sync
        - sync-in-progress
      description: The sync state of the collection and its API specification.
      title: SpecCollectionDataState
    specCollectionData:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        state:
          $ref: '#/components/schemas/SpecCollectionDataState'
          description: The sync state of the collection and its API specification.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the collection was generated.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the collection was updated.
        createdBy:
          type: integer
          description: The user ID of the user that generated the collection.
      description: Information about the API specification's collection.
      title: specCollectionData
    getSpecCollections:
      type: object
      properties:
        collections:
          type: array
          items:
            $ref: '#/components/schemas/specCollectionData'
          description: A list of the API specification's generated collections.
        meta:
          $ref: '#/components/schemas/metaData'
      title: getSpecCollections
    GetSpecCollectionsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecCollectionsRequestForbiddenError
    GetSpecCollectionsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecCollectionsRequestInternalServerError
    generateCollection:
      type: object
      properties:
        name:
          type: string
          description: The generated collection's name.
        options:
          $ref: '#/components/schemas/generateCollectionOptions'
      required:
        - name
        - options
      title: generateCollection
    GenerateCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GenerateCollectionRequestForbiddenError
    GenerateCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GenerateCollectionRequestInternalServerError
    SyncSpecWithCollectionRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: SyncSpecWithCollectionRequestForbiddenError
    SyncSpecWithCollectionRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: SyncSpecWithCollectionRequestInternalServerError
    tagId:
      type: string
      title: tagId
    GetSpecVersionTagDataItemsType:
      type: string
      enum:
        - FILE
        - FOLDER
      description: The file's type.
      title: GetSpecVersionTagDataItemsType
    GetSpecVersionTagDataItemsFileType:
      type: string
      enum:
        - ROOT
        - DEFAULT
      description: >
        The type of file:


        - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec and
        references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

        - `DEFAULT` — A file referenced by the `ROOT` file. This file contains a subset of the OpenAPI structure, such
        as specific components or paths.


        This value doesn't return for folders.
      title: GetSpecVersionTagDataItemsFileType
    GetSpecVersionTagDataItems:
      type: object
      properties:
        id:
          type: string
          description: The file's ID.
        name:
          type: string
          description: The file's name.
        updatedBy:
          type: string
          description: The ID of the user who updated the file.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the file was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the file was updated.
        createdBy:
          type: string
          description: The user ID of the user that created the file.
        type:
          $ref: '#/components/schemas/GetSpecVersionTagDataItemsType'
          description: The file's type.
        path:
          type: string
          description: The file's path.
        fileType:
          $ref: '#/components/schemas/GetSpecVersionTagDataItemsFileType'
          description: >
            The type of file:


            - `ROOT` — The file containing the full OpenAPI structure. This serves as the entry point for the API spec
            and references other (`DEFAULT`) spec files. Multi-file specs can only have one root file.

            - `DEFAULT` — A file referenced by the `ROOT` file. This file contains a subset of the OpenAPI structure,
            such as specific components or paths.


            This value doesn't return for folders.
        content:
          type: string
          description: The file's content. Folders don't return this property.
        parentId:
          type: string
          description: The file's parent folder ID. This property is absent for ROOT-level files.
      description: Information about the element.
      title: GetSpecVersionTagDataItems
    getSpecVersionTag:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetSpecVersionTagDataItems'
          description: A list of the version tag's files and folders.
      title: getSpecVersionTag
    GetSpecVersionTagRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecVersionTagRequestForbiddenError
    GetSpecVersionTagRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecVersionTagRequestInternalServerError
    GetSpecVersionTagsDataItems:
      type: object
      properties:
        id:
          type: string
          description: The version tag's ID.
        name:
          type: string
          description: The version tag's name.
      description: Information about the version tag.
      title: GetSpecVersionTagsDataItems
    getSpecVersionTags:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetSpecVersionTagsDataItems'
          description: A list of the specification's version tags.
        meta:
          $ref: '#/components/schemas/meta'
      title: getSpecVersionTags
    GetSpecVersionTagsRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetSpecVersionTagsRequestForbiddenError
    GetSpecVersionTagsRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetSpecVersionTagsRequestInternalServerError
    createSpecVersionTag:
      type: object
      properties:
        name:
          type: string
          description: The version tag's name.
      required:
        - name
      title: createSpecVersionTag
    CreateSpecVersionTagResponseData:
      type: object
      properties:
        id:
          type: string
          description: The version tag's ID.
        name:
          type: string
          description: The version tag's name.
      description: Information about the created version tag.
      title: CreateSpecVersionTagResponseData
    createSpecVersionTagResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CreateSpecVersionTagResponseData'
          description: Information about the created version tag.
      title: createSpecVersionTagResponse
    CreateSpecVersionTagRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: CreateSpecVersionTagRequestForbiddenError
    CreateSpecVersionTagRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateSpecVersionTagRequestInternalServerError
    TagGetPutTagsItems:
      type: object
      properties:
        slug:
          type: string
          pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$
          minLength: 2
          maxLength: 64
          description: The tag's ID within a team or individual (non-team) user scope.
      description: Information about the tag.
      title: TagGetPutTagsItems
    tagGetPut:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagGetPutTagsItems'
          description: A list of associated tags.
      title: tagGetPut
    TagUpdateTagsTagsItems:
      type: object
      properties:
        slug:
          type: string
          pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$
          minLength: 2
          maxLength: 64
          description: The tag's ID within a team or individual (non-team) user scope.
      required:
        - slug
      description: Information about the tag.
      title: TagUpdateTagsTagsItems
    tagUpdateTags:
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/TagUpdateTagsTagsItems'
          description: A list of the associated tags as slugs.
      required:
        - tags
      title: tagUpdateTags
    tag400Error:
      type: object
      properties:
        title:
          type: string
          description: A short summary of the problem.
        detail:
          type: string
          description: Information about the error.
        status:
          type: integer
          description: The error's HTTP status code.
      title: tag400Error
    UpdateApiTagsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/tag400Error'
        - $ref: '#/components/schemas/apiErrorNameMessage'
      title: UpdateApiTagsRequestBadRequestError
    tagElement400Error:
      type: object
      properties:
        error:
          type: string
          description: A short summary of the problem.
        message:
          type: string
          description: The error message.
        statusCode:
          type: integer
          description: The error's HTTP status code.
      title: tagElement400Error
    UpdateCollectionTagsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/tag400Error'
        - $ref: '#/components/schemas/tagElement400Error'
      title: UpdateCollectionTagsRequestBadRequestError
    tagsSlug:
      type: string
      pattern: ^[a-z][a-z0-9-]*[a-z0-9]+$
      minLength: 2
      maxLength: 64
      title: tagsSlug
    tagsEntitiesLimit:
      type: integer
      maximum: 50
      default: 10
      title: tagsEntitiesLimit
    tagsCursor:
      type: string
      format: base64
      title: tagsCursor
    tagsEntityType:
      type: string
      enum:
        - api
        - collection
        - workspace
      title: tagsEntityType
    GetTaggedEntitiesDataEntitiesItemsEntityType:
      type: string
      enum:
        - collection
        - workspace
      description: The type of Postman element.
      title: GetTaggedEntitiesDataEntitiesItemsEntityType
    GetTaggedEntitiesDataEntitiesItems:
      type: object
      properties:
        entityId:
          type: string
          format: uid
          description: The element's unique ID.
        entityType:
          $ref: '#/components/schemas/GetTaggedEntitiesDataEntitiesItemsEntityType'
          description: The type of Postman element.
      title: GetTaggedEntitiesDataEntitiesItems
    GetTaggedEntitiesData:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/GetTaggedEntitiesDataEntitiesItems'
          description: A list of the Postman elements that contain the given tag.
      required:
        - entities
      description: An object containing the paginated elements.
      title: GetTaggedEntitiesData
    GetTaggedEntitiesMeta:
      type: object
      properties:
        count:
          type: integer
          description: The number of tagged elements returned in the response.
        nextCursor:
          type: string
          format: base64
          description: The pagination cursor that points to the next record in the results set.
      required:
        - count
      description: The response's pagination information.
      title: GetTaggedEntitiesMeta
    getTaggedEntities:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GetTaggedEntitiesData'
          description: An object containing the paginated elements.
        meta:
          $ref: '#/components/schemas/GetTaggedEntitiesMeta'
          description: The response's pagination information.
      title: getTaggedEntities
    UpdateWorkspaceTagsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/tag400Error'
        - $ref: '#/components/schemas/tagElement400Error'
      title: UpdateWorkspaceTagsRequestBadRequestError
    limitDefault50:
      type: integer
      default: 50
      title: limitDefault50
    teamSettingsQuery:
      type: boolean
      default: false
      title: teamSettingsQuery
    userRolesQuery:
      type: boolean
      default: false
      title: userRolesQuery
    identifierType:
      type: string
      title: identifierType
    TeamDataCreatedBy:
      oneOf:
        - type: integer
        - type: string
      description: The user ID of the user who created the team.
      title: TeamDataCreatedBy
    teamData:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the team was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the team was last updated.
        id:
          type: integer
          description: The team's ID.
        name:
          type: string
          description: The team's name.
        handle:
          type: string
          description: The team's handle.
        description:
          type: string
          description: A description about the team.
        organizationId:
          type: integer
          description: The team's organization ID.
        createdBy:
          $ref: '#/components/schemas/TeamDataCreatedBy'
          description: The user ID of the user who created the team.
        enabled:
          type: boolean
          description: If true, the team is active.
        memberCount:
          type: integer
          description: The number of members in the team.
      description: Information about the team.
      title: teamData
    metaDataNextCursor:
      type: object
      properties:
        nextCursor:
          type:
            - string
            - 'null'
          description: The pagination cursor that points to the next record in the results set.
      description: The response's meta information for paginated results.
      title: metaDataNextCursor
    Teams_getTeams_Response_200:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/teamData'
          description: A list of teams.
        metadata:
          $ref: '#/components/schemas/metaDataNextCursor'
      title: Teams_getTeams_Response_200
    TeamsErrorDetailError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      description: Information about the error.
      title: TeamsErrorDetailError
    teamsErrorDetail:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TeamsErrorDetailError'
          description: Information about the error.
      description: An explanation about the problem.
      title: teamsErrorDetail
    TeamsErrorDetailInvalidEntriesResultItemsEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity ID.
      title: TeamsErrorDetailInvalidEntriesResultItemsEntityId
    TeamsErrorDetailInvalidEntriesResultItems:
      type: object
      properties:
        entityType:
          type: string
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/TeamsErrorDetailInvalidEntriesResultItemsEntityId'
          description: The entity ID.
        role:
          type:
            - string
            - 'null'
          description: The assigned role.
        status:
          type: string
          description: The `Invalid` response status.
        reason:
          type: string
          description: The reason for the error.
      title: TeamsErrorDetailInvalidEntriesResultItems
    teamsErrorDetailInvalidEntries:
      type: object
      properties:
        error:
          type: string
          description: The error message.
        result:
          type: array
          items:
            $ref: '#/components/schemas/TeamsErrorDetailInvalidEntriesResultItems'
          description: A list of invalid entities.
      description: An explanation about the problem.
      title: teamsErrorDetailInvalidEntries
    TeamsErrorDetail:
      oneOf:
        - $ref: '#/components/schemas/teamsErrorDetail'
        - $ref: '#/components/schemas/teamsErrorDetailInvalidEntries'
      title: TeamsErrorDetail
    teamsError:
      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.
        status:
          type: integer
          description: The HTTP status code generated by the origin server.
        title:
          type: string
          description: A short summary of the problem.
        detail:
          $ref: '#/components/schemas/TeamsErrorDetail'
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
      title: teamsError
    GetTeamsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetTeamsRequestBadRequestError
    createTeam:
      type: object
      properties:
        name:
          type: string
          description: The team's name. Accepts only alphanumeric characters and spaces.
        description:
          type:
            - string
            - 'null'
          description: The team's description.
      title: createTeam
    CreateGetTeamResponseTeamCreatedBy:
      oneOf:
        - type: integer
        - type: string
      description: The user ID of the user who created the team.
      title: CreateGetTeamResponseTeamCreatedBy
    CreateGetTeamResponseTeam:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the team was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the team was last updated.
        id:
          type: integer
          description: The team's ID.
        name:
          type: string
          description: The team's name.
        handle:
          type: string
          description: The team's handle.
        description:
          type: string
          description: A description about the team.
        organizationId:
          type: integer
          description: The team's organization ID.
        createdBy:
          $ref: '#/components/schemas/CreateGetTeamResponseTeamCreatedBy'
          description: The user ID of the user who created the team.
        enabled:
          type: boolean
          description: If true, the team is active.
      description: Information about the team.
      title: CreateGetTeamResponseTeam
    createGetTeamResponse:
      type: object
      properties:
        team:
          $ref: '#/components/schemas/CreateGetTeamResponseTeam'
          description: Information about the team.
      title: createGetTeamResponse
    CreateTeamRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: CreateTeamRequestBadRequestError
    teamId:
      type: integer
      title: teamId
    teamsInclude:
      type: string
      enum:
        - members
        - userRoles
      title: teamsInclude
    GetTeamRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetTeamRequestBadRequestError
    GetTeamAccessRequestsDataItemsRole:
      type: string
      enum:
        - TEAM_MANAGER
        - TEAM_DEVELOPER
        - TEAM_GUEST_DEVELOPER
        - TEAM_GUEST_VIEWER
        - TEAM_PARTNER_MANAGER
        - TEAM_PARTNER_LEAD
        - TEAM_GUEST
        - TEAM_PARTNER
        - TEAM_COMMUNITY_MANAGER
      description: The requested team role.
      title: GetTeamAccessRequestsDataItemsRole
    GetTeamAccessRequestsDataItemsEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity's ID.
      title: GetTeamAccessRequestsDataItemsEntityId
    GetTeamAccessRequestsDataItemsCreatedBy:
      oneOf:
        - type: integer
        - type: string
      description: The user ID of the user who created the access request.
      title: GetTeamAccessRequestsDataItemsCreatedBy
    GetTeamAccessRequestsDataItems:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
          description: The date and time the access request was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time the access request was last updated.
        id:
          type: integer
          description: The access request's ID.
        role:
          $ref: '#/components/schemas/GetTeamAccessRequestsDataItemsRole'
          description: The requested team role.
        requestType:
          type: string
          description: The access request type.
        reason:
          type: string
          description: The reason the access request was created.
        status:
          type: string
          description: The access request's status.
        entityType:
          type: string
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/GetTeamAccessRequestsDataItemsEntityId'
          description: The entity's ID.
        objectType:
          type: string
          description: The entity type.
        objectId:
          type: integer
          description: The entity's ID.
        createdBy:
          $ref: '#/components/schemas/GetTeamAccessRequestsDataItemsCreatedBy'
          description: The user ID of the user who created the access request.
      description: Information about the access request.
      title: GetTeamAccessRequestsDataItems
    getTeamAccessRequests:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetTeamAccessRequestsDataItems'
          description: A list of access requests.
        metadata:
          $ref: '#/components/schemas/metaDataNextCursor'
      title: getTeamAccessRequests
    GetTeamAccessRequestsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetTeamAccessRequestsRequestBadRequestError
    TeamEntityInfoEntityType:
      type: string
      enum:
        - user
        - group
        - team
        - organization
      description: The entity type.
      title: TeamEntityInfoEntityType
    TeamEntityInfoEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity's ID.
      title: TeamEntityInfoEntityId
    teamEntityInfo:
      type: object
      properties:
        entityType:
          $ref: '#/components/schemas/TeamEntityInfoEntityType'
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/TeamEntityInfoEntityId'
          description: The entity's ID.
      required:
        - entityType
        - entityId
      title: teamEntityInfo
    CreateAccessRequestRole:
      type: string
      enum:
        - TEAM_MANAGER
        - TEAM_DEVELOPER
        - TEAM_GUEST_DEVELOPER
        - TEAM_GUEST_VIEWER
        - TEAM_PARTNER_MANAGER
        - TEAM_PARTNER_LEAD
        - TEAM_GUEST
        - TEAM_PARTNER
        - TEAM_COMMUNITY_MANAGER
      description: The team role to request.
      title: CreateAccessRequestRole
    CreateAccessRequestRequestType:
      type: string
      enum:
        - REQUEST_TO_ADD_MEMBERS
        - REQUEST_TO_JOIN
        - UPGRADE_ROLE
      description: The type of access request.
      title: CreateAccessRequestRequestType
    createAccessRequest:
      type: object
      properties:
        entityList:
          type: array
          items:
            $ref: '#/components/schemas/teamEntityInfo'
          description: A list of the entities for which to create access requests.
        role:
          oneOf:
            - $ref: '#/components/schemas/CreateAccessRequestRole'
            - type: 'null'
          description: The team role to request.
        reason:
          type: string
          description: The reason for the access request.
        requestType:
          $ref: '#/components/schemas/CreateAccessRequestRequestType'
          description: The type of access request.
      required:
        - entityList
        - role
        - reason
        - requestType
      title: createAccessRequest
    TeamsAccessRequestDataEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity's ID.
      title: TeamsAccessRequestDataEntityId
    teamsAccessRequestData:
      type: object
      properties:
        entityType:
          type: string
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/TeamsAccessRequestDataEntityId'
          description: The entity's ID.
        role:
          type: string
          description: The entity's role.
        previousRole:
          type:
            - string
            - 'null'
          description: The entity's previous role. This value only returns if the entity's role is modified.
        status:
          type: string
          description: The request's status.
        reason:
          type: string
          description: The reason for the access request. This only returns if there's an issue with the request.
      title: teamsAccessRequestData
    createAccessRequestResponse:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/teamsAccessRequestData'
      title: createAccessRequestResponse
    CreateAccessRequestRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: CreateAccessRequestRequestBadRequestError
    accessRequestId:
      type: integer
      title: accessRequestId
    ApproveDenyAccessRequestAction:
      type: string
      enum:
        - approve
        - deny
      description: Whether to approve or deny the access request.
      title: ApproveDenyAccessRequestAction
    approveDenyAccessRequest:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/ApproveDenyAccessRequestAction'
          description: Whether to approve or deny the access request.
      required:
        - action
      title: approveDenyAccessRequest
    ApproveDenyAccessRequestResponseResultEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity's ID.
      title: ApproveDenyAccessRequestResponseResultEntityId
    ApproveDenyAccessRequestResponseResultAccessRequest:
      type: object
      properties:
        id:
          type: integer
          description: The access request's ID.
        requestType:
          type: string
          description: The access request type.
        reason:
          type: string
          description: The reason the access request was created.
        status:
          type: string
          description: The access request's status.
        objectType:
          type: string
          description: The entity type.
        objectId:
          type: integer
          description: The entity's ID.
        createdBy:
          type: integer
          description: The user ID of the user who created the access request.
      description: Information about the access request.
      title: ApproveDenyAccessRequestResponseResultAccessRequest
    ApproveDenyAccessRequestResponseResult:
      type: object
      properties:
        entityType:
          type: string
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/ApproveDenyAccessRequestResponseResultEntityId'
          description: The entity's ID.
        role:
          type: string
          description: The requested team role.
        previousRole:
          type:
            - string
            - 'null'
          description: The entity's previous role. This value only returns if the entity's role is modified.
        status:
          type: string
          description: The access request's status.
        accessRequest:
          $ref: '#/components/schemas/ApproveDenyAccessRequestResponseResultAccessRequest'
          description: Information about the access request.
      description: Information about the approved or denied access request.
      title: ApproveDenyAccessRequestResponseResult
    approveDenyAccessRequestResponse:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/ApproveDenyAccessRequestResponseResult'
          description: Information about the approved or denied access request.
      title: approveDenyAccessRequestResponse
    ApproveDenyAccessRequestRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: ApproveDenyAccessRequestRequestBadRequestError
    teamRoles:
      type: string
      enum:
        - TEAM_MANAGER
        - TEAM_DEVELOPER
        - TEAM_GUEST_DEVELOPER
        - TEAM_GUEST_VIEWER
        - TEAM_PARTNER_MANAGER
        - TEAM_PARTNER_LEAD
        - TEAM_GUEST
        - TEAM_PARTNER
        - TEAM_COMMUNITY_MANAGER
      title: teamRoles
    usersInfo:
      type: object
      properties:
        '{{userId}}':
          type: array
          items:
            $ref: '#/components/schemas/teamRoles'
          description: A list of the user's roles. The array's name is the user's ID.
      title: usersInfo
    userGroupsInfo:
      type: object
      properties:
        '{{userGroupId}}':
          type: array
          items:
            $ref: '#/components/schemas/teamRoles'
          description: A list of the user group's roles. The array's name is the group's ID.
      title: userGroupsInfo
    orgsInfo:
      type: object
      properties:
        '{{orgId}}':
          type: array
          items:
            $ref: '#/components/schemas/teamRoles'
          description: A list of the organization's roles. The array's name is the organization's ID.
      title: orgsInfo
    teamsInfo:
      type: object
      properties:
        '{{teamId}}':
          type: array
          items:
            $ref: '#/components/schemas/teamRoles'
          description: A list of the team's roles. The array's name is the team's ID.
      title: teamsInfo
    manageTeamMemberRolesAdd:
      type: object
      properties:
        users:
          $ref: '#/components/schemas/usersInfo'
        groups:
          $ref: '#/components/schemas/userGroupsInfo'
        orgs:
          $ref: '#/components/schemas/orgsInfo'
        teams:
          $ref: '#/components/schemas/teamsInfo'
      description: Information about the bulk `add` operation.
      title: manageTeamMemberRolesAdd
    manageTeamMemberRolesRemove:
      type: object
      properties:
        users:
          $ref: '#/components/schemas/usersInfo'
        groups:
          $ref: '#/components/schemas/userGroupsInfo'
        orgs:
          $ref: '#/components/schemas/orgsInfo'
        teams:
          $ref: '#/components/schemas/teamsInfo'
      description: Information about the bulk `remove` operation.
      title: manageTeamMemberRolesRemove
    manageTeamMemberRoles:
      type: object
      properties:
        add:
          $ref: '#/components/schemas/manageTeamMemberRolesAdd'
        remove:
          $ref: '#/components/schemas/manageTeamMemberRolesRemove'
      description: Information about the bulk add and bulk remove operations.
      title: manageTeamMemberRoles
    ManageTeamMemberRolesResponseResultItemsEntityId:
      oneOf:
        - type: integer
        - type: string
      description: The entity's ID.
      title: ManageTeamMemberRolesResponseResultItemsEntityId
    ManageTeamMemberRolesResponseResultItems:
      type: object
      properties:
        entityType:
          type: string
          description: The entity type.
        entityId:
          $ref: '#/components/schemas/ManageTeamMemberRolesResponseResultItemsEntityId'
          description: The entity's ID.
        role:
          type:
            - string
            - 'null'
          description: The user's role.
        previousRole:
          type:
            - string
            - 'null'
          description: The user's previous role. This value only returns if the user's role is modified.
        status:
          type: string
          description: The request's status.
      title: ManageTeamMemberRolesResponseResultItems
    manageTeamMemberRolesResponse:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/ManageTeamMemberRolesResponseResultItems'
      title: manageTeamMemberRolesResponse
    ManageTeamMemberRolesRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: ManageTeamMemberRolesRequestBadRequestError
    removeTeamMembers:
      type: object
      properties:
        entities:
          type: array
          items:
            $ref: '#/components/schemas/teamEntityInfo'
          description: A list of entities to remove.
      title: removeTeamMembers
    RemoveTeamMembersRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: RemoveTeamMembersRequestBadRequestError
    CreateGetTeamSettingsResponseSettings:
      type: object
      properties:
        rfa_for_add_member:
          type: string
          description: If enabled, admins must approve any new team members before they can join.
        rfa_for_add_collaborator:
          type: string
          description: If enabled, collaborators require approval before they can access the team's workspaces.
      title: CreateGetTeamSettingsResponseSettings
    createGetTeamSettingsResponse:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/CreateGetTeamSettingsResponseSettings'
      title: createGetTeamSettingsResponse
    GetTeamSettingsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: GetTeamSettingsRequestBadRequestError
    UpdateTeamSettingsSettingsRfaForAddMember:
      type: string
      enum:
        - enabled
        - disabled
      description: If enabled, admins must approve any new team members before they can join.
      title: UpdateTeamSettingsSettingsRfaForAddMember
    UpdateTeamSettingsSettingsRfaForAddCollaborator:
      type: string
      enum:
        - enabled
        - disabled
      description: If enabled, collaborators require approval before they can access the team's workspaces.
      title: UpdateTeamSettingsSettingsRfaForAddCollaborator
    UpdateTeamSettingsSettings:
      type: object
      properties:
        rfa_for_add_member:
          $ref: '#/components/schemas/UpdateTeamSettingsSettingsRfaForAddMember'
          description: If enabled, admins must approve any new team members before they can join.
        rfa_for_add_collaborator:
          $ref: '#/components/schemas/UpdateTeamSettingsSettingsRfaForAddCollaborator'
          description: If enabled, collaborators require approval before they can access the team's workspaces.
      description: Information about the team settings.
      title: UpdateTeamSettingsSettings
    updateTeamSettings:
      type: object
      properties:
        settings:
          $ref: '#/components/schemas/UpdateTeamSettingsSettings'
          description: Information about the team settings.
      title: updateTeamSettings
    UpdateTeamSettingsRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/teamsError'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatusInstance'
      title: UpdateTeamSettingsRequestBadRequestError
    GetAuthenticatedUserUser:
      type: object
      properties:
        id:
          type: number
          format: double
          description: The user's Postman ID.
        sub:
          type: string
          description: >-
            The authenticated user's ID. This ID is unique to the user and isn't associated with any Postman teams. Can
            return in UUID or ID format.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        fullName:
          type: string
          description: The user's full name.
        avatar:
          type:
            - string
            - 'null'
          format: url
          description: The user's avatar image URL.
        isPublic:
          type: boolean
          description: If true, the user's information is public and visible to all users.
        emailVerified:
          type: boolean
          description: If true, the user email address is verified by Postman.
        teamId:
          type: integer
          description: The team ID the user is assigned to. This returns a `0` value if the user is not assigned to a team.
        teamName:
          type: string
          description: The name of the team the user is assigned to.
        teamDomain:
          type: string
          description: The team's Postman domain ID.
        roles:
          type: array
          items:
            type: string
            default: user
          description: >-
            A list of the user's assigned
            [roles](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
      description: Information about the authenticated user.
      title: GetAuthenticatedUserUser
    GetAuthenticatedUserOperationsItems:
      type: object
      properties:
        limit:
          type: number
          format: double
          description: The operation's limit value.
        name:
          type: string
          description: The operation's name.
        overage:
          type: number
          format: double
          description: The operation's overage value.
        usage:
          type: number
          format: double
          description: The operation's current usage value.
      title: GetAuthenticatedUserOperationsItems
    getAuthenticatedUser:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/GetAuthenticatedUserUser'
          description: Information about the authenticated user.
        operations:
          type: array
          items:
            $ref: '#/components/schemas/GetAuthenticatedUserOperationsItems'
          description: >-
            Information about operations and their usage limits. This object does not return for users with the [Guest
            and Partner
            role](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#team-roles).
      title: getAuthenticatedUser
    GetAuthenticatedUserRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuthenticatedUserRequestUnauthorizedError
    GetAuthenticatedUserRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAuthenticatedUserRequestInternalServerError
    teamUser:
      type: object
      properties:
        id:
          type: integer
          description: The user's ID.
        name:
          type: string
          description: The user's name.
        username:
          type: string
          description: The user's username.
        email:
          type: string
          format: email
          description: The user's email address.
        roles:
          type: array
          items:
            type: string
          description: The user's roles.
        joinedAt:
          type: string
          format: date-time
          description: The user's join date.
      description: Information about the user.
      title: teamUser
    getTeamUsers:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/teamUser'
          description: A list of users on the team.
      title: getTeamUsers
    GetTeamUsersRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestUnauthorizedError
    GetTeamUsersRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestForbiddenError
    GetTeamUsersRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUsersRequestInternalServerError
    userId:
      type: integer
      title: userId
    GetTeamUserRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessageDetails'
      title: GetTeamUserRequestBadRequestError
    GetTeamUserRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestUnauthorizedError
    GetTeamUserRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestForbiddenError
    GetTeamUserRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetTeamUserRequestInternalServerError
    CreateWebhookWebhook:
      type: object
      properties:
        collection:
          type: string
          format: uid
          description: The unique ID of the collection to trigger when calling this webhook.
        environment:
          type: string
          format: uid
          description: The unique ID of the environment to trigger when calling this webhook.
        name:
          type: string
          description: The webhook's name. On success, the system creates a new monitor with this name in the **Monitors** tab.
      required:
        - collection
        - name
      title: CreateWebhookWebhook
    createWebhook:
      type: object
      properties:
        webhook:
          $ref: '#/components/schemas/CreateWebhookWebhook'
      title: createWebhook
    CreateWebhookResponseWebhook:
      type: object
      properties:
        id:
          type: string
          description: The webhook's ID.
        name:
          type: string
          description: The webhook's name.
        collection:
          type: string
          format: uid
          description: The unique ID of the collection that triggers when calling this webhook.
        webhookUrl:
          type: string
          description: The webhook's URL.
        uid:
          type: string
          format: uid
          description: The webhook's unique ID.
      title: CreateWebhookResponseWebhook
    createWebhookResponse:
      type: object
      properties:
        webhook:
          $ref: '#/components/schemas/CreateWebhookResponseWebhook'
      title: createWebhookResponse
    CreateWebhookRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateWebhookRequestUnauthorizedError
    CreateWebhookRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateWebhookRequestInternalServerError
    ManagePartnerWorkspaceInvitesInvitePartnerAction:
      type: string
      enum:
        - invite_partner
      description: The `invite_partner` action.
      title: ManagePartnerWorkspaceInvitesInvitePartnerAction
    ManagePartnerWorkspaceInvitesInvitePartnerTargetEntity:
      type: string
      enum:
        - workspace
      description: The `workspace` value.
      title: ManagePartnerWorkspaceInvitesInvitePartnerTargetEntity
    ManagePartnerWorkspaceInvitesInvitePartnerRoleId:
      type: string
      enum:
        - '4'
        - '5'
        - '6'
        - '7'
      description: |
        The role ID to assign to invited partners:
        - `4` — Viewer
        - `5` — Editor
        - `6` — Viewer and Partner Lead
        - `7` — Editor and Partner Lead
      title: ManagePartnerWorkspaceInvitesInvitePartnerRoleId
    partnerEmailAddress:
      type: string
      format: email
      minLength: 1
      maxLength: 254
      description: A partner's email address.
      title: partnerEmailAddress
    managePartnerWorkspaceInvitesTargetObjectEmails:
      type: object
      properties:
        emails:
          type: array
          items:
            $ref: '#/components/schemas/partnerEmailAddress'
          description: A list of the partners' email addresses.
      required:
        - emails
      description: The target on which to perform the action.
      title: managePartnerWorkspaceInvitesTargetObjectEmails
    managePartnerWorkspaceInvitesInvitePartner:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerAction'
          description: The `invite_partner` action.
        targetEntity:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerTargetEntity'
          description: The `workspace` value.
        targetEntityId:
          type: string
          minLength: 1
          maxLength: 60
          description: The Partner Workspace's ID.
        roleId:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerRoleId'
          description: |
            The role ID to assign to invited partners:
            - `4` — Viewer
            - `5` — Editor
            - `6` — Viewer and Partner Lead
            - `7` — Editor and Partner Lead
        target:
          $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectEmails'
      required:
        - action
        - targetEntity
        - targetEntityId
        - roleId
        - target
      description: Invite partners to a Partner Workspace.
      title: managePartnerWorkspaceInvitesInvitePartner
    ManagePartnerWorkspaceInvitesRemovePartnerTargetEntity:
      type: string
      enum:
        - workspace
      description: The `workspace` value.
      title: ManagePartnerWorkspaceInvitesRemovePartnerTargetEntity
    ManagePartnerWorkspaceInvitesRemovePartnerAction:
      type: string
      enum:
        - remove_partner
      description: The `remove_partner` action.
      title: ManagePartnerWorkspaceInvitesRemovePartnerAction
    partnerUserId:
      type: string
      minLength: 1
      maxLength: 25
      description: The partner's ID.
      title: partnerUserId
    ManagePartnerWorkspaceInvitesTargetObjectUserId0:
      type: object
      properties:
        userIds:
          type: array
          items:
            $ref: '#/components/schemas/partnerUserId'
          description: A list of partner user IDs to remove from the Partner Workspace.
      required:
        - userIds
      description: The target on which to perform the action.
      title: ManagePartnerWorkspaceInvitesTargetObjectUserId0
    ManagePartnerWorkspaceInvitesTargetObjectUserId1:
      type: object
      properties:
        userIds:
          type: array
          items:
            $ref: '#/components/schemas/partnerUserId'
          description: A list of partner publishers' team IDs.
      required:
        - userIds
      description: The target on which to perform the action.
      title: ManagePartnerWorkspaceInvitesTargetObjectUserId1
    managePartnerWorkspaceInvitesTargetObjectUserId:
      oneOf:
        - $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesTargetObjectUserId0'
        - $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesTargetObjectUserId1'
      title: managePartnerWorkspaceInvitesTargetObjectUserId
    managePartnerWorkspaceInvitesRemovePartner:
      type: object
      properties:
        targetEntity:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerTargetEntity'
          description: The `workspace` value.
        targetEntityId:
          type: string
          minLength: 1
          maxLength: 60
          description: The Partner Workspace ID from which to remove partners.
        action:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerAction'
          description: The `remove_partner` action.
        target:
          $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectUserId'
      required:
        - targetEntity
        - targetEntityId
        - action
        - target
      description: The request body for removing partners from a Partner Workspace.
      title: managePartnerWorkspaceInvitesRemovePartner
    ManagePartnerWorkspaceInvitesRemovePartnerTeamTargetEntity:
      type: string
      enum:
        - team
      description: The `team` value.
      title: ManagePartnerWorkspaceInvitesRemovePartnerTeamTargetEntity
    ManagePartnerWorkspaceInvitesRemovePartnerTeamAction:
      type: string
      enum:
        - remove_partner
      description: The `remove_partner` action.
      title: ManagePartnerWorkspaceInvitesRemovePartnerTeamAction
    managePartnerWorkspaceInvitesRemovePartnerTeam:
      type: object
      properties:
        targetEntity:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerTeamTargetEntity'
          description: The `team` value.
        targetEntityId:
          type: string
          minLength: 1
          maxLength: 60
          description: The team ID from which to remove partners.
        action:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerTeamAction'
          description: The `remove_partner` action.
        target:
          $ref: '#/components/schemas/managePartnerWorkspaceInvitesTargetObjectUserId'
      required:
        - targetEntity
        - targetEntityId
        - action
        - target
      description: The request body for removing partners from partnership with a team.
      title: managePartnerWorkspaceInvitesRemovePartnerTeam
    Workspaces_managePartnerWorkspaceInvites_Request:
      oneOf:
        - $ref: '#/components/schemas/managePartnerWorkspaceInvitesInvitePartner'
        - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartner'
        - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartnerTeam'
      title: Workspaces_managePartnerWorkspaceInvites_Request
    ManagePartnerWorkspaceInvitesInvitePartnerResponseRoleDisplayName:
      type: string
      enum:
        - Viewer
        - Editor
        - Viewer and Partner Lead
        - Editor and Partner Lead
      description: The assigned role's display name.
      title: ManagePartnerWorkspaceInvitesInvitePartnerResponseRoleDisplayName
    ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItemsStatus:
      type: string
      enum:
        - EMAIL_SENT
        - ALREADY_INVITED
        - PARTNER_ADDED
        - FAILED
      description: |
        The invitation status:
        - `EMAIL_SENT` — An invitation email was sent.
        - `ALREADY_INVITED` — The user already has a pending invitation.
        - `PARTNER_ADDED` — The existing user was added to the workspace directly.
        - `FAILED` — The invitation failed.
      title: ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItemsStatus
    ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItems:
      type: object
      properties:
        email:
          type: string
          format: email
          description: The invited user's email address.
        status:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItemsStatus'
          description: |
            The invitation status:
            - `EMAIL_SENT` — An invitation email was sent.
            - `ALREADY_INVITED` — The user already has a pending invitation.
            - `PARTNER_ADDED` — The existing user was added to the workspace directly.
            - `FAILED` — The invitation failed.
        userId:
          type: string
          description: The user ID. This only returns for the `PARTNER_ADDED` status.
        message:
          type: string
          description: A response message.
        invitationLink:
          type: string
          format: uri
          description: An invitation link. This only returns for the `EMAIL_SENT` and `ALREADY_INVITED` statuses.
      title: ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItems
    managePartnerWorkspaceInvitesInvitePartnerResponse:
      type: object
      properties:
        targetEntity:
          type: string
          description: The target entity.
        targetEntityId:
          type: string
          description: The target entity's ID.
        roleId:
          type: string
          description: The role ID assigned to the users.
        action:
          type: string
          description: The action peformed.
        roleDisplayName:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerResponseRoleDisplayName'
          description: The assigned role's display name.
        results:
          type: array
          items:
            $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesInvitePartnerResponseResultsItems'
          description: A list of the action results for each email address.
      title: managePartnerWorkspaceInvitesInvitePartnerResponse
    ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItemsStatus:
      type: string
      enum:
        - REMOVED
        - FAILED
      description: |
        The removal status:
        - `REMOVED` — The partner was successfully removed.
        - `FAILED` — The partner's removal failed.
      title: ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItemsStatus
    ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItems:
      type: object
      properties:
        error:
          type: string
          description: If the endpoint returns the `FAILED` status, the error message detailing the error.
        message:
          type: string
          description: A response message.
        status:
          $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItemsStatus'
          description: |
            The removal status:
            - `REMOVED` — The partner was successfully removed.
            - `FAILED` — The partner's removal failed.
        userId:
          type: string
          description: The user ID.
      title: ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItems
    managePartnerWorkspaceInvitesRemovePartnerResponse:
      type: object
      properties:
        targetEntity:
          type: string
          description: The target entity type.
        targetEntityId:
          type: string
          description: The target entity's ID.
        action:
          type: string
          description: The action performed.
        results:
          type: array
          items:
            $ref: '#/components/schemas/ManagePartnerWorkspaceInvitesRemovePartnerResponseResultsItems'
          description: A list of the action results.
      title: managePartnerWorkspaceInvitesRemovePartnerResponse
    Workspaces_managePartnerWorkspaceInvites_Response_200:
      oneOf:
        - $ref: '#/components/schemas/managePartnerWorkspaceInvitesInvitePartnerResponse'
        - $ref: '#/components/schemas/managePartnerWorkspaceInvitesRemovePartnerResponse'
      title: Workspaces_managePartnerWorkspaceInvites_Response_200
    ManagePartnerWorkspaceInvitesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: ManagePartnerWorkspaceInvitesRequestInternalServerError
    workspaceTypeQuery:
      type: string
      enum:
        - personal
        - team
        - private
        - public
        - partner
      title: workspaceTypeQuery
    workspaceCreatedBy:
      type: integer
      title: workspaceCreatedBy
    workspacesIncludeQuery:
      type: string
      enum:
        - mocks:deactivated
        - scim
      title: workspacesIncludeQuery
    workspaceElementTypeQuery:
      type: string
      enum:
        - collection
        - specification
      title: workspaceElementTypeQuery
    workspaceElementIdQuery:
      type: string
      title: workspaceElementIdQuery
    limitMax100:
      type: integer
      minimum: 1
      maximum: 100
      title: limitMax100
    GetWorkspacesWorkspaceDataType:
      type: string
      enum:
        - personal
        - team
        - private
        - public
        - partner
      description: The type of workspace.
      title: GetWorkspacesWorkspaceDataType
    GetWorkspacesWorkspaceDataVisibility:
      type: string
      enum:
        - personal
        - team
        - private
        - public
        - partner
      description: >
        The workspace's visibility.
        [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
        determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
        only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and
        [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can
        access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
      title: GetWorkspacesWorkspaceDataVisibility
    getWorkspacesScimObject:
      type: object
      properties:
        createdBy:
          type: string
          description: The SCIM user ID of the user who created the workspace.
      description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
      title: getWorkspacesScimObject
    getWorkspacesWorkspaceData:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        name:
          type: string
          description: The workspace's name.
        type:
          $ref: '#/components/schemas/GetWorkspacesWorkspaceDataType'
          description: The type of workspace.
        visibility:
          $ref: '#/components/schemas/GetWorkspacesWorkspaceDataVisibility'
          description: >
            The workspace's visibility.
            [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
            determines who can access the workspace:

            - `personal` — Only you can access the workspace.

            - `team` — All team members can access the workspace.

            - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
            only](https://www.postman.com/pricing)).

            - `public` — Everyone can access the workspace.

            - `partner` — Only invited team members and
            [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/)
            can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
        createdBy:
          type: string
          description: The user who created the workspace. The response only returns workspaces that you have access to.
        about:
          type: string
          description: A brief summary about the workspace.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the workspace was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the workspace was last updated.
        scim:
          $ref: '#/components/schemas/getWorkspacesScimObject'
      description: Information about the workspace.
      title: getWorkspacesWorkspaceData
    GetWorkspacesMeta:
      type: object
      properties:
        nextCursor:
          type: string
          description: The pagination cursor that points to the next record in the results set.
      description: >-
        The response's meta information for paginated results. This object only returns if you pass the `limit` query
        parameter.
      title: GetWorkspacesMeta
    getWorkspaces:
      type: object
      properties:
        workspaces:
          type: array
          items:
            $ref: '#/components/schemas/getWorkspacesWorkspaceData'
          description: A list of workspaces.
        meta:
          $ref: '#/components/schemas/GetWorkspacesMeta'
          description: >-
            The response's meta information for paginated results. This object only returns if you pass the `limit`
            query parameter.
      title: getWorkspaces
    Workspace400ErrorError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: Workspace400ErrorError
    workspace400Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Workspace400ErrorError'
        statusCode:
          type: integer
          description: The error's HTTP status code.
      title: workspace400Error
    commonErrorNameMessageOnly:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
      title: commonErrorNameMessageOnly
    GetWorkspacesRequestBadRequestError:
      oneOf:
        - $ref: '#/components/schemas/workspace400Error'
        - $ref: '#/components/schemas/commonErrorNameMessageOnly'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspacesRequestBadRequestError
    GetWorkspacesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspacesRequestUnauthorizedError
    commonErrorErrorMessage:
      type: object
      properties:
        error:
          type: string
          description: The error type.
        message:
          type: string
          description: The error message.
      title: commonErrorErrorMessage
    GetWorkspacesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspacesRequestInternalServerError
    CreateWorkspaceWorkspaceType:
      type: string
      enum:
        - personal
        - private
        - public
        - team
        - partner
      description: >
        The type of workspace:

        - `personal`

        - `private` — Private workspaces are available on Postman [**Team** and **Enterprise**
        plans](https://www.postman.com/pricing).

        - `public`

        - `team`

        - `partner` — [Partner
        Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) are
        available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing)).
      title: CreateWorkspaceWorkspaceType
    CreateWorkspaceWorkspace:
      type: object
      properties:
        name:
          type: string
          description: The workspace's name.
        type:
          $ref: '#/components/schemas/CreateWorkspaceWorkspaceType'
          description: >
            The type of workspace:

            - `personal`

            - `private` — Private workspaces are available on Postman [**Team** and **Enterprise**
            plans](https://www.postman.com/pricing).

            - `public`

            - `team`

            - `partner` — [Partner
            Workspaces](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/)
            are available on Postman [**Team** and **Enterprise** plans](https://www.postman.com/pricing)).
        description:
          type: string
          description: The workspace's description.
        about:
          type: string
          description: A brief summary about the workspace.
        teamId:
          type: string
          description: >-
            The team ID to assign to the workspace. This property is required if Postman
            [Organizations](https://learning.postman.com/docs/administration/managing-your-team/overview) is enabled.
      required:
        - name
        - type
      description: Information about the workspace.
      title: CreateWorkspaceWorkspace
    createWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/CreateWorkspaceWorkspace'
          description: Information about the workspace.
      title: createWorkspace
    CreateWorkspaceResponseWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        name:
          type: string
          description: The workspace's name.
      description: Information about the created workspace.
      title: CreateWorkspaceResponseWorkspace
    createWorkspaceResponse:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/CreateWorkspaceResponseWorkspace'
          description: Information about the created workspace.
      title: createWorkspaceResponse
    CreateWorkspaceRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateWorkspaceRequestUnauthorizedError
    Workspace403ErrorError:
      type: object
      properties:
        status:
          type: number
          format: double
          description: The error's HTTP status code.
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        detail:
          type: string
          description: Information about the error.
        instance:
          type: string
          description: The URI reference that identifies the specific occurrence of the problem.
      title: Workspace403ErrorError
    workspace403Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Workspace403ErrorError'
      title: workspace403Error
    CreateWorkspaceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateWorkspaceRequestInternalServerError
    workspaceRoleData:
      type: object
      properties:
        id:
          type: string
          description: The role's ID.
        description:
          type: string
          description: The role's description.
        displayName:
          type: string
          description: The role's display name.
      description: Information about the role.
      title: workspaceRoleData
    GetAllWorkspaceRolesRoles:
      type: object
      properties:
        user:
          type: array
          items:
            $ref: '#/components/schemas/workspaceRoleData'
          description: The list of user roles in the workspace.
        usergroup:
          type: array
          items:
            $ref: '#/components/schemas/workspaceRoleData'
          description: The list of user group roles in the workspace.
        partner:
          type: array
          items:
            $ref: '#/components/schemas/workspaceRoleData'
          description: The list of partner in the workspace.
      description: Information about the workspace's roles.
      title: GetAllWorkspaceRolesRoles
    getAllWorkspaceRoles:
      type: object
      properties:
        roles:
          $ref: '#/components/schemas/GetAllWorkspaceRolesRoles'
          description: Information about the workspace's roles.
      title: getAllWorkspaceRoles
    GetAllWorkspaceRolesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllWorkspaceRolesRequestUnauthorizedError
    GetAllWorkspaceRolesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllWorkspaceRolesRequestForbiddenError
    GetAllWorkspaceRolesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetAllWorkspaceRolesRequestInternalServerError
    workspaceIncludeQuery:
      type: string
      pattern: >-
        ^(?!.*(?:^|,)(team|scim|mocks:deactivated),(?:.*,)?\1(?:$|,))(team|scim|mocks:deactivated)(,(team|scim|mocks:deactivated))*$
      title: workspaceIncludeQuery
    GetWorkspaceWorkspaceType:
      type: string
      enum:
        - personal
        - team
        - private
        - public
        - partner
      description: The type of workspace.
      title: GetWorkspaceWorkspaceType
    GetWorkspaceWorkspaceVisibility:
      type: string
      enum:
        - personal
        - team
        - private
        - public
        - partner
      description: >
        The workspace's visibility.
        [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
        determines who can access the workspace:

        - `personal` — Only you can access the workspace.

        - `team` — All team members can access the workspace.

        - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
        only](https://www.postman.com/pricing)).

        - `public` — Everyone can access the workspace.

        - `partner` — Only invited team members and
        [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/) can
        access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
      title: GetWorkspaceWorkspaceVisibility
    GetWorkspaceWorkspaceCollectionsItems:
      type: object
      properties:
        id:
          type: string
          description: The collection's ID.
        name:
          type: string
          description: The collection's name.
        uid:
          type: string
          format: uid
          description: The collection's unique ID.
      description: Information about the collection.
      title: GetWorkspaceWorkspaceCollectionsItems
    GetWorkspaceWorkspaceEnvironmentsItems:
      type: object
      properties:
        id:
          type: string
          description: The environment's ID.
        name:
          type: string
          description: The environment's name.
        uid:
          type: string
          format: uid
          description: The environment's unique ID.
      description: Information about the environment.
      title: GetWorkspaceWorkspaceEnvironmentsItems
    GetWorkspaceWorkspaceMocksItems:
      type: object
      properties:
        id:
          type: string
          description: The mock server's ID.
        name:
          type: string
          description: The mock server's name.
        uid:
          type: string
          format: uid
          description: The mock server's unique ID.
        deactivated:
          type: boolean
          description: >-
            If true, the mock server is not active. Mock servers deactivate when a linked collection or environment is
            deleted.
      description: Information about the mock server.
      title: GetWorkspaceWorkspaceMocksItems
    GetWorkspaceWorkspaceMonitorsItems:
      type: object
      properties:
        id:
          type: string
          description: The monitor's ID.
        name:
          type: string
          description: The monitor's name.
        uid:
          type: string
          format: uid
          description: The monitor's unique ID.
        deactivated:
          type: boolean
          description: If true, the monitor is not active.
      description: Information about the monitor.
      title: GetWorkspaceWorkspaceMonitorsItems
    GetWorkspaceWorkspaceSpecsItems:
      type: object
      properties:
        id:
          type: string
          description: The API specification's ID.
        name:
          type: string
          description: The API specification's name.
        uid:
          type: string
          format: uid
          description: The API specification's unique ID.
      description: Information about the API specification.
      title: GetWorkspaceWorkspaceSpecsItems
    GetWorkspaceWorkspaceScim:
      type: object
      properties:
        createdBy:
          type: string
          description: The SCIM user ID of the user who created the workspace.
        updatedBy:
          type: string
          description: The SCIM user ID of the user who last updated the workspace.
      description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
      title: GetWorkspaceWorkspaceScim
    GetWorkspaceWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        name:
          type: string
          description: The workspace's name.
        type:
          $ref: '#/components/schemas/GetWorkspaceWorkspaceType'
          description: The type of workspace.
        description:
          type: string
          description: The workspace's description.
        visibility:
          $ref: '#/components/schemas/GetWorkspaceWorkspaceVisibility'
          description: >
            The workspace's visibility.
            [Visibility](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility)
            determines who can access the workspace:

            - `personal` — Only you can access the workspace.

            - `team` — All team members can access the workspace.

            - `private` — Only invited team members can access the workspace ([**Team** and **Enterprise** plans
            only](https://www.postman.com/pricing)).

            - `public` — Everyone can access the workspace.

            - `partner` — Only invited team members and
            [partners](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/partner-workspaces/)
            can access the workspace ([**Team** and **Enterprise** plans only](https://www.postman.com/pricing)).
        createdBy:
          type: string
          description: The user ID of the user who created the workspace.
        updatedBy:
          type: string
          description: The user ID of the user who last updated the workspace.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the workspace was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the workspace was last updated.
        about:
          type: string
          description: A brief summary about the workspace.
        team:
          type: string
          description: The workspace's team ID.
        collections:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceWorkspaceCollectionsItems'
          description: The workspace's collections.
        environments:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceWorkspaceEnvironmentsItems'
          description: The workspace's environments.
        mocks:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceWorkspaceMocksItems'
          description: The workspace's mock servers.
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceWorkspaceMonitorsItems'
          description: The workspace's monitors.
        specs:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceWorkspaceSpecsItems'
          description: The workspace's API specifications.
        scim:
          $ref: '#/components/schemas/GetWorkspaceWorkspaceScim'
          description: An object containing SCIM user IDs. This object only returns if you pass the `include=scim` query parameter.
      description: Information about the workspace.
      title: GetWorkspaceWorkspace
    getWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/GetWorkspaceWorkspace'
          description: Information about the workspace.
      title: getWorkspace
    GetWorkspaceRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceRequestUnauthorizedError
    Workspace404ErrorError:
      type: object
      properties:
        name:
          type: string
          description: The error name.
        message:
          type: string
          description: The error message.
        statusCode:
          type: number
          format: double
          description: The error's HTTP status code.
      title: Workspace404ErrorError
    workspace404Error:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/Workspace404ErrorError'
      title: workspace404Error
    GetWorkspaceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceRequestInternalServerError
    UpdateWorkspaceWorkspaceType:
      type: string
      enum:
        - private
        - personal
        - team
        - public
      description: >
        The new workspace visibility
        [type](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility).
        This property does not support the following workspace visibility changes:

        - `private` to `public`, `public` to `private`, and `private` to `personal` for Free and Basic
        [plans](https://www.postman.com/pricing/).

        - `public` to `personal` for team users.
      title: UpdateWorkspaceWorkspaceType
    UpdateWorkspaceWorkspace:
      type: object
      properties:
        name:
          type: string
          description: The workspace's new name.
        type:
          $ref: '#/components/schemas/UpdateWorkspaceWorkspaceType'
          description: >
            The new workspace visibility
            [type](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#changing-workspace-visibility).
            This property does not support the following workspace visibility changes:

            - `private` to `public`, `public` to `private`, and `private` to `personal` for Free and Basic
            [plans](https://www.postman.com/pricing/).

            - `public` to `personal` for team users.
        description:
          type: string
          description: The new workspace description.
        about:
          type: string
          description: A brief summary about the workspace.
      title: UpdateWorkspaceWorkspace
    updateWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/UpdateWorkspaceWorkspace'
      title: updateWorkspace
    UpdateWorkspaceResponseWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
        name:
          type: string
          description: The workspace's name.
      description: Information about the updated workspace.
      title: UpdateWorkspaceResponseWorkspace
    updateWorkspaceResponse:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/UpdateWorkspaceResponseWorkspace'
          description: Information about the updated workspace.
      title: updateWorkspaceResponse
    UpdateWorkspaceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateWorkspaceRequestInternalServerError
    DeleteWorkspaceWorkspace:
      type: object
      properties:
        id:
          type: string
          description: The workspace's ID.
      description: Information about the deleted workspace.
      title: DeleteWorkspaceWorkspace
    deleteWorkspace:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/DeleteWorkspaceWorkspace'
          description: Information about the deleted workspace.
      title: deleteWorkspace
    DeleteWorkspaceRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteWorkspaceRequestUnauthorizedError
    DeleteWorkspaceRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteWorkspaceRequestInternalServerError
    userId-2:
      type: integer
      title: userId-2
    elementType-3:
      type: string
      enum:
        - collection
        - workspace
        - environment
        - mock
        - monitor
      title: elementType-3
    limitDefault15:
      type: integer
      default: 15
      title: limitDefault15
    GetWorkspaceActivityFeedDataItemsUser:
      type: object
      properties:
        id:
          type: integer
          description: The user's ID.
        username:
          type: string
          description: The user's Postman username.
        isPartner:
          type: boolean
          description: >-
            If true, the user is a
            [Partner](https://learning.postman.com/docs/collaborating-in-postman/roles-and-permissions/#partner-team-and-partner-workspace-roles)
            in the workspace.
        name:
          type: string
          description: The user's name.
      description: Information about the user that performed the activity.
      title: GetWorkspaceActivityFeedDataItemsUser
    GetWorkspaceActivityFeedDataItemsAction:
      type: string
      enum:
        - create
        - update
        - destroy
      description: The action that occurred in the workspace.
      title: GetWorkspaceActivityFeedDataItemsAction
    GetWorkspaceActivityFeedDataItems:
      type: object
      properties:
        workspaceId:
          type: string
          description: The workspace's ID.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the element was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the element was updated.
        id:
          type: integer
          description: The activity feed's ID.
        user:
          $ref: '#/components/schemas/GetWorkspaceActivityFeedDataItemsUser'
          description: Information about the user that performed the activity.
        action:
          $ref: '#/components/schemas/GetWorkspaceActivityFeedDataItemsAction'
          description: The action that occurred in the workspace.
        elementType:
          type: string
          description: The element type.
        trigger:
          type: string
          description: The trigger that caused the workspace action (`create`, `update`, or `destroy`).
        elementId:
          type: string
          description: The element's ID.
        elementName:
          type: string
          description: The element's name.
      description: Information about the workspace's activity.
      title: GetWorkspaceActivityFeedDataItems
    getWorkspaceActivityFeed:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/GetWorkspaceActivityFeedDataItems'
        meta:
          $ref: '#/components/schemas/meta'
      title: getWorkspaceActivityFeed
    GetWorkspaceActivityFeedRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceActivityFeedRequestUnauthorizedError
    GetWorkspaceActivityFeedRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceActivityFeedRequestForbiddenError
    GetWorkspaceActivityFeedRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceActivityFeedRequestInternalServerError
    TransferWorkspaceElementId:
      oneOf:
        - type: string
          format: uid
        - type: string
      description: The workspace element's ID.
      title: TransferWorkspaceElementId
    TransferWorkspaceElementType:
      type: string
      enum:
        - collection
        - environment
        - api
        - flow
        - mock
        - monitor
      description: The type of element to transfer.
      title: TransferWorkspaceElementType
    transferWorkspaceElement:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/TransferWorkspaceElementId'
          description: The workspace element's ID.
        type:
          $ref: '#/components/schemas/TransferWorkspaceElementType'
          description: The type of element to transfer.
        to:
          type: string
          description: The workspace ID to transfer the element into.
      required:
        - id
        - type
        - to
      title: transferWorkspaceElement
    TransferWorkspaceElementResponseWorkspaceElementTransfers:
      type: object
      properties:
        type:
          type: string
          description: The type of element transferred.
        from:
          type: string
          description: The ID of the workspace the element was transferred from.
        id:
          type: string
          description: The element's ID.
        to:
          type: string
          description: The ID of the workspace the element was transferred to.
      description: Information about the element transfer.
      title: TransferWorkspaceElementResponseWorkspaceElementTransfers
    TransferWorkspaceElementResponseWorkspace:
      type: object
      properties:
        element-transfers:
          $ref: '#/components/schemas/TransferWorkspaceElementResponseWorkspaceElementTransfers'
          description: Information about the element transfer.
      title: TransferWorkspaceElementResponseWorkspace
    transferWorkspaceElementResponse:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/TransferWorkspaceElementResponseWorkspace'
      title: transferWorkspaceElementResponse
    TransferWorkspaceElementRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: TransferWorkspaceElementRequestInternalServerError
    GlobalVariableType:
      type: string
      enum:
        - default
        - secret
      description: The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable.
      title: GlobalVariableType
    globalVariable:
      type: object
      properties:
        key:
          type: string
          description: The variable's name.
        type:
          $ref: '#/components/schemas/GlobalVariableType'
          description: The [type](https://learning.postman.com/docs/sending-requests/variables/#variable-types) of variable.
        value:
          type: string
          description: The variable's value.
        enabled:
          type: boolean
          description: If true, the variable is enabled.
        description:
          type: string
          maxLength: 512
          description: The variable's description.
      description: Information about the global variable.
      title: globalVariable
    getWorkspaceGlobalVariables:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/globalVariable'
          description: A list of the workspace's global variables.
      description: Information about the workspace's global variables.
      title: getWorkspaceGlobalVariables
    updateWorkspaceGlobalVariables:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/globalVariable'
          description: A list of the workspace's global variables.
      title: updateWorkspaceGlobalVariables
    updateWorkspaceGlobalVariablesResponse:
      type: object
      properties:
        values:
          type: array
          items:
            $ref: '#/components/schemas/globalVariable'
          description: A list of the workspace's global variables.
      description: Information about the workspace's updated global variables.
      title: updateWorkspaceGlobalVariablesResponse
    workspaceIncludeScimQuery:
      type: string
      enum:
        - scim
      title: workspaceIncludeScimQuery
    workspaceRolesData:
      type: object
      properties:
        id:
          type: string
          description: The role's ID.
        user:
          type: array
          items:
            type: string
          description: A list of user IDs assigned to the role.
        usergroup:
          type: array
          items:
            type: string
          description: A list of user group IDs assigned to the role.
        partner:
          type: array
          items:
            type: string
          description: A list of partner IDs assigned to the role.
        displayName:
          type: string
          description: The role's display name.
      title: workspaceRolesData
    getWorkspaceRoles:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/workspaceRolesData'
          description: A list of workspace roles and the users, groups, and partners assigned to them.
      description: Information about the workspace's roles.
      title: getWorkspaceRoles
    GetWorkspaceRolesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceRolesRequestUnauthorizedError
    GetWorkspaceRolesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceRolesRequestForbiddenError
    GetWorkspaceRolesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceRolesRequestInternalServerError
    UpdateWorkspaceRolesRolesItemsPath:
      type: string
      enum:
        - /user
        - /usergroup
        - /partner
      description: The resource to perform the action on.
      title: UpdateWorkspaceRolesRolesItemsPath
    UpdateWorkspaceRolesRolesItemsValueItems:
      type: object
      properties:
        id:
          type: string
          description: >-
            The user, user group, or partner's ID. To use SCIM IDs for users or user groups, include the
            `identifierType=scim` header in the request.
        role:
          type: string
          description: >
            The user or user group's role ID:

            - `1` — Viewer.  Can view and collaborate on all resources.

            - `2` — Editor. Can create and edit all resources.

            - `3` — Admin. Can manage people and all resources.


            For partner roles:

            - `4` — Viewer. Can send requests and view workspace resources.

            - `5` — Editor. Can create, edit and fork workspace resources.

            - `6` — Viewer and Partner Lead. Can view, fork and export workspace resources, and invite partners.

            - `7` — Editor and Partner Lead. Can create and edit workspace resources, and invite partners with Editor or
            Viewer access to the workspace.
      required:
        - id
        - role
      description: Information about the user, user group, or partner role.
      title: UpdateWorkspaceRolesRolesItemsValueItems
    UpdateWorkspaceRolesRolesItems:
      type: object
      properties:
        op:
          type: string
          description: The operation to perform on the path.
        path:
          $ref: '#/components/schemas/UpdateWorkspaceRolesRolesItemsPath'
          description: The resource to perform the action on.
        value:
          type: array
          items:
            $ref: '#/components/schemas/UpdateWorkspaceRolesRolesItemsValueItems'
          description: Information about the updated workspace role.
      required:
        - op
        - path
        - value
      title: UpdateWorkspaceRolesRolesItems
    updateWorkspaceRoles:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UpdateWorkspaceRolesRolesItems'
      title: updateWorkspaceRoles
    UpdateWorkspaceRolesResponseRolesItems:
      type: object
      properties:
        id:
          type: string
          description: The role's ID.
        user:
          type: array
          items:
            type: string
          description: A list of user IDs assigned to the role.
        group:
          type: array
          items:
            type: string
          description: A list of user group IDs assigned to the role.
        displayName:
          type: string
          description: The role's display name.
      title: UpdateWorkspaceRolesResponseRolesItems
    updateWorkspaceRolesResponse:
      type: object
      properties:
        roles:
          type: array
          items:
            $ref: '#/components/schemas/UpdateWorkspaceRolesResponseRolesItems'
      title: updateWorkspaceRolesResponse
    UpdateWorkspaceRolesRequestUnauthorizedError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateWorkspaceRolesRequestUnauthorizedError
    UpdateWorkspaceRolesRequestForbiddenError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateWorkspaceRolesRequestForbiddenError
    workspaceRoles422Error:
      type: object
      properties:
        detail:
          type: string
          description: Information about the error.
        link:
          type: string
          description: The error type.
        status:
          type: number
          format: double
          description: The error's HTTP status code.
        title:
          type: string
          description: A short summary of the problem.
      title: workspaceRoles422Error
    UpdateWorkspaceRolesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: UpdateWorkspaceRolesRequestInternalServerError
    transferWorkspaceToTeam:
      type: object
      properties:
        destination:
          type: string
          description: The ID of the team to transfer the workspace to.
        source:
          type: string
          description: The ID of the team to transfer the workspace from.
      required:
        - destination
        - source
      title: transferWorkspaceToTeam
    transferWorkspaceToTeamResponseObject:
      type: object
      properties:
        id:
          type: string
          description: The ID of the transferred workspace.
        source:
          type: string
          description: The ID of the team the workspace was transferred away from.
        destination:
          type: string
          description: The ID of the team that the workspace was transferred to.
      description: Information about the workspace transfer.
      title: transferWorkspaceToTeamResponseObject
    TransferWorkspaceToTeamResponseWorkspace:
      type: object
      properties:
        transfer:
          $ref: '#/components/schemas/transferWorkspaceToTeamResponseObject'
      title: TransferWorkspaceToTeamResponseWorkspace
    transferWorkspaceToTeamResponse:
      type: object
      properties:
        workspace:
          $ref: '#/components/schemas/TransferWorkspaceToTeamResponseWorkspace'
      title: transferWorkspaceToTeamResponse
    workspaceUpdateCategory:
      type: string
      title: workspaceUpdateCategory
    workspaceUpdateCreatedByData:
      type: object
      properties:
        id:
          type: integer
          description: The user ID of the user that created the workspace update.
        name:
          type: string
          description: The display name of the user that created the workspace update.
        username:
          type: string
          description: The username of the user that created the workspace update.
      description: Information about the user that created the workspace update.
      title: workspaceUpdateCreatedByData
    workspaceUpdateCategoryData:
      type: string
      enum:
        - improvement
        - new_feature
        - bug_fix
        - breaking_change
        - announcement
      description: The update's assigned category.
      title: workspaceUpdateCategoryData
    WorkspaceUpdateRelatedResourcesDataItemsResource:
      type: string
      enum:
        - collection
        - request
        - response
        - folder
        - extensibleCollection
        - extensibleCollectionItem
      description: The type of linked resource.
      title: WorkspaceUpdateRelatedResourcesDataItemsResource
    WorkspaceUpdateRelatedResourcesDataItems:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/WorkspaceUpdateRelatedResourcesDataItemsResource'
          description: The type of linked resource.
        resourceId:
          type: string
          description: The linked resource's ID.
      required:
        - resource
        - resourceId
      title: WorkspaceUpdateRelatedResourcesDataItems
    workspaceUpdateRelatedResourcesData:
      type: array
      items:
        $ref: '#/components/schemas/WorkspaceUpdateRelatedResourcesDataItems'
      description: >-
        A list containing the update's related elements. Related elements include links to collections, requests,
        folders, and saved examples in the update.
      title: workspaceUpdateRelatedResourcesData
    workspaceUpdateData:
      type: object
      properties:
        id:
          type: integer
          description: The workspace update's ID.
        topic:
          type: string
          description: The title of the workspace update.
        description:
          type: string
          description: The content of the workspace update.
        workspaceId:
          type: string
          description: The ID of the workspace in which the workspace update was created.
        createdBy:
          $ref: '#/components/schemas/workspaceUpdateCreatedByData'
        updatedBy:
          type: integer
          description: The ID of the user who last updated the workspace update.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the workspace update was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the workspace update was last updated.
        category:
          $ref: '#/components/schemas/workspaceUpdateCategoryData'
        isPinned:
          type: boolean
          default: false
          description: If true, the workspace update is pinned to the top of the workspace updates list.
        relatedResources:
          $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData'
      description: Information about the workspace update.
      title: workspaceUpdateData
    getWorkspaceUpdates:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/workspaceUpdateData'
          description: A list of workspace updates.
        meta:
          $ref: '#/components/schemas/meta'
      title: getWorkspaceUpdates
    GetWorkspaceUpdatesRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceUpdatesRequestInternalServerError
    createWorkspaceUpdate:
      type: object
      properties:
        description:
          type: string
          minLength: 1
          maxLength: 20000
          description: The content of the workspace update.
        topic:
          type: string
          minLength: 1
          maxLength: 255
          description: The title of the workspace update.
        category:
          $ref: '#/components/schemas/workspaceUpdateCategoryData'
        relatedResources:
          $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData'
      required:
        - description
        - topic
        - category
      title: createWorkspaceUpdate
    workspaceUpdatePostPatchResponseData:
      type: object
      properties:
        id:
          type: integer
          description: The workspace update's ID.
        topic:
          type: string
          description: The title of the workspace update.
        description:
          type: string
          description: The content of the workspace update.
        workspaceId:
          type: string
          description: The ID of the workspace in which the workspace update was created.
        createdBy:
          type: integer
          description: The user ID of the user that created the workspace update.
        updatedBy:
          type: integer
          description: The ID of the user who last updated the workspace update.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the workspace update was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the workspace update was last updated.
        category:
          $ref: '#/components/schemas/workspaceUpdateCategoryData'
        isPinned:
          type: boolean
          default: false
          description: If true, the workspace update is pinned to the top of the workspace updates list.
        relatedResources:
          $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData'
      title: workspaceUpdatePostPatchResponseData
    CreateWorkspaceUpdateRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: CreateWorkspaceUpdateRequestInternalServerError
    workspaceUpdateId:
      type: integer
      title: workspaceUpdateId
    GetWorkspaceUpdateRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: GetWorkspaceUpdateRequestInternalServerError
    DeleteWorkspaceUpdateRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: DeleteWorkspaceUpdateRequestInternalServerError
    updateWorkspaceUpdate:
      type: object
      properties:
        description:
          type: string
          minLength: 1
          maxLength: 20000
          description: The content of the workspace update.
        topic:
          type: string
          minLength: 1
          maxLength: 255
          description: The title of the workspace update.
        category:
          $ref: '#/components/schemas/workspaceUpdateCategoryData'
        isPinned:
          type: boolean
          default: false
          description: If true, the workspace update is pinned to the top of the workspace updates list.
        relatedResources:
          $ref: '#/components/schemas/workspaceUpdateRelatedResourcesData'
      required:
        - description
        - topic
        - category
      title: updateWorkspaceUpdate
    PatchWorkspaceUpdateRequestInternalServerError:
      oneOf:
        - $ref: '#/components/schemas/commonErrorTypeTitleDetail'
        - $ref: '#/components/schemas/commonErrorTypeTitleDetailStatus'
        - $ref: '#/components/schemas/commonErrorNameMessage'
      title: PatchWorkspaceUpdateRequestInternalServerError
    limitDefault100Max100:
      type: integer
      minimum: 1
      maximum: 100
      default: 100
      title: limitDefault100Max100
    packageListData:
      type: object
      properties:
        id:
          type: string
          description: The package's unique ID.
        name:
          type: string
          pattern: ^[a-z][a-z0-9_-]*$
          minLength: 1
          maxLength: 200
          description: The package's immutable, lowercase import name.
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          description: The package's description.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the package was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the package was last updated.
      required:
        - id
        - name
        - description
        - createdAt
        - updatedAt
      title: packageListData
    getPackages:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/meta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/packageListData'
          description: A list of active packages.
      required:
        - meta
        - data
      title: getPackages
    createPackage:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
          minLength: 1
          maxLength: 200
          description: The package's import name. The service stores this value in lowercase.
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          default: ''
          description: The package's description. This value may be empty and only supports printable ASCII characters.
        script:
          type: string
          maxLength: 512000
          default: ''
          description: The package's initial index script content. This value may be empty.
      required:
        - name
      title: createPackage
    createPackageResponse:
      type: object
      properties:
        id:
          type: string
          description: The package's ID.
        name:
          type: string
          pattern: ^[a-z][a-z0-9_-]*$
          minLength: 1
          maxLength: 200
          description: The package's immutable, lowercase import name.
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          description: The package's description. This value may be empty and only supports printable ASCII characters.
        script:
          type: string
          maxLength: 512000
          description: The package's current index script content. This value may be empty.
        createdBy:
          type: integer
          minimum: 1
          description: The user ID of the user who created the package.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the package was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the package or its script was last updated.
      required:
        - id
        - name
        - description
        - script
        - createdBy
        - createdAt
        - updatedAt
      description: Information about the created package and its index script content.
      title: createPackageResponse
    packageId:
      type: string
      title: packageId
    packageData:
      type: object
      properties:
        id:
          type: string
          description: The package's ID.
        name:
          type: string
          pattern: ^[a-z][a-z0-9_-]*$
          minLength: 1
          maxLength: 200
          description: The package's immutable, lowercase import name.
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          description: The package's description. This value may be empty and only supports printable ASCII characters.
        script:
          type: string
          maxLength: 512000
          description: The package's current index script content. This value may be empty.
        createdBy:
          type: integer
          minimum: 1
          description: The user ID of the user who created the package.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the package was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the package or its script was last updated.
      required:
        - id
        - name
        - description
        - script
        - createdBy
        - createdAt
        - updatedAt
      description: Information about the package.
      title: packageData
    getPackage:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/packageData'
      description: Information about the created package and its index script content.
      title: getPackage
    updatePackage:
      type: object
      properties:
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          description: The package's description. This value may be empty and only supports printable ASCII characters.
        script:
          type: string
          maxLength: 512000
          description: The package's index script content. This value may be empty.
      title: updatePackage
    updatePackageResponse:
      type: object
      properties:
        id:
          type: string
          description: The package's ID.
        name:
          type: string
          pattern: ^[a-z][a-z0-9_-]*$
          minLength: 1
          maxLength: 200
          description: The package's immutable, lowercase import name.
        description:
          type: string
          pattern: ^[ -~]*$
          maxLength: 500
          description: The package's description. This value may be empty and only supports printable ASCII characters.
        script:
          type: string
          maxLength: 512000
          description: The package's current index script content. This value may be empty.
        createdBy:
          type: integer
          minimum: 1
          description: The user ID of the user who created the package.
        createdAt:
          type: string
          format: date-time
          description: The date and time at which the package was created.
        updatedAt:
          type: string
          format: date-time
          description: The date and time at which the package or its script was last updated.
      required:
        - id
        - name
        - description
        - script
        - createdBy
        - createdAt
        - updatedAt
      description: Information about the package.
      title: updatePackageResponse
  securitySchemes:
    PostmanApiKey:
      type: apiKey
      in: header
      name: x-api-key
    basicAuth:
      type: http
      scheme: basic
    scimApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        A valid [SCIM API
        key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key)
        for calls to SCIM endpoints.
