Generated by API Evangelist
Written by API Evangelist tooling for Postman's API. It is a proposal applied on top of the contract, not a document Postman publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Postman APIs API Comments API Schemas API
version: 1.0.0
extends: openapi/postman-api-schemas-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/apis/{apiId}/schemas'].get
update:
x-apievangelist-phrasing:
intent: List an API's schemas
effect: read
questions:
- Which schemas are defined for one of my APIs?
- Does my API have an OpenAPI, RAML or GraphQL schema attached?
instructions:
- text: List all schemas of API {apiId}.
slots:
apiId: path.apiId
- text: Show the first {limit} schemas attached to API {apiId}.
slots:
limit: query.limit
apiId: path.apiId
method: generated
generated: '2026-09-26'
- target: $.paths['/apis/{apiId}/schemas'].post
update:
x-apievangelist-phrasing:
intent: Create a schema for an API
effect: write
questions:
- How do I add a GraphQL or OpenAPI schema to an API?
- Can I specify the schema language, like JSON or YAML, when creating it?
instructions:
- text: Create a {type} schema in {language} for API {apiId} with content {schema}.
slots:
type: requestBody.type
language: requestBody.language
apiId: path.apiId
schema: requestBody.schema
- text: Add schema {schema} to API {apiId} as {type} written in {language}.
slots:
schema: requestBody.schema
apiId: path.apiId
type: requestBody.type
language: requestBody.language
method: generated
generated: '2026-09-26'
- target: $.paths['/apis/{apiId}/schemas/{schemaId}'].get
update:
x-apievangelist-phrasing:
intent: Get an API schema with its content
effect: read
questions:
- How do I read the content of one schema on an API?
- What type and language is a particular API schema?
instructions:
- text: Get schema {schemaId} of API {apiId}.
slots:
schemaId: path.schemaId
apiId: path.apiId
- text: Show the content of API {apiId}'s schema {schemaId}.
slots:
apiId: path.apiId
schemaId: path.schemaId
method: generated
generated: '2026-09-26'
- target: $.paths['/apis/{apiId}/schemas/{schemaId}/files'].get
update:
x-apievangelist-phrasing:
intent: List files in a multi-file API schema
effect: read
questions:
- What files make up a multi-file API schema?
- Can I see each file associated with a schema?
instructions:
- text: List the files of schema {schemaId} in API {apiId}.
slots:
schemaId: path.schemaId
apiId: path.apiId
- text: Show every file associated with API {apiId}'s schema {schemaId}.
slots:
apiId: path.apiId
schemaId: path.schemaId
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.