Get Schema

GET {{baseUrl}}/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This request uses the Qodex API to retrieve the schema of the API with API ID apiId, version ID apiVersionId, and schema ID schemaId.

The successful response returns a 200 OK and the API schema. This request also sets the environment variable schemaContent to be the API schema.

If awsAPIId is empty, the next request is set to Update Schema. Otherwise, the next request is set to Post Schema to API Gateway.

HEADERS

KeyDatatypeRequiredDescription
x-mock-response-namestring

RESPONSES

status: OK

{"schema":{"createdBy":"00000000","updatedBy":"00000000","id":"a0a00000-0000-00aa-a00a-a0a00a0aa00a","type":"openapi3","language":"yaml","apiVersion":"a00000a0-000a-0aaa-a000-0000000aaa0a","createdAt":"2021-00-00T00:00:00.000Z","updatedAt":"2021-00-00T00:00:00.000Z","schema":"{{schemaContent}}"}}