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

allow overriding tag definitions #589

Merged
merged 4 commits into from
Mar 2, 2017

Conversation

mattyr
Copy link
Contributor

@mattyr mattyr commented Feb 28, 2017

So you're not stuck with "Operations about xxxxxx"

@LeFnord
Copy link
Member

LeFnord commented Mar 1, 2017

thanks @mattyr … but please have in mind, that the generation of the tags in grape-swagger are strongly related to the paths and an overriding of it is actual implemented, see: overriding-the-tags

@mattyr
Copy link
Contributor Author

mattyr commented Mar 1, 2017

I did see that, however what I was looking to do was decouple that logic (if wanted). As it stands, it appears that the tag description is still fixed as "Operations about xxxxx", even if you reassign arbitrary tags to a path (correct me if i'm wrong!). The goal here is to still allow the existing "overriding-the-tags" (just re-assigning the tags), but allow the actual tag definitions (primarily the description) to be customized.

@mattyr mattyr force-pushed the customizable-tags branch from a3233fa to 2f421d6 Compare March 1, 2017 15:53
@coveralls
Copy link

coveralls commented Mar 1, 2017

Coverage Status

Changes Unknown when pulling 2f421d6 on mattyr:customizable-tags into ** on ruby-grape:master**.

end
add_swagger_documentation tags: [
{ name: 'something', description: 'customized description' }
]
Copy link
Member

@LeFnord LeFnord Mar 1, 2017

Choose a reason for hiding this comment

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

please can you add a second tag, so that it will be clear, that an existing tag can be overwritten and non-existing will be added, but only if I understand the tag description of the swagger-object right, please correct me, if I'm wrong, many thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

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

you're right, pushing a revised spec

@LeFnord
Copy link
Member

LeFnord commented Mar 2, 2017

@mattyr … please can you force push, to start travis, thanks

@mattyr
Copy link
Contributor Author

mattyr commented Mar 2, 2017

done -- @LeFnord out of curiosity, do you not have access to the travis ci to just restart the builds there?

@coveralls
Copy link

coveralls commented Mar 2, 2017

Coverage Status

Changes Unknown when pulling 393dc1b on mattyr:customizable-tags into ** on ruby-grape:master**.

@LeFnord
Copy link
Member

LeFnord commented Mar 2, 2017

Hi @mattyr yeap I have access, but there was no build to restart … say only s3 😉

@mattyr
Copy link
Contributor Author

mattyr commented Mar 2, 2017

haha gotcha. good ol' aws.

@LeFnord LeFnord merged commit 3b8cb13 into ruby-grape:master Mar 2, 2017
LeFnord pushed a commit to LeFnord/grape-swagger that referenced this pull request Feb 9, 2019
* allow overriding tag definitions

* add changelog, address rubocop issues

* add second tag to customized tag spec to make spec clearer

* bump travis
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.

3 participants