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

Improving Tag and Tags annotations #47

Closed
navidsh opened this issue Nov 21, 2017 · 2 comments
Closed

Improving Tag and Tags annotations #47

navidsh opened this issue Nov 21, 2017 · 2 comments

Comments

@navidsh
Copy link
Contributor

navidsh commented Nov 21, 2017

@Tag and @Tags annotations can be defined in one JAX-RS resources class and used in other classes. In the open source Swagger annotation definition, it is confusing how to refer to tags in different annotations.

Here is the proposal:

  • Adding the ref @Tag:
org.eclipse.microprofile.openapi.annotations.tags.Tag:
public @interface Tag {
    ...
    String ref() default "";
}

If ref field is defined in a @Tag, there is no need to define the name field.

  • Adding the ref s@Tags for easy referencing multiple tags:
org.eclipse.microprofile.openapi.annotations.tags.Tags:
public @interface Tags {
    ...
    String[] refs() default {};
}
@navidsh
Copy link
Contributor Author

navidsh commented Nov 22, 2017

I am working on this issue.

@arthurdm
Copy link
Member

Solved via merge #49

Azquelt pushed a commit to Azquelt/microprofile-open-api that referenced this issue Mar 17, 2022
aubi pushed a commit to aubi/microprofile-open-api that referenced this issue Mar 15, 2023
FISH-7118 Correct Version to Follow Patch Process
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants