ruby-grape / ruby-grape/grape-entity
Question: What is `in: "header"` about?
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 729
- Forks
- 154
- PR merge metrics
- No merged PRs in 30d
Description
I was looking for a way to not expose some attributes to the openapi-spec.json entities representations and I found that there was in: "header" option in the documentation hash that hides it.
Based on that I wanted to know what's the purpose of that option in the documentation hash.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the documentation hash and the in: "header" option in the generated openapi-spec.json representations. Clarify what the option does and why it exists, then document that behavior where the project keeps its documentation; no specific documentation file or test is identified in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100