Logo
30 Day Challange API Documentation

Update a schema

PUT https://api.getpostman.com/apis/{{apiId}}/versions/{{apiVersionId}}/schemas/{{schemaId}}

This endpoint is deprecated in Qodex v10 and higher.

Updates an API definition. The request body must contain a schema object with the following properties:

  • type — A string value that contains the API definition's type. One of:
    • openapi3_1
    • openapi3
    • openapi2
    • openapi1
    • raml
    • raml1
    • wsdl1
    • wsdl2
    • graphql
    • proto2
    • graphql
    • proto3
  • language — A string value that contains the API definition's language. One of:
    • OpenAPI and RAML — json or yaml
    • GraphQL — graphql
    • WSDL — xml
    • Protobuf — proto
  • schema — Optional. A string value that contains the API definition's contents.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status OK

{ "schema": { "id": "16bb367e-fafb-4ef3-933b-ee3d971866fb", "language": "yaml", "apiVersion": "a9879d02-74bf-425a-bbec-6d27aa135507", "type": "openapi3", "createdBy": "12345678", "updatedBy": "12345678", "createdAt": "2021-05-22T13:17:07.000Z", "updatedAt": "2021-05-22T13:17:07.000Z" } }



Curl
curl -X PUT 'https://api.getpostman.com/apis/undefined/versions/undefined/schemas/undefined' -H 'Content-Type: application/json' -d '{"schema":{"language":"undefined","schema":"undefined","type":"undefined"}}'

ENDPOINTS