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

chore: upgrade openapi-generator to v7.8.0 #21

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ctreatma
Copy link
Contributor

No description provided.

@ctreatma ctreatma requested review from a team as code owners August 19, 2024 20:42
Comment on lines +298 to +303
if 'Accept' not in _header_params:
_header_params['Accept'] = self.api_client.select_header_accept(
[
'application/json'
]
)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These changes in the API classes are a result of OpenAPITools/openapi-generator#19025, which enables overriding the Accept header

@@ -39,7 +39,7 @@ print(AccessPoint.to_json())
# convert the object into a dict
access_point_dict = access_point_instance.to_dict()
# create an instance of AccessPoint from a dict
access_point_form_dict = access_point.from_dict(access_point_dict)
access_point_from_dict = AccessPoint.from_dict(access_point_dict)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These changes in the docs are a result of OpenAPITools/openapi-generator#18359, which fixes invalid code samples in docs.

Comment on lines +5 to +7
## Enum

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
* `COLO` (value: `'COLO'`)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These kinds of changes are a result of OpenAPITools/openapi-generator#18804, which includes supported enum values in the docs for enum models

Comment on lines +81 to +83
for _item_ntp in self.ntp:
if _item_ntp:
_items.append(_item_ntp.to_dict())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These sorts of changes are a result of OpenAPITools/openapi-generator#19223, which fixes a potential bug when models contain multiple list attributes with different element types.

@ctreatma
Copy link
Contributor Author

@equinix/governor-digin-fabric when you have a moment, please review, since most of the changes in this PR are to your service's generated code. I've attempted to annotate the changes, but it's possible I've missed some types of changes. Review of this may require a leap of faith, since the changes are so extensive; from what I've seen they're either non-impacting or they fix issues we would have run into soon enough.

@equinix/governor-devrel-engineering you're tagged for review on this because of the changes to:

  • .openapi-generator/VERSION, which is removed because of the .gitignore; chore: remove .openapi-generator directory #20 should prevent it being re-added by future release jobs
  • Makefile, which is updated to specify the new openapi-generator version
    You're welcome to look at and comment on other aspects of the PR, but those 2 changes are the ones tied to DRE code ownership.

@ctreatma ctreatma requested a review from a team as a code owner September 6, 2024 17:58
@ctreatma ctreatma marked this pull request as draft September 6, 2024 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant