Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade github.com/pb33f/libopenapi to v0.14.4 #111

Merged
merged 4 commits into from
Dec 21, 2023
Merged

Conversation

austinvalle
Copy link
Member

@austinvalle austinvalle commented Dec 20, 2023

Supersedes #109, #113

This PR contains a version bump from github.com/pb33f/libopenapi v0.13.22 -> v0.14.4, along with all the fixes for breaking changes to the code structure. The original release notes can be found in the linked dependabot PR (#109) but I will summarize the effects on tfplugingen-openapi here.

Fixes from downstream

  • I can't find a relevant GH issue from downstream, but the only change I see to our acceptance tests are that int32 default values are now properly being detected, where before they must have been not populated properly? I created a changelog for it, but the related OpenAPI spec's seem to match the behavior we have now 👍🏻 . All 3 of the properties showing changes in the kubernetes test look the same:

image

Changes from downstream

  • The biggest change is the libopenapi data model can be traversed in the exact order as defined in the OpenAPI spec, this manifests itself in a switch from using the Go built-in map, to a new orderedmap type. The construction of this type in tests has changed as well as how you iterate over it.
    • Iterating over the orderedmap now requires a context.Context, which I have replaced with a context.TODO for now.
  • The (Parameter).Required field changed from bool to *bool
  • (Schema).Default and (Schema).Enum now use *yaml.Node instead of any . Type assertions have been replaced with YAML unmarshaling/decoding.

@austinvalle austinvalle added this to the v0.3.0 milestone Dec 20, 2023
@austinvalle austinvalle requested a review from a team as a code owner December 20, 2023 18:46
@austinvalle austinvalle added the dependencies Pull requests that update a dependency file label Dec 20, 2023
Copy link
Contributor

@bendbennett bendbennett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@austinvalle austinvalle changed the title Upgrade github.com/pb33f/libopenapi to v0.14.3 Upgrade github.com/pb33f/libopenapi to v0.14.4 Dec 21, 2023
@austinvalle austinvalle merged commit d996181 into main Dec 21, 2023
3 checks passed
@austinvalle austinvalle deleted the av/bump-libopenapi branch December 21, 2023 14:51
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants