api: switch to yaml for openapi spec snapshot test #3943
Merged
Conversation
This file contains 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
BacLuc
force-pushed
the
api-switch-to-yaml-for-openapi-spec-snapshot-test
branch
from
8fa86ea
to
4290d52
Compare
simfeld
approved these changes
Oct 12, 2023
carlobeltrame
requested changes
Oct 13, 2023
|
In API Platform 3.2, you can still retrieve the JSON OpenAPI spec if you add the following line to api_platform.yaml: docs_formats:
jsonhal: [ 'application/hal+json' ]
jsonld: [ 'application/ld+json' ]
jsonapi: [ 'application/vnd.api+json' ]
jsonopenapi: ['application/vnd.openapi+json'] # <-- add this
html: [ 'text/html' ]And then use the endpoint |
BacLuc
force-pushed
the
api-switch-to-yaml-for-openapi-spec-snapshot-test
branch
from
4290d52
to
da43b7f
Compare
…tchesSnapshot Because yaml can more easily be merged and diffed. Use our own copy of the YamlSnapshotDriver, because for some reason the yaml is parsed again if it is a string and then dumped with different parameters, which leads to an invalid openapi yaml file.
BacLuc
force-pushed
the
api-switch-to-yaml-for-openapi-spec-snapshot-test
branch
from
da43b7f
to
5dcf695
Compare
carlobeltrame
approved these changes
Oct 20, 2023
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.
It supports multi line string values, the url's are not escaped and you can navigate from type usage to the definition by clicking on it in Jetbrains Products, and it should be easier to diff and merge than json.
api: switch to yaml format in ResponseSnapshotTest::testOpenApiSpecMatchesSnapshot
Because yaml can more easily be merged and diffed.
Use our own copy of the YamlSnapshotDriver, because for some
reason the yaml is parsed again if it is a string
and then dumped with different parameters, which leads to an
invalid openapi yaml file.