UIFlowchartCreator

docs
api
summaries
## Mocks

### Implemented Operations
- Get all mock servers (`GET /mocks`)
  - Parameters:
    - `#/components/parameters/teamIdResultsQuery`
    - `#/components/parameters/workspaceResultsQuery`
  - Note: If both teamId and workspace provided, only workspace is used
  - Responses:
    - 200: `#/components/responses/getMocks`
    - 401: `#/components/responses/common401Error`
    - 500: `#/components/responses/common500ErrorServerError`

- Create mock server (`POST /mocks`)
  - Parameters:
    - `#/components/parameters/workspaceIdQuery`
  - Note: Creates in Personal workspace if workspace not specified
  - Note: Cannot create mocks for collections added to an API definition
  - Request Body: `#/components/requestBodies/createMock`
    - Required fields:
      - collection: Collection ID to mock
      - name: Mock server name
    - Optional fields:
      - description: Mock server description
      - environment: Environment ID to use
      - private: Access control setting
      - versionTag: Collection version tag
  - Responses:
    - 200: `#/components/responses/mockCreateUpdate`
    - 400: `#/components/responses/paramMissing400Error`
    - 401: `#/components/responses/common401Error`
    - 500: `#/components/responses/common500ErrorServerError`

- Get specific mock server (`GET /mocks/{mockId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Responses:
    - 200: `#/components/responses/getMock`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Update mock server (`PUT /mocks/{mockId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Request Body: `#/components/requestBodies/updateMock`
    - Optional fields:
      - name: New mock server name
      - description: Updated description
      - environment: New environment ID
      - private: Updated access control setting
      - versionTag: Updated collection version tag
  - Responses:
    - 200: `#/components/responses/mockCreateUpdate`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Delete mock server (`DELETE /mocks/{mockId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Responses:
    - 200: `#/components/responses/deleteMock`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Get mock call logs (`GET /mocks/{mockId}/call-logs`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
    - `#/components/parameters/limitDefault100`
    - `#/components/parameters/cursor`
    - `#/components/parameters/until`
    - `#/components/parameters/since`
    - `#/components/parameters/mockResponseStatusCode`
    - `#/components/parameters/mockResponseType`
    - `#/components/parameters/mockRequestMethod`
    - `#/components/parameters/mockRequestPath`
    - `#/components/parameters/mockSortServedAt`
    - `#/components/parameters/direction`
    - `#/components/parameters/mockInclude`
  - Note: Maximum 6.5MB or 100 call logs per API call
  - Note: Retention period based on Postman plan
  - Responses:
    - 200: `#/components/responses/getMockCallLogs`
    - 400: `#/components/responses/mock400ErrorLogRetentionPeriodExceeded`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Publish mock server (`POST /mocks/{mockId}/publish`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Description: Sets Access Control to public
  - Responses:
    - 200: `#/components/responses/publishMock`
    - 400: `#/components/responses/mock400ErrorAlreadyPublished`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Unpublish mock server (`DELETE /mocks/{mockId}/unpublish`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Description: Sets Access Control to private
  - Responses:
    - 200: `#/components/responses/unpublishMock`
    - 400: `#/components/responses/mock400ErrorAlreadyUnpublished`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

#### Server Responses
- Get all server responses (`GET /mocks/{mockId}/server-responses`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Responses:
    - 200: `#/components/responses/getMockServerResponses`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Create server response (`POST /mocks/{mockId}/server-responses`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
  - Description: Simulates server-level responses (e.g., 5xx errors)
  - Note: Server responses are agnostic to application-level logic
  - Note: Only one server response can be active at a time
  - Request Body: `#/components/requestBodies/createMockServerResponse`
    - Required fields:
      - name: Response name
      - code: HTTP status code
      - headers: Response headers
      - body: Response body content
    - Optional fields:
      - active: Set as active response
      - delay: Response delay in milliseconds
  - Responses:
    - 200: `#/components/responses/mockServerResponse`
    - 400: `#/components/responses/paramMissing400Error`
    - 401: `#/components/responses/common401Error`
    - 500: `#/components/responses/common500ErrorServerError`

- Get server response (`GET /mocks/{mockId}/server-responses/{serverResponseId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
    - `#/components/parameters/serverResponseId` (required)
  - Responses:
    - 200: `#/components/responses/mockServerResponse`
    - 400: `#/components/responses/serverResponseNotFound400Error`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

- Update server response (`PUT /mocks/{mockId}/server-responses/{serverResponseId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
    - `#/components/parameters/serverResponseId` (required)
  - Request Body: `#/components/requestBodies/updateMockServerResponse`
    - Optional fields:
      - name: Updated response name
      - code: Updated HTTP status code
      - headers: Updated response headers
      - body: Updated response body
      - active: Change active status
      - delay: Updated response delay
  - Responses:
    - 200: `#/components/responses/mockServerResponse`
    - 400: `#/components/responses/paramMissing400Error`
    - 401: `#/components/responses/common401Error`
    - 500: `#/components/responses/common500ErrorServerError`

- Delete server response (`DELETE /mocks/{mockId}/server-responses/{serverResponseId}`)
  - Parameters:
    - `#/components/parameters/mockId` (required)
    - `#/components/parameters/serverResponseId` (required)
  - Responses:
    - 200: `#/components/responses/deleteMockServerResponse`
    - 400: `#/components/responses/serverResponseNotFound400Error`
    - 401: `#/components/responses/common401Error`
    - 404: `#/components/responses/mock400ErrorInstanceNotFound`
    - 500: `#/components/responses/common500ErrorServerError`

### Key Features
- Mock server management
- Call logging and history
- Custom server responses
- Public/private visibility control
- Response simulation (5xx errors)
- Workspace integration
- Call log retention based on plan