Endpoint Schema Snippet
The EndpointSchemaSnippet component is used to reference an endpoint’s schema from
your API Reference. Below are examples of referencing the schema for the POST /snippets endpoint.
If you want to reference a particular piece of the schema, you can use the optional selector prop
to specify the path to the schema you want to reference. The available selectors are: request,
request.path, request.query, request.body, response, and response.body.
Request
Response
Full Schema
Full
Path
Query
Body
Full Request
Passing request as the selector will only render the request schema.
The following markdown:
will be rendered as:
The EndpointSchemaSnippet component does not yet support rendering markdown-rich field descriptions.
See request.endpoint.path above for an example of a markdown-rich description that does not yet render as markdown.