Update "Changing Operations [...]" section #1284
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
[This section](https://api-platform.com/docs/core/openapi/#changing-operations-in-the-openapi-documentation) uses a configuration format that works for version 2 of OpenApi, which clashes with the default for the distribution (v3). The documentation example simply does not work out of the box. Users updating are also being [hit by this](api-platform/core#4035). Included an example with attributes, instead of annotations, since [we should always use the latest version of dependencies on documentation](#1272 (comment)).
|
The new |
alanpoulain
reviewed
Feb 15, 2021
alanpoulain
reviewed
Feb 15, 2021
|
Hello, thank you for this PR 🙂 |
alanpoulain
reviewed
Feb 15, 2021
alanpoulain
approved these changes
Feb 15, 2021
|
Thank you @yivi! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This section uses a configuration format that works for version 2 of OpenApi, which clashes with the default for the distribution (v3). The documentation example simply does not work out of the box.
Users updating are also being hit by this.
Included an example with attributes, instead of annotations, since we should always use the latest version of dependencies on documentation.