Add atomic operations to OpenAPI document #3248
Open
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.
Description
This adds the JSON API atomic operations to the OpenAPI document.
This also fixes issues with the generation of OpenAPI 3.1 documents and other issues.
specVersion
andopenapi
values onOpenAPI
are now appropriately set when configured to use OpenAPI 3.1/info/version
is a required property and is now set to an empty string if null./info/version
is now not overridden if the annotation does not set the version.Motivation and Context
This makes the atomic operations feature more visible and easier to use.
There are 8 different operations that can be performed in atomic operations
The specific request bodies needed for each of the operations can be difficult to remember without examples so the examples and descriptions were added to make it easier.
How Has This Been Tested?
Added / changed the appropriate unit / integration tests.
Also tested that the generate OpenAPI document can be successfully processed by the
openapi-generator-cli
.Screenshots (if appropriate):
License
I confirm that this contribution is made under an Apache 2.0 license and that I have the authority necessary to make this contribution on behalf of its copyright owner.