Skip to content
This repository has been archived by the owner on May 23, 2024. It is now read-only.

Need a way to document array object payloads #195

Open
erunion opened this issue Sep 27, 2018 · 0 comments
Open

Need a way to document array object payloads #195

erunion opened this issue Sep 27, 2018 · 0 comments
Assignees

Comments

@erunion
Copy link
Owner

erunion commented Sep 27, 2018

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 erunion added this to the v5.0: Freddy's Revenge milestone Sep 27, 2018
@erunion erunion self-assigned this Sep 27, 2018
@erunion erunion changed the title Need a way to document array payloads Need a way to document array object payloads Apr 24, 2019
@erunion erunion removed this from the v6.0: Freddy's Revenge milestone May 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant