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

Support tags in service annotations #2817

Closed
kkolur opened this issue Jul 25, 2022 · 7 comments · Fixed by #2858
Closed

Support tags in service annotations #2817

kkolur opened this issue Jul 25, 2022 · 7 comments · Fixed by #2858

Comments

@kkolur
Copy link
Contributor

kkolur commented Jul 25, 2022

It seems that the service option in OpenAPI configuration file is not working, or at least I am unable to get it to work.

The protoc compiles and successfully generates the swagger but the tags is not getting updated with the description set by the service tag. Here is OpenAPIServiceOption

I also checked unannotated_echo_service.swagger.yaml and could not find the corresponding service description in unannotated_echo_service.swagger.json (which im assuming is the generated swagger output of unannotated_echo_service.swagger.yaml)

However, in the a_bit_of_everything.proto where the annotations are in the proto file, it seems the tags for the service are properly generated in a_bit_of_everything.swagger.json

@kkolur kkolur changed the title Service option in OpenAPI configuration not working? Service option in external OpenAPI configuration file not working? Jul 26, 2022
@kkolur
Copy link
Contributor Author

kkolur commented Jul 26, 2022

@johanbrandhorst johanbrandhorst changed the title Service option in external OpenAPI configuration file not working? Support tags in service annotations Jul 26, 2022
@johanbrandhorst
Copy link
Collaborator

I think it is just the tags, as you say, not the entire service option. I have updated the title. Would you be interesting in helping implement this?

@johanbrandhorst
Copy link
Collaborator

See also: #2751

@numacci21
Copy link
Contributor

Hi @johanbrandhorst, can I try to work on this issue?

@johanbrandhorst
Copy link
Collaborator

Hi, yes, please feel free to start working on this, thank you!

@Rajarshi1998
Copy link

I would like to contribute to fix this issue. Thank you!!

@johanbrandhorst
Copy link
Collaborator

We have an open PR already: #2858. No need to start work on this.

johanbrandhorst pushed a commit that referenced this issue Sep 15, 2022
* fix: support service tags in OpenAPI config file

* chore: add test for service tags support

* fix: change the config priority for service tags
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants