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

Show whether a method is tagged as 'api' #3392

Merged
merged 1 commit into from Dec 5, 2022
Merged

Show whether a method is tagged as 'api' #3392

merged 1 commit into from Dec 5, 2022

Conversation

mvriel
Copy link
Member

@mvriel mvriel commented Dec 4, 2022

In the default template, there is no indication whether an element is tagged with the api tag, this change fixes that for methods at least.

Another change included in this commit is that we now properly do not render response descriptions, including the em-dash, when there is none to render, and when it is of type mixed without a description we also omit rendering of the result because it doesn't add anything.

Example rendering:

image

Fixes #3337

In the default template, there is no indication whether an element is
tagged with the `api` tag, this change fixes that for methods at least.

Another change included in this commit is that we now properly do not
render response descriptions, including the em-dash, when there is none
to render, and when it is of type mixed without a description we also
omit rendering of the result because it doesn't add anything.
@mvriel mvriel requested a review from jaapio December 4, 2022 12:08
@mvriel mvriel self-assigned this Dec 4, 2022
@mvriel mvriel removed their assignment Dec 4, 2022
@jaapio jaapio merged commit adaa0e3 into master Dec 5, 2022
@jaapio jaapio deleted the fix/3337 branch December 5, 2022 07:17
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.

@api tag dont work in default template?
2 participants