Skip to content

Spec: Fix incorrect reference to IcebergErrorResponse in notifications-api.yaml#957

Merged
flyrain merged 4 commits intoapache:mainfrom
HonahX:hoahx_fix_error_in_generated_spec
Feb 6, 2025
Merged

Spec: Fix incorrect reference to IcebergErrorResponse in notifications-api.yaml#957
flyrain merged 4 commits intoapache:mainfrom
HonahX:hoahx_fix_error_in_generated_spec

Conversation

@HonahX
Copy link
Copy Markdown
Contributor

@HonahX HonahX commented Feb 6, 2025

In notification-api.yaml, the current reference of IcebergErrorResponse is pointing to the wrong model. We should use the one defined in components/schemas instead of components/responses if we want to customize the example of the corresponding error code.

The incorrect reference cause a problematic responses-IcebergErrorResponse model be generated in the bundled-polaris-catalog-service.yaml, which cause an error in swagger editor.

Copy link
Copy Markdown
Contributor

@dimas-b dimas-b left a comment

Choose a reason for hiding this comment

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

Nice find! Thanks @HonahX !

Copy link
Copy Markdown
Contributor

@singhpk234 singhpk234 left a comment

Choose a reason for hiding this comment

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

LGTM as well !

@flyrain flyrain merged commit 772a402 into apache:main Feb 6, 2025
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.

4 participants