Skip to content

fix: Use summary/description instead of title for field comments in openapi gen #5759

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

iamrajiv
Copy link
Contributor

References to other Issues or PRs

Fixes: #3381

Have you read the Contributing Guidelines?

Brief description of what is fixed or changed

Other comments

iamrajiv added 8 commits July 23, 2025 18:45
- Add model_v1_book_name_body.go and model_v1_book_name_body_1.go
- These files were generated as part of the comment processing changes
- Required to pass Bazel gazelle consistency check
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

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

Please use the correct version of swagger-codegen, see CONTRIBUTING.md. We should probably update it but not as part of this PR please.

2.4.47-SNAPSHOT
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why was this changed?

@@ -5070,8 +5070,7 @@
"readOnly": true
}
},
"description": "The book's `name` field is used to identify the book to be updated.\nFormat: publishers/{publisher}/books/{book}",
"title": "The book to update.",
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like the title disappeared, was that intentional?

@iamrajiv
Copy link
Contributor Author

sorry @johanbrandhorst there was an issue with the swagger version in my system and because of that more code was pushed i will update it accordingly

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.

Comments on a property of a message that are other proto messages become title breaking Swagger generation
2 participants