Add support for unserializable annotations on OpenAPI document #1769
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.
Addresses #1719.
This PR adds support for unserizable property bags to the
OpenApiDocument,
OpenApiOperation, and
OpenApiSchema` to support managing in-memory metadata about a given OpenAPI instance without having these properties embedded into the serialized document.Annotations
andIOpenApiAnnotatable
as the names used in this API to align with the "ble" naming style used elsehwere. Open to other name ideas.Annotations
are not eagerly initialized by the API to avoid allocating them when not necessary. It's up to the end-user to initialize the dictionary before appending elements to it.OpenApiDocument
,OpenApiOperation
, andOpenApiSchema
types at the moment to support ASP.NET Core's scenarios. We can evaluate what other types it makes sense to apply this interface to.Annotatations
property uses the same copy semantics used by other Dictionary properties in the copy constructor.