ruby-grape / ruby-grape/grape-swagger

Assign Custom Resource Tags

Open
#689 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
1.1k
Forks
479
Avg merge
2d 14h
Merged PRs (30d)
6

Description

There is currently documentation for overriding tags for a resource, but it seems like that functionality has disappeared. Unlike a lot of the description options hash abilities, tags has also not made it into the description block directives.

@LeFnord, was it intentional to remove this functionality? I know that you can override tags like so, but I would like to be able to assign those custom tags to a resource to override the default tag creation and to better group my API endpoints.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked documentation for overriding tags and the tags example, then trace how resource tags are currently generated and how description block directives are handled. Add a way to assign custom tags to a resource and verify that those tags override the defaults and group the API endpoints as requested.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.