openapi-directory/api/getpostman.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.3","servers":[{"url":"https://api.getpostman.com"}],"info":{"contact":{},"description":"The Postman API allows you to programmatically access data stored in Postman account with ease.\n\nThe easiest way to get started with the API is to click the **fork** button to fork this collection to your own workspace and use Postman to send requests.\n\n\n# Overview\n\n1. You need a valid <a href=\"#authentication\">API Key</a> to send requests to the API endpoints. You can get your key from the [integrations dashboard](https://go.postman.co/settings/me/api-keys).\n\n1. The API has an access <a href=\"#rate-limits\">rate limit</a> applied to it.\n\n1. The Postman API will only respond to secured communication done over HTTPS. HTTP requests will be sent a `301` redirect to corresponding HTTPS resources.\n\n1. Response to every request is sent in [JSON format](https://en.wikipedia.org/wiki/JSON). In case the API request results in an error, it is represented by an `\"error\": {}` key in the JSON response.\n\n1. The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from Postman, and `POST` implies you want to save something new to Postman.\n\n1. The API calls will respond with appropriate [HTTP status codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) for all requests. Within Postman Client, when a response is received, the status code is highlighted and is accompanied by a help text that indicates the possible meaning of the response code. A `200 OK` indicates all went well, while `4XX` or `5XX` response codes indicate an error from the requesting client or our API servers respectively.\n\n1. Individual resources in your Postman Account is accessible using its unique id (`uid`). The `uid` is a simple concatenation of the resource owner's user-id and the resource-id. For example, a collection's `uid` is `{{owner_id}}-{{collection_id}}`.\n\n# Authentication\n\nAn API Key is required to be sent as part of every request to the Postman API, in the form of an `X-Api-Key` request header.\n\n> If you do not have an API Key, you can easily generate one by heading over to the [Postman Integrations Dashboard](https://go.postman.co/integrations/services/pm_pro_api).\n\nAn API Key tells our API server that the request it received came from you. Everything that you have access to in Postman is accessible with an API Key that is generated by you.\n\nFor ease of use inside Postman, you could store your API key in an [environment variable](https://www.getpostman.com/docs/environments) called `postman_api_key` and this [Collection](https://www.getpostman.com/docs/collections) will automatically use it to make API calls.\n\n## API Key related error response\n\nIf an API Key is missing, malformed, or invalid, you will receive a `401 Unauthorised` response code and the following JSON response:\n\n```\n{\n  \"error\": { \n    \"name\": \"AuthenticationError\",\n    \"message\": \"API Key missing. Every request requires an API Key to be sent.\"\n  }\n}\n```\n\n## Using the API Key as a query parameter\n\nEvery request that accepts API Key as `X-Api-Key` request header, also accepts the key when sent as `apikey` URL query parameter.\n\nAPI key sent as part of the header has a higher priority in case you send the key using both request header and query parameter.\n\n\n# Rate Limits\n\nAPI access rate limits are applied at a per-key basis in unit time. Access to the API using a key is limited to **60 requests per minute**. In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.\n\n\n| Header                  | Description |\n|-------------------------|-------------|\n| `X-RateLimit-Limit`     | The maximum number of requests that the consumer is permitted to make per minute. |\n| `X-RateLimit-Remaining` | The number of requests remaining in the current rate limit window. |\n| `X-RateLimit-Reset`     | The time at which the current rate limit window resets in UTC epoch seconds. |\n\n\nOnce you hit the rate limit, you will receive a response similar to the following JSON, with a status code of `429 Too Many Requests`.\n\n```json\n{\n  \"error\": {\n    \"name\": \"rateLimitError\",\n    \"message\": \"Rate Limit exceeded. Please retry at 1465452702843\"\n  }\n}\n```\n\n\n# Support\n\nFor help regarding accessing the Postman API, feel free to discuss it in our [Discourse Community](https://community.getpostman.com). You can also drop in a line at [help@getpostman.com](mailto:help@getpostman.com).\n\nIn the event you receive a `503` response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 5 minutes. If the outage persists, or your receive any other form of `5XX` error, kindly let us know.\n\n\n# Terms of Use\n\nFor information on API terms of use and privacy, refer to our terms at [http://postman.com/legal/terms/](http://postman.com/legal/terms/) and our privacy policy at [https://www.postman.com/legal/privacy-policy/](https://www.postman.com/legal/privacy-policy/).\n\n\n# API Reference","title":"Postman API","version":"1.20.0","x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://www.vectorlogo.zone/logos/getpostman/getpostman-ar21.svg"},"x-origin":[{"format":"openapi","url":"https://gist.githubusercontent.com/MikeRalphson/f5dd7e7e712a4f2caa8f1783f1053dbc/raw/05fb7ae8b877b37d93413a0b8183bf60c2e1bdfe/postman-api.yaml","version":"3.0"}],"x-providerName":"getpostman.com"},"tags":[{"name":"Collections"},{"name":"Environments"},{"name":"Mocks"},{"name":"Monitors"},{"name":"Workspaces"},{"name":"User"},{"name":"Import"},{"name":"API"},{"description":"This folder contains the requests around API versions.","name":"API Version"},{"description":"This folder contains all the endpoints related to Schemas.","name":"Schema"},{"description":"This contains requests related to relations. \n\nRelations can be of the following types: \n- `contracttest`\n- `integrationtest`\n- `documentation`\n- `testsuite`\n- `environment`\n- `mock`\n- `monitor`","name":"Relations"},{"description":"With webhooks you can trigger a collection at a specific time with your own custom payload which can then be accessed in the collection.\n\nLearn more about webhooks in our [learning center](https://learning.postman.com/docs/designing-and-developing-your-api/monitoring-your-api/integrations-for-alerts/).","name":"Webhooks"}],"paths":{"/apis":{"get":{"description":"This call fetches all the APIs present in the specified workspace\n\nResponse contains an array named `apis` which would contain all the details of APIs present in the workspace.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getAllApIs","parameters":[{"description":"Only return APIs that are inside the given workspace.","in":"query","name":"workspace","schema":{"example":"{{workspaceId}}","type":"string"}},{"description":"Only return APIs that have been updated after this time. Time is represented using the ISO 8601 date and time format.","in":"query","name":"since","schema":{"example":"{{since}}","type":"string"}},{"description":"Only return APIs that have been updated before this time. Time is represented using the ISO 8601 date and time format.","in":"query","name":"until","schema":{"example":"{{until}}","type":"string"}},{"description":"Only return APIs that have been created by the user ID represented by the given value.","in":"query","name":"createdBy","schema":{"example":"{{createdBy}}","type":"string"}},{"description":"Only return APIs that have been updated by the user ID represented by the given value.","in":"query","name":"updatedBy","schema":{"example":"{{updatedBy}}","type":"string"}},{"description":"Only return APIs with the corresponding privacy state. Public APIs have the isPublic value true; private APIs have the isPublic value false.","in":"query","name":"isPublic","schema":{"example":"{{isPublic}}","type":"string"}},{"description":"Only return APIs whose name includes the given value. Matching is case insensitive.","in":"query","name":"name","schema":{"example":"{{name}}","type":"string"}},{"description":"Only return APIs whose summary includes the given value. Matching is case insensitive.","in":"query","name":"summary","schema":{"example":"{{summary}}","type":"string"}},{"description":"Only return APIs whose description includes the given value. Matching is case insensitive.","in":"query","name":"description","schema":{"example":"{{description}}","type":"string"}},{"description":"The value of sort can be one of the names of the fields included in the response.","in":"query","name":"sort","schema":{"example":"{{sort}}","type":"string"}},{"description":"The sorting direction, which can be ascending or descending. The value can be asc to specify an ascending direction or desc to specify a descending direction. If none is specified, the default sorting direction is descending for timestamp and numeric fields and ascending otherwise. An ID is not considered a numeric field.","in":"query","name":"direction","schema":{"example":"{{direction}}","type":"string"}}],"responses":{"200":{"description":""}},"summary":"Get all APIs","tags":["API"]},"post":{"description":"This call creates a new API with a default API Version.  \n\nRequest body should contain an `api` object which should atleast have a property `name`.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description`, etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"createApi","parameters":[{"in":"query","name":"workspace","schema":{"example":"{{workspaceId}}","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"api":{"description":"This is description.","name":"Sync Service API","summary":"This is supposed to be a short summary."}},"schema":{"properties":{"api":{"properties":{"description":{"example":"This is description.","type":"string"},"name":{"example":"Sync Service API","type":"string"},"summary":{"example":"This is supposed to be a short summary.","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Create API":{"value":{"api":{"createdAt":"2025-06-15T13:47:53.557Z","createdBy":"5665","description":"This is supposed to handle markdown *descriptions*.","id":"387c2863-6ee3-4a56-8210-225f774edade","name":"Sync API","summary":"This is a summary","updatedAt":"2025-06-15T13:47:53.557Z"}}}},"schema":{"properties":{"api":{"properties":{"createdAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"description":{"example":"This is supposed to handle markdown *descriptions*.","type":"string"},"id":{"example":"387c2863-6ee3-4a56-8210-225f774edade","type":"string"},"name":{"example":"Sync API","type":"string"},"summary":{"example":"This is a summary","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Create API"}},"summary":"Create API","tags":["API"]}},"/apis/{apiId}":{"delete":{"description":"This call deletes an existing API having the specified id.  \n\nResponse contains an `api` object with `id` of the API which was deleted.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"deleteAnApi","responses":{"200":{"content":{"application/json":{"examples":{"Delete an API":{"value":{"api":{"id":"387c2863-6ee3-4a56-8210-225f774edade"}}}},"schema":{"properties":{"api":{"properties":{"id":{"example":"387c2863-6ee3-4a56-8210-225f774edade","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Delete an API"}},"summary":"Delete an API","tags":["API"]},"get":{"description":"This call fetches a single API having the specified id.\n\nResponse contains an `api` object with all the details related to the queried API, namely, `id`, `name`, `summary`, `description` etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"singleApi","responses":{"200":{"content":{"application/json":{"examples":{"Get single API":{"value":{"api":{"createdAt":"2025-06-15T13:47:53.557Z","createdBy":"5665","description":"This is a description.This is a description.","id":"387c2863-6ee3-4a56-8210-225f774edade","name":"Sync API","summary":"This is a summary","updatedAt":"2025-06-15T13:47:53.557Z"}}}},"schema":{"properties":{"api":{"properties":{"createdAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"description":{"example":"This is a description.This is a description.","type":"string"},"id":{"example":"387c2863-6ee3-4a56-8210-225f774edade","type":"string"},"name":{"example":"Sync API","type":"string"},"summary":{"example":"This is a summary","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Get single API"}},"summary":"Single API","tags":["API"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}}],"put":{"description":"This call updates an existing API .  \n\nRequest body should contain an `api` object which should have the fields to be updated. Only `name`, `summary` and `description` fields can be edited for an API.\n\nResponse contains an `api` object with all the details related to the created API, namely, `id`, `name`, `summary`, `description` etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"updateAnApi","requestBody":{"content":{"application/json":{"example":{"api":{"description":"This is an updated Description","name":"New name"}},"schema":{"properties":{"api":{"properties":{"description":{"example":"This is an updated Description","type":"string"},"name":{"example":"New name","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Update an API":{"value":{"api":{"createdAt":"2025-06-15T13:47:53.557Z","createdBy":"5665","description":"This is a description.","id":"387c2863-6ee3-4a56-8210-225f774edade","name":"Sync API","summary":"This is a summary","updatedAt":"2025-06-15T13:47:53.557Z"}}}},"schema":{"properties":{"api":{"properties":{"createdAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"description":{"example":"This is a description.","type":"string"},"id":{"example":"387c2863-6ee3-4a56-8210-225f774edade","type":"string"},"name":{"example":"Sync API","type":"string"},"summary":{"example":"This is a summary","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Update an API"}},"summary":"Update an API","tags":["API"]}},"/apis/{apiId}/versions":{"get":{"description":"This call fetches details about the all the API Versions in the specified API.\n\nThe response will contain an array `versions` object which would be a list of all the API Version along with their details.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getAllApiVersions","responses":{"200":{"content":{"application/json":{"examples":{"Get All API versions":{"value":{"versions":[{"createdAt":"2025-06-15T13:47:53.557Z","createdBy":"5665","description":"Description","id":"024660a6-c837-46ca-91d8-7e8dd7c669de","name":"0.1","summary":"Summary","updatedAt":"2025-06-15T13:47:53.557Z"},{"createdAt":"2025-06-15T13:47:53.557Z","createdBy":"5665","description":"Description","id":"00932d3b-20f1-454f-a77e-38b4023163ea","name":"0.2","summary":"Summary","updatedAt":"2025-06-15T13:47:53.557Z"}]}}},"schema":{"properties":{"versions":{"items":{"properties":{"createdAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"description":{"example":"Description","type":"string"},"id":{"example":"024660a6-c837-46ca-91d8-7e8dd7c669de","type":"string"},"name":{"example":"0.1","type":"string"},"summary":{"example":"Summary","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.557Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get All API versions"}},"summary":"Get All API Versions","tags":["API","API Version"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}}],"post":{"description":"This call creates a new API version in the specified API.  \n\nRequest body should contain a `version` object which should have fields:\n\n<table>\n<tr>\n\t<td>name</td>\n\t<td>Required. Name of the API Version</td>\n</tr>\n<tr>\n\t<td>source</td>\n\t<td>\n\t\tIf specified, it will copy the contents of the specified api version to create a new api verison.\n\t\t<table>\n\t\t\t<tr>\n\t\t\t\t<td>id</td>\n\t\t\t\t<td>Required. Id of the apiversion from where the details are to be copied</td>\n\t\t\t</tr>\n\t\t\t<tr>\n\t\t\t\t<td>schema</td>\n\t\t\t\t<td>Boolean. If true then copies the schema from the specified api version</td>\n\t\t\t</tr>\n\t\t\t<tr>\n\t\t\t\t<td>relations</td>\n\t\t\t\t<td>Object. {\"&lt;relationType&gt;\": true/false}.  \n\t\t\t\t\tAllowed relation types are `mock`, `monitor`, `documentation`, `contracttest`, `integrationtest`, `testsuite`, `environment`\n\t\t\t\tRelation types which should be copied over to the new api verison</td>\n\t\t\t</tr>\n\t\t</table>\n\t</td>\n</tr>\n</table>\n\nResponse contains a `version` object with all the details related to the created API Version, namely, `id`, `name`, `api`.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"createApiVersion","requestBody":{"content":{"application/json":{"example":{"version":{"name":"1.0","source":{"id":"{{apiVersionId}}","relations":{"documentation":true,"mock":true,"monitor":true},"schema":true}}},"schema":{"properties":{"version":{"properties":{"name":{"example":"1.0","type":"string"},"source":{"properties":{"id":{"example":"{{apiVersionId}}","type":"string"},"relations":{"properties":{"documentation":{"example":true,"type":"boolean"},"mock":{"example":true,"type":"boolean"},"monitor":{"example":true,"type":"boolean"}},"type":"object"},"schema":{"example":true,"type":"boolean"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Create API version":{"value":{"version":{"api":"2b95d07c-8379-4bd1-924f-e7e1af185284","id":"d71cf403-c549-4c7c-9dc6-a6a105acf67c","name":"1.0"}}}},"schema":{"properties":{"version":{"properties":{"api":{"example":"2b95d07c-8379-4bd1-924f-e7e1af185284","type":"string"},"id":{"example":"d71cf403-c549-4c7c-9dc6-a6a105acf67c","type":"string"},"name":{"example":"1.0","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Create API version"}},"summary":"Create API Version","tags":["API","API Version"]}},"/apis/{apiId}/versions/{apiVersionId}":{"delete":{"description":"This call deletes an existing API Version having the specified id.  \n\nResponse contains an `version` object with `id` of the API Version which was deleted.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"deleteAnApiVersion","responses":{"200":{"content":{"application/json":{"examples":{"Delete an API version":{"value":{"version":{"id":"03c17f53-7e2e-427d-b55a-006b244f29ff"}}}},"schema":{"properties":{"version":{"properties":{"id":{"example":"03c17f53-7e2e-427d-b55a-006b244f29ff","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Delete an API version"}},"summary":"Delete an API Version","tags":["API","API Version"]},"get":{"description":"This call fetches details about the specified API Version.\n\nThe response will contain a `version` object which would contain all the details of the API Version.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getAnApiVersion","responses":{"200":{"content":{"application/json":{"examples":{"Get an API version":{"value":{"version":{"api":"06e41ca3-8bea-4bc5-a726-70338b9f1940","createdAt":"2025-06-15T13:47:53.558Z","createdBy":"5665","id":"03c17f53-7e2e-427d-b55a-006b244f29ff","name":"0.1","schema":["3484cd1e-e00d-4c39-aea4-539663afe898"],"updatedAt":"2025-06-15T13:47:53.558Z","updatedBy":"5665"}}}},"schema":{"properties":{"version":{"properties":{"api":{"example":"06e41ca3-8bea-4bc5-a726-70338b9f1940","type":"string"},"createdAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"id":{"example":"03c17f53-7e2e-427d-b55a-006b244f29ff","type":"string"},"name":{"example":"0.1","type":"string"},"schema":{"items":{"example":"3484cd1e-e00d-4c39-aea4-539663afe898","type":"string"},"type":"array"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"updatedBy":{"example":"5665","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Get an API version"}},"summary":"Get an API Version","tags":["API","API Version"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}],"put":{"description":"This call updates an existing API Version.  \n\nRequest body should contain a `version` object with the fields which need to be updated. Only field which can be updated is `name`.\n\nResponse contains a `version` object with all the details related to the created API Version, namely, `id`, `name`, `api` etc.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"updateAnApiVersion","requestBody":{"content":{"application/json":{"example":{"version":{"name":"2.0"}},"schema":{"properties":{"version":{"properties":{"name":{"example":"2.0","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Update an API version":{"value":{"version":{"api":"2b95d07c-8379-4bd1-924f-e7e1af185284","createdAt":"2025-06-15T13:47:53.558Z","createdBy":"12","id":"d71cf403-c549-4c7c-9dc6-a6a105acf67c","name":"2.0","updatedAt":"2025-06-15T13:47:53.558Z","updatedBy":"5665"}}}},"schema":{"properties":{"version":{"properties":{"api":{"example":"2b95d07c-8379-4bd1-924f-e7e1af185284","type":"string"},"createdAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"createdBy":{"example":"12","type":"string"},"id":{"example":"d71cf403-c549-4c7c-9dc6-a6a105acf67c","type":"string"},"name":{"example":"2.0","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"updatedBy":{"example":"5665","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Update an API version"}},"summary":"Update an API Version","tags":["API","API Version"]}},"/apis/{apiId}/versions/{apiVersionId}/contracttest":{"get":{"description":"This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getContractTestRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get contract test relations":{"value":{"contracttest":[{"collectionId":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"},{"collectionId":"7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725","id":"521b0486-ab91-4d3a-9189-43c9380a0533","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"}]}}},"schema":{"properties":{"contracttest":{"items":{"properties":{"collectionId":{"example":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","type":"string"},"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get contract test relations"}},"summary":"Get contract test relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}]},"/apis/{apiId}/versions/{apiVersionId}/documentation":{"get":{"description":"This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getDocumentationRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get documentation relations":{"value":{"documentation":[{"collectionId":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"},{"collectionId":"7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725","id":"521b0486-ab91-4d3a-9189-43c9380a0533","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"}]}}},"schema":{"properties":{"documentation":{"items":{"properties":{"collectionId":{"example":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","type":"string"},"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get documentation relations"}},"summary":"Get  documentation relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}]},"/apis/{apiId}/versions/{apiVersionId}/environment":{"get":{"description":"This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getEnvironmentRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get environment relations":{"value":{"environment":[{"id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"},{"id":"521b0486-ab91-4d3a-9189-43c9380a0533","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"}]}}},"schema":{"properties":{"environment":{"items":{"properties":{"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get environment relations"}},"summary":"Get environment relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}]},"/apis/{apiId}/versions/{apiVersionId}/integrationtest":{"get":{"description":"This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getIntegrationTestRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get integration test relations":{"value":{"integrationtest":[{"collectionId":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"},{"collectionId":"7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725","id":"521b0486-ab91-4d3a-9189-43c9380a0533","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"}]}}},"schema":{"properties":{"integrationtest":{"items":{"properties":{"collectionId":{"example":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","type":"string"},"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get integration test relations"}},"summary":"Get integration test relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}]},"/apis/{apiId}/versions/{apiVersionId}/monitor":{"get":{"description":"This call fetches all the relations by type which are linked to the specified API version along with their details.\n\nThe response will contain an array with key `{{relationType}}`. Each of the item will consist of all the details related each of the relation.\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getMonitorRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get monitor relations":{"value":{"monitor":[{"id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","monitorId":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"},{"id":"521b0486-ab91-4d3a-9189-43c9380a0533","monitorId":"7332157-a8bcd143-2b01-4b12-8c14-c7d05be77725","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"}]}}},"schema":{"properties":{"monitor":{"items":{"properties":{"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"monitorId":{"example":"7732157-a8bcd149-2b01-4b4c-8c14-c7d05be77745","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"Get monitor relations"}},"summary":"Get monitor relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}]},"/apis/{apiId}/versions/{apiVersionId}/relations":{"get":{"description":"This call fetches all the relations which are linked to the specified API version along with their details.\n\nThe response will contain a `relations` object which lists all the relation types which are linked to the API version. Each of the relation type will be an object which details the relations of this type. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getLinkedRelations","responses":{"200":{"content":{"application/json":{"examples":{"Get linked relations for an API version":{"value":{"relations":{"contracttest":{"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2":{"id":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"}},"integrationtest":{"521b0486-ab91-4d3a-9189-43c9380a0533":{"id":"521b0486-ab91-4d3a-9189-43c9380a0533","name":"C1","updatedAt":"2025-06-15T13:47:53.558Z"},"a236b715-e682-460b-97b6-c1db24f7612e":{"id":"a236b715-e682-460b-97b6-c1db24f7612e","name":"C test","updatedAt":"2025-06-15T13:47:53.558Z"}},"mock":{"4ccd755f-2c80-481b-a262-49b55e12f5e1":{"id":"4ccd755f-2c80-481b-a262-49b55e12f5e1","name":"Mock","updatedAt":"2025-06-15T13:47:53.558Z","url":"https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io"}}}}}},"schema":{"properties":{"relations":{"properties":{"contracttest":{"properties":{"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2":{"properties":{"id":{"example":"2a9b8fa8-88b7-4b86-8372-8e3f6f6e07f2","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"}},"type":"object"},"integrationtest":{"properties":{"521b0486-ab91-4d3a-9189-43c9380a0533":{"properties":{"id":{"example":"521b0486-ab91-4d3a-9189-43c9380a0533","type":"string"},"name":{"example":"C1","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"},"a236b715-e682-460b-97b6-c1db24f7612e":{"properties":{"id":{"example":"a236b715-e682-460b-97b6-c1db24f7612e","type":"string"},"name":{"example":"C test","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"}},"type":"object"},"mock":{"properties":{"4ccd755f-2c80-481b-a262-49b55e12f5e1":{"properties":{"id":{"example":"4ccd755f-2c80-481b-a262-49b55e12f5e1","type":"string"},"name":{"example":"Mock","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"url":{"example":"https://4ccd755f-2c80-481b-a262-49b55e12f5e1.mock-beta.pstmn.io","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}},"description":"Get linked relations for an API version"}},"summary":"Get linked relations","tags":["API","Relations"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}],"post":{"description":"This call allows you to add existing Postman entities as new relations to an API. The request body should contain the relations to be created along with an array of entity IDs. \n\n<table>\n  <tr>\n    <th>Relation</th>\n    <th>Entity ID type</th>\n  <tr>\n  <tr>\n    <td>contracttest</td>\n    <td>Collection UIDs</td>\n  </tr>\n  <tr>\n    <td>integrationtest</td>\n    <td>Collection UIDs</td>\n  </tr>\n  <tr>\n    <td>documentation</td>\n    <td>Collection UIDs</td>\n  </tr>\n  <tr>\n    <td>testsuite</td>\n    <td>Collection UIDs</td>\n  </tr>\n  <tr>\n    <td>environment</td>\n    <td>Environment UIDs</td>\n  </tr>\n  <tr>\n    <td>mock</td>\n    <td>Mock IDs</td>\n  </tr>\n  <tr>\n    <td>monitor</td>\n    <td>Monitor IDs</td>\n  </tr>\n</table>\n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"createRelations","requestBody":{"content":{"application/json":{"example":{"contracttest":["collection-uid-1"],"documentation":["collection-uid-3"],"mock":["mock-uid-1"],"testsuite":["collection-uid-1","collection-uid-2"]},"schema":{"properties":{"contracttest":{"items":{"example":"collection-uid-1","type":"string"},"type":"array"},"documentation":{"items":{"example":"collection-uid-3","type":"string"},"type":"array"},"mock":{"items":{"example":"mock-uid-1","type":"string"},"type":"array"},"testsuite":{"items":{"example":"collection-uid-1","type":"string"},"type":"array"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Create multiple relations from existing collections":{"value":{"contracttest":["5bcece87-ca4b-4e75-a967-2a6845626164"],"documentation":["2084eba6-a17b-4751-8f03-ea60f30ba19c"],"testsuite":["e525fa71-035e-4620-acda-ce878524f1e7","17a974b2-ce79-4b95-9d3f-217d6ff7e979"]}}},"schema":{"properties":{"contracttest":{"items":{"example":"5bcece87-ca4b-4e75-a967-2a6845626164","type":"string"},"type":"array"},"documentation":{"items":{"example":"2084eba6-a17b-4751-8f03-ea60f30ba19c","type":"string"},"type":"array"},"testsuite":{"items":{"example":"e525fa71-035e-4620-acda-ce878524f1e7","type":"string"},"type":"array"}},"type":"object"}}},"description":"Create multiple relations from existing collections"}},"summary":"Create relations","tags":["API","Relations"]}},"/apis/{apiId}/versions/{apiVersionId}/schemas":{"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}}],"post":{"description":"This call creates a new schema.\n\nRequest body should contain a `schema` object which should atleast have these properties with `string` values:\n\n- **`type`**: Allowed types are `openapi3`, `openapi2`, `openapi1`, `raml` and `graphql`.\n- **`language`** : Allowed languages are `json` and `yaml` for OpenAPI and RAML schema types. GraphQL schema type accepts only `graphql` language.\n- **`schema`**: Optional. If passed, must be the content of the schema as a `string`.\n\nResponse contains a `schema` object with all the details related to the created schema, namely, `id`, `language`, `type` etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"createSchema","requestBody":{"content":{"application/json":{"example":{"schema":{"language":"yaml","schema":"{\n  \"openapi\": \"3.0.0\",\n  \"info\": null,\n  \"version\": \"v1.0\",\n  \"title\": \"APi\",\n  \"servers\": [\n    {\n      \"url\": \"http://localhost:3000\"\n    }\n  ],\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"summary\": \"Returns details about a particular user\",\n        \"operationId\": \"listUser\",\n        \"tags\": [\n          \"user\"\n        ],\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"query\",\n            \"description\": \"ID of the user\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"integer\",\n              \"format\": \"int32\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Details about a user by ID\",\n            \"headers\": {\n              \"x-next\": {\n                \"description\": \"A link to the next page of responses\",\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            },\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n                }\n              }\n            }\n          },\n          \"default\": {\n            \"description\": \"Unexpected error\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"components\": {\n    \"schemas\": {\n      \"User\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"id\",\n          \"name\"\n        ],\n        \"properties\": {\n          \"id\": {\n            \"type\": \"integer\",\n            \"format\": \"int64\"\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"tag\": {\n            \"type\": \"string\"\n          }\n        }\n      },\n      \"Error\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"code\",\n          \"message\"\n        ],\n        \"properties\": {\n          \"code\": {\n            \"type\": \"integer\",\n            \"format\": \"int32\"\n          },\n          \"message\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}","type":"openapi3"}},"schema":{"properties":{"schema":{"properties":{"language":{"example":"yaml","type":"string"},"schema":{"example":"{\n  \"openapi\": \"3.0.0\",\n  \"info\": null,\n  \"version\": \"v1.0\",\n  \"title\": \"APi\",\n  \"servers\": [\n    {\n      \"url\": \"http://localhost:3000\"\n    }\n  ],\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"summary\": \"Returns details about a particular user\",\n        \"operationId\": \"listUser\",\n        \"tags\": [\n          \"user\"\n        ],\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"query\",\n            \"description\": \"ID of the user\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"integer\",\n              \"format\": \"int32\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Details about a user by ID\",\n            \"headers\": {\n              \"x-next\": {\n                \"description\": \"A link to the next page of responses\",\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            },\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n                }\n              }\n            }\n          },\n          \"default\": {\n            \"description\": \"Unexpected error\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"components\": {\n    \"schemas\": {\n      \"User\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"id\",\n          \"name\"\n        ],\n        \"properties\": {\n          \"id\": {\n            \"type\": \"integer\",\n            \"format\": \"int64\"\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"tag\": {\n            \"type\": \"string\"\n          }\n        }\n      },\n      \"Error\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"code\",\n          \"message\"\n        ],\n        \"properties\": {\n          \"code\": {\n            \"type\": \"integer\",\n            \"format\": \"int32\"\n          },\n          \"message\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}","type":"string"},"type":{"example":"openapi3","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"examples":{"Create schema":{"value":{"schema":{"apiVersion":"ad810c39-df60-434e-a76f-a2192cd8d81f","createdAt":"2025-06-15T13:47:53.558Z","createdBy":"5665","id":"e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822","language":"yaml","type":"openapi3","updateBy":"5665","updatedAt":"2025-06-15T13:47:53.558Z"}}}},"schema":{"properties":{"schema":{"properties":{"apiVersion":{"example":"ad810c39-df60-434e-a76f-a2192cd8d81f","type":"string"},"createdAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"id":{"example":"e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822","type":"string"},"language":{"example":"yaml","type":"string"},"type":{"example":"openapi3","type":"string"},"updateBy":{"example":"5665","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Create schema"}},"summary":"Create Schema","tags":["API","Schema"]}},"/apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}":{"get":{"description":"This call fetches a single schema having the specified id.\n\nResponse contains a `schema` object with all the details related to the schema, namely, `id`, `language`, `type`, `schema` etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"getSchema","responses":{"200":{"content":{"application/json":{"examples":{"Get schema":{"value":{"schema":{"apiVersion":"ad810c39-df60-434e-a76f-a2192cd8d81f","createdAt":"2025-06-15T13:47:53.558Z","createdBy":"5665","id":"e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822","language":"yaml","type":"openapi3","updateBy":"5665","updatedAt":"2025-06-15T13:47:53.558Z"}}}},"schema":{"properties":{"schema":{"properties":{"apiVersion":{"example":"ad810c39-df60-434e-a76f-a2192cd8d81f","type":"string"},"createdAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"},"createdBy":{"example":"5665","type":"string"},"id":{"example":"e3b3a0b7-34d5-4fc5-83e0-118bd9e8c822","type":"string"},"language":{"example":"yaml","type":"string"},"type":{"example":"openapi3","type":"string"},"updateBy":{"example":"5665","type":"string"},"updatedAt":{"example":"2025-06-15T13:47:53.558Z","type":"string"}},"type":"object"}},"type":"object"}}},"description":"Get schema"}},"summary":"Get Schema","tags":["API","Schema"]},"parameters":[{"in":"path","name":"apiId","required":true,"schema":{"type":"string"}},{"in":"path","name":"apiVersionId","required":true,"schema":{"type":"string"}},{"in":"path","name":"schemaId","required":true,"schema":{"type":"string"}}],"put":{"description":"This call updates an existing schema.\n\nRequest body should contain a `schema` object which should atleast have these properties with `string` values:\n\n- **`type`**: Allowed types are `openapi3`, `openapi2`, `openapi1`, `raml` and `graphql`.\n- **`language`** : Allowed languages are `json` and `yaml` for OpenAPI and RAML schema types. GraphQL schema type accepts only `graphql` language.\n- **`schema`**: Optional. If passed, must be the content of the schema as a `string`.\n\nResponse contains a `schema` object with all the details related to the created schema, namely, `id`, `language`, `type` etc. \n\n> Requires <a href=\"#authentication\">API Key</a> as `X-Api-Key` request header or `apikey` URL query parameter.","operationId":"updateSchema","requestBody":{"content":{"application/json":{"example":{"schema":{"language":"json","schema":"{\n  \"openapi\": \"3.0.0\",\n  \"info\": null,\n  \"version\": \"v1.0\",\n  \"title\": \"APi\",\n  \"servers\": [\n    {\n      \"url\": \"http://localhost:3000\"\n    }\n  ],\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"summary\": \"Returns details about a particular user\",\n        \"operationId\": \"listUser\",\n        \"tags\": [\n          \"user\"\n        ],\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"query\",\n            \"description\": \"ID of the user\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"integer\",\n              \"format\": \"int32\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Details about a user by ID\",\n            \"headers\": {\n              \"x-next\": {\n                \"description\": \"A link to the next page of responses\",\n                \"schema\": {\n                  \"type\": \"string\"\n                }\n              }\n            },\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/User\\\\'\"\n                }\n              }\n            }\n          },\n          \"default\": {\n            \"description\": \"Unexpected error\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"$ref\": \"\\\\'#/components/schemas/Error\\\\'\"\n                }\n              }\n            }\n          }\n        }\n      }\n    }\n  },\n  \"components\": {\n    \"schemas\": {\n      \"User\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"id\",\n          \"name\"\n        ],\n        \"properties\": {\n          \"id\": {\n            \"type\": \"integer\",\n            \"format\": \"int64\"\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"tag\": {\n            \"type\": \"string\"\n          }\n        }\n      },\n      \"Error\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"code\",\n          \"message\"\n        ],\n        \"properties\": {\n          \"code\": {\n            \"type\": \"integer\",\n            \"format\": \"int32\"\n          },\n          \"message\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}","type":"openapi3"}},"schema":{"properties":{"schema":{"properties":{"language":{"example":"json","type":"string"},"schema":{"example":"{\n  \"openapi\": \"3.0.0\",\n  \"info\": null,\n  \"version\": \"v1.0\",\n  \"title\": \"APi\",\n  \"servers\": [\n    {\n      \"url\": \"http://localhost:3000\"\n    }\n  ],\n  \"paths\": {\n    \"/user\": {\n      \"get\": {\n        \"summary\": \"Returns details about a particular user\",\n        \"operationId\": \"listUser\",\n        \"tags\": [\n          \"user\"\n        ],\n        \"parameters\": [\n          {\n            \"name\": \"id\",\n            \"in\": \"query\",\n            \"description\": \"ID of the user\",\n            \"required\": true,\n            \"schema\": {\n              \"type\": \"integer\",\n              \"format\": \"int32\"\n            }\n          }\n        ],\n        \"responses\": {\n          \"200\": {\n            \"description\": \"Details about a user by ID\",\n            \"headers\": {\n              \"x-next\": {\n                \"description\": \"A link to the next page of responses\",\n                \"schema\": {\n