ruby-grape / ruby-grape/grape

Dependent params

Open
#1,599 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Ruby
Stars
10k
Forks
1.2k
Avg merge
14h 38m
Merged PRs (30d)
92

Description

Based on documentation one can use dependent params with the following

  optional :category
  given category: ->(val) { val == 'foo' } do
    requires :description
  end
end

where category in itself is a param however I would like something like the following

  given api_key: ->(val) { val == 'foo' } do
    requires :description
  end
end

where api_key is not a param but a header which is already parsed in the base api class and is available. Is this possible ?

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 dependent-params documentation and the base API class where the header is already parsed. Trace how given conditions access declared parameters, then determine whether the existing API supports using that header value. Done means the supported behavior is clearly documented and the conditional requirement is covered by an appropriate test.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.