Transform collection to OpenAPI

GET

/collections/:collectionId/transformations

GET

/collections/:collectionId/transformations

$ curl https://api.getpostman.com/collections/12ece9e1-2abf-4edc-8e34-de66e74114d2/transformations \
>      -H "x-api-key: <apiKey>"

1 {
2   "output": "{\n  \"openapi\": \"3.0.3\",\n  \"info\": {\n    \"title\": \"Sample API\",\n    \"description\": \"Buy or rent spacecrafts\\n\\nContact Support:\\n Name: Jon\",\n    \"version\": \"1.0.0\",\n    \"contact\": {}\n  },\n  \"servers\": [\n    {\n      \"url\": \"example.com\"\n    }\n  ],\n  \"paths\": {\n    \"/spacecrafts/{spacecraftId}\": {\n      \"get\": {\n        \"tags\": [\n          \"spacecrafts\",\n          \"{spacecraftId}\"\n        ],\n        \"summary\": \"Read a spacecraft\",\n        \"description\": \"Read a spacecraft\",\n        \"operationId\": \"readASpacecraft\",\n        \"responses\": {\n          \"200\": {\n            \"description\": \"The spacecraft corresponding to the provided `spacecraftId`\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"description\": {\n                      \"type\": \"string\",\n                      \"example\": \"<string>\"\n                    },\n                    \"id\": {\n                      \"type\": \"string\",\n                      \"example\": \"<string>\"\n                    },\n                    \"name\": {\n                      \"type\": \"string\",\n                      \"example\": \"<string>\"\n                    },\n                    \"type\": {\n                      \"type\": \"string\",\n                      \"example\": \"satellite\"\n                    }\n                  }\n                },\n                \"examples\": {\n                  \"The spacecraft corresponding to the provided `spacecraftId`\": {\n                    \"value\": {\n                      \"description\": \"<string>\",\n                      \"id\": \"<string>\",\n                      \"name\": \"<string>\",\n                      \"type\": \"satellite\"\n                    }\n                  }\n                }\n              }\n            }\n          },\n          \"404\": {\n            \"description\": \"No spacecraft found for the provided `spacecraftId`\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"message\": {\n                      \"type\": \"string\",\n                      \"example\": \"<string>\"\n                    }\n                  }\n                },\n                \"examples\": {\n                  \"No spacecraft found for the provided `spacecraftId`\": {\n                    \"value\": {\n                      \"message\": \"<string>\"\n                    }\n                  }\n                }\n              }\n            }\n          },\n          \"500\": {\n            \"description\": \"Unexpected error\",\n            \"content\": {\n              \"application/json\": {\n                \"schema\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"message\": {\n                      \"type\": \"string\",\n                      \"example\": \"<string>\"\n                    }\n                  }\n                },\n                \"examples\": {\n                  \"Unexpected error\": {\n                    \"value\": {\n                      \"message\": \"<string>\"\n                    }\n                  }\n                }\n              }\n            }\n          }\n        }\n      },\n      \"parameters\": [\n        {\n          \"name\": \"spacecraftId\",\n          \"in\": \"path\",\n          \"required\": true,\n          \"schema\": {\n            \"type\": \"string\",\n            \"example\": \"<string>\"\n          },\n          \"description\": \"(Required) The unique identifier of the spacecraft\"\n        }\n      ]\n    }\n  },\n  \"components\": {\n    \"securitySchemes\": {\n      \"apiKey\": {\n        \"type\": \"apiKey\",\n        \"name\": \"X-Api-Key\",\n        \"in\": \"header\"\n      }\n    }\n  },\n  \"security\": [\n    {\n      \"apiKey\": []\n    }\n  ],\n  \"tags\": [\n    {\n      \"name\": \"spacecrafts\"\n    },\n    {\n      \"name\": \"{spacecraftId}\"\n    }\n  ]\n}"
3 }

Transforms an existing Postman Collection into a stringified OpenAPI definition.

Note:

This does not create an API.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

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.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

collectionIdstringRequired

The collection's ID.

Query parameters

formatenumOptionalDefaults to json

Return the OpenAPI definition in the given format.

Allowed values:

Response

Successful Response

outputstring

The collection's transformed output, in a stringified OpenAPI JSON or YAML format.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error