Skip to content

Commit

Permalink
fix(docs): update audiences.mdx to include audiences for openapi serv…
Browse files Browse the repository at this point in the history
…ers (#4401)

Update audiences.mdx

Adds description of how to enable audiences for openapi servers
  • Loading branch information
RohinBhargava authored Aug 23, 2024
1 parent 084edef commit d9308ac
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions fern/pages/api-definition/openapi/extensions/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,20 @@ navigation:

</Info>

## Audiences for Servers

To mark a server with a particular audience, add the `x-fern-server-name` and `x-fern-audiences` extension to the relevant server.

In the example below, the `Production` server is only available to public consumers:

```yaml title="openapi.yml" {3-5}
servers:
- url: https://api.com
x-fern-server-name: Production
x-fern-audiences:
- public
```

## Audiences for Endpoints

To mark an endpoint with a particular audience, add the `x-fern-audiences` extension to the relevant endpoint.
Expand Down

0 comments on commit d9308ac

Please sign in to comment.