ruby-grape / ruby-grape/grape-entity

Nested Documentation

Open
#100 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
Ruby
Stars
729
Forks
154
PR merge metrics
No merged PRs in 30d

Description

When using Grape, Grape Entity and Grape Swagger and I have an entity with a nested object. Should we have the ability to provide nested documentation if that object has a nested object inside?

Example.

class User < Grape::Entity
  expose :id,        documentation: { type: 'Integer', desc: 'Id' }
  expose :firstname, documentation: { type: 'String', desc: 'First Name' }
  expose :lastname,  documentation: { type: 'String', desc: 'Last Name' }
  expose :username,  documentation: { type: 'String', desc: 'Username' }
  expose :email,     documentation: { type: 'String', desc: 'Email' }

  expose :location, using: API::Entities::Location, as: :location 

But when I call

API::Entities::User.documentation

it doesn't include my location inside the documentation hash.

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 API::Entities::User.documentation and the exposed API::Entities::Location relation, then trace how Grape::Entity builds the documentation hash for nested objects. Done means User.documentation includes the nested location documentation, including an object nested inside that location.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.