POST /apis/{apiId}/versions/{apiVersionId}/schemas
This call creates a new schema.
Request body should contain a schema object which should atleast have these properties with string values:
type: Allowed types areopenapi3,openapi2,openapi1,ramlandgraphql.language: Allowed languages arejsonandyamlfor OpenAPI and RAML schema types. GraphQL schema type accepts onlygraphqllanguage.schema: Optional. If passed, must be the content of the schema as astring.
Response contains a schema object with all the details related to the created schema, namely, id, language, type etc.
Requires API Key as
X-Api-Keyrequest header orapikeyURL query parameter.
Servers
- https://api.getpostman.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
apiId |
String | Yes | |
apiVersionId |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
schema |
Object | No | |
schema.schema |
String | No | |
schema.type |
String | No | |
schema.language |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.