Skip to content

Commit

Permalink
Update openapi.md (#1798)
Browse files Browse the repository at this point in the history
* Update openapi.md

- Allow developers to avoid spending two hours of searching for the documentation which list the availables configurations behing openapi attribute

* fix(core/openapi.md): wording

Co-authored-by: Kévin Dunglas <[email protected]>

* fix(openapi.md): move explanation to appropriate section

---------

Co-authored-by: Kévin Dunglas <[email protected]>
  • Loading branch information
filozofer and dunglas authored Oct 16, 2023
1 parent ffa98e2 commit 367d800
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions core/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,9 @@ The impact on the swagger-ui is the following:
## Using the OpenAPI and Swagger Contexts

Sometimes you may want to change the information included in your OpenAPI documentation.

For the full list of available configurations, please refer to the [OpenAPI Specifications](https://spec.openapis.org/oas/latest.html). The current doc page only gives some examples but focuses mostly on the OpenAPI integration inside API Platform without telling you all you can pass into the attributes.

The following configuration will give you total control over your OpenAPI definitions:

[codeSelector]
Expand Down

0 comments on commit 367d800

Please sign in to comment.