Transform collection to OpenAPI

GET {{baseUrl}}/collections/{{collectionId}}/transformations

Transforms an existing Qodex Collection into a stringified OpenAPI definition.

Note:

This does not create an API.

Request Params

KeyDatatypeRequiredDescription
formatstringReturn the OpenAPI definition in the given format:
  • json (default)
  • yaml |

RESPONSES

status: OK

{"output":"{\n  \"openapi\": \"3.0.3\",\n  \"info\": {\n    \"title\": \"Collection to API\",\n    \"version\": \"1.0.0\",\n    \"contact\": {}\n  },\n  \"servers\": [\n    {\n      \"url\": \"http://api.getpostman.com/\"\n    }\n  ],\n  \"paths\": {},\n  \"tags\": []\n}\n"}