Skip to content
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

docs: ✏️ Document how to hide input/output from OpenAPI #2076

Merged
merged 1 commit into from
Apr 22, 2022
Merged

docs: ✏️ Document how to hide input/output from OpenAPI #2076

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
13 changes: 13 additions & 0 deletions doc/endpoint/ios.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,19 @@ A fixed status code can be specified using the `statusCode(code)` output.
Unless specified otherwise, successful responses are returned with the `200 OK` status code, and errors with
`400 Bad Request`. For exception and decode failure handling, see [error handling](../server/errors.md).

## OpenAPI description

### Hidden input/output

It's possible to hide an input/output from the OpenAPI description using following syntax:

```scala mdoc:silent:reset
import sttp.tapir._

val acceptHeader: EndpointInput[String] = header[String]("Accept").schema(_.copy(hidden = true))
```


## Next

Read on about [one-of mappings](oneof.md).