mill icon indicating copy to clipboard operation
mill copied to clipboard

Need a way to document array object payloads

Open erunion opened this issue 7 years ago • 0 comments

https://api.vimeo.com/channels/:channel_id/privacy/users has a payload of the following:

[
    {"uri":"/users/:user_id"},
    {"uri":"/users/:user_id"},
    {"uri":"/users/:user_id"}
]

We can document the uri bit, but we have no way to document unnamed array payloads.

Maybe something like the following?

@api-payload (array<object>)
@api-param:public uri (string, required) - A user's URI.

If no @api-payload is present, it'll assume the payload is an object.

erunion avatar Sep 27 '18 14:09 erunion