Provide a generic interface for requires: complex type.

[dblock]

http://pastebin.com/QQV0NJ5K

  # Entity
  module API
  module Entities
    class Article < Grape::Entity
      expose :title, documentation: { type: 'string', desc: 'Title' }
      expose :body, documentation: { type: 'string', desc: 'Body' }
    end
  end
end

  # API
  desc "Create an article"
  params do
    requires :article, type: API::Entities::Article, documentation: { example: "aklsdfj" }
  end
  post '/articles' do
    puts params
    article = Article.create(params(:title, :body))
    represent(article, env)
  end

Currently:

# curl -X POST -H "Content-Type:application/json" 0:9292/v1/articles -d '{"title":"hello","body":"world"}'  
# {"error":"article is missing"}
# curl -X POST -H "Content-Type:application/json" 0:9292/v1/articles -d '{"article":{"title":"hello","body":"world"}}'
# {"error":"article is invalid"}

[antonzhyliuk]

👍

[dim]

+1

[0x5d]

Acording to the documentation , it is supported (in a way, I guess).

[birbird]

Hi, what's status of this issue?
I wrote something like

    params do
      requires :user, type: Entities::User
    end

But when I pass a user json as parameter, it throws {"error":"user is invalid"}

It the result expected or I made some mistake?

[dblock]

I believe #1039 has implemented this, @rnubel would you confirm and I'll close this issue? Is this any different from #993?

[dblock]

@birbird this is on HEAD FYI, not in any released version of Grape yet.

[dblock]

Maybe we need to do something built-in for Grape entities though ...

[birbird]

@dblock Thanks a lot for you help.

Actually, before I asked, I have tried exactly the same code with https://github.com/intridea/grape#custom-types, which is also the sample code in #1039. But got the {"error":"color is invalid"} sadly.

All the things can be explained with your reminder.

A little suggestion, if this feature has not been released, it should not be in the document.

[birbird]

But even with custom-types, Grape Entity still could not be processd.
custom-types require the input type is String, this is not the case for Entity.

[rnubel]

Yeah, like @birbird noted, #1039 added support for custom primitive types (i.e., something that can be parsed from a single string parameter) whereas this story requires support for complex types. And actually, grape does have support for that already, but only when done through Virtus. It would certainly be possible to also support coercion into Grape::Entitys, but that's not existing functionality.

[guizmaii]

Is it possible to express required/optional parameters in entities ?

With a required: parameters ?
Does it fail if the title in not passed in the following example ?
Or is it just documentation ?

module API
  module Entities
    class Article < Grape::Entity
      expose :title, documentation: { type: 'string', desc: 'Title', required: true }
      expose :body, documentation: { type: 'string', desc: 'Body', required: false }
    end
  end
end

Can we express complex validations as with "normal" params ? ( https://github.com/intridea/grape/blob/v0.12.0/README.md#parameter-validation-and-coercion)