Explain OpenAPI representation of int and long types in .NET 10#35214
Merged
mikekistler merged 3 commits intomainfrom Apr 17, 2025
Merged
Explain OpenAPI representation of int and long types in .NET 10#35214mikekistler merged 3 commits intomainfrom
mikekistler merged 3 commits intomainfrom
Conversation
* Update OpenAPI document generation details * Format openApi.md for better readability
Rick-Anderson
approved these changes
Apr 14, 2025
Contributor
|
@mikekistler should this be added to the OpenApi docs? If so, open an issue for the relevant doc. |
| Support for OpenAPI 3.1 requires an update to the underlying OpenAPI.NET library to a new major version, 2.0. This new version has some breaking changes from the previous version. The breaking changes may impact apps if they have any document, operation, or schema transformers. | ||
| Breaking changes in this iteration include the following: | ||
|
|
||
| * Entities within the OpenAPI document, like operations and parameters, are typed as interfaces. Concrete implementations exist for the inlined and referenced variants of an entity. For example, an `IOpenApiSchema` can either be an inlined `OpenApiSchema` or an `OpenApiSchemaReference` that points to a schema defined elsewhere in the document. |
Member
There was a problem hiding this comment.
I left a comment similar to this here: microsoft/OpenAPI.NET#2298 (comment)
Like @Rick-Anderson said, this item can probably be copy-pasted right into their docs too.
Contributor
There was a problem hiding this comment.
Like @Rick-Anderson said, this item can probably be copy-pasted right into their docs too.
@martincostello can you recommend which doc and section?
Member
There was a problem hiding this comment.
I'm not sure about the section, but this is the document: https://github.com/microsoft/OpenAPI.NET/blob/main/docs/upgrade-guide-2.md
Co-authored-by: Martin Costello <martin@martincostello.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 PR adds an explanation for the change in how
intandlongproperties/parameters are represented in OpenAPI documents generated by .NET 10.I also used this opportunity to consolidate the information about the breaking changes introduces by OpenApi.Net v2.
Fixes dotnet/aspnetcore#61038
Internal previews