Cannot nest embedded resource description

[notfelineit]

I can't nest an embedded resource description like so:

public_api :GET, "/users/:name/regions", "Get a user's regions"
param :name, String, desc: "Name of the user"
returns code: 200, desc: "Returns the user's regions" do
    property :data, Array, of: Region
end
def regions
    # some logic here
end

where Region is a model that has the self.describe_own_properties defined.

It only works if Region is returned at the top level of the returns block:

returns code: 200, array_of: Region, desc: "Returns the user's regions"

This is not ideal because we have some classes that we'd like to reuse across our controllers as resource descriptions.

[notfelineit]

Accidentally closed this issue - this is still a feature we'd like.

[mathieujobin]

If you can try to implement it with tests, I will review and can incorporate. Unfortunately, I don't have time to work on feature requests.

Thank you for your understanding

[xaviertholot]

I'm very interested in this feature as well. ATM the only workaround I have is to do:

public_api :GET, "/users/:name/regions", "Get a user's regions"
param :name, String, desc: "Name of the user"
returns code: 200, desc: "Returns the user's regions" do
    property :data, array_of: Hash do
        param_group: Region
    end
end
def regions
    # some logic here
end

However what doesn't work is that on the open API documentation, it doesn't pass the param_group as a reference but spreads/duplicates the whole definition. It would be amazing to factorize it so that the param groups are defined only once and reused in all APIs they are used. This is especially useful when using Swagger clients with typescript definitions of an API.