Skip to content

Add response title information #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: wordpress
Choose a base branch
from
+3 −0
Open

Add response title information #308

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/spec-explained/responses.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,16 @@ The `schema` keyword is used to describe the response body. A schema can define:
* a primitive such as a number or string – used for plain text responses,
* `file` (see [below](#response-that-returns-a-file)).

Optionally, `schema` can define a `title` with a descriptive name for the response type. `title` allows code generators to specify a meaningful result type name instead of generic names like result1.

Schema can be defined inline in the operation:

```
responses:
200:
description: A User object
schema:
title: GetUserResponse
type: object
properties:
id:
Expand Down