Skip to content
This repository has been archived by the owner on Feb 4, 2025. It is now read-only.

Add JSON Response Schemas #198

Open
wsugarman opened this issue Feb 17, 2018 · 4 comments
Open

Add JSON Response Schemas #198

wsugarman opened this issue Feb 17, 2018 · 4 comments
Assignees

Comments

@wsugarman
Copy link

While the examples on the API docs page (Eg. the member responses) are helpful, they do not have the exact schema information, nor are they always up-to-date. It would be great if the latest response schemas were available online and complete with type information. For example, it would be really helpful to know the range for numeric IDs or even the possible values for a given string: is there a set of valid strings, a regex, or could it be anything?

JSON schemas would remove any ambiguity of what to expect.

@wsugarman wsugarman changed the title JSON Response Schemas Add JSON Response Schemas Feb 17, 2018
@ndawg
Copy link

ndawg commented Nov 14, 2019

I think this would be good for a V2 of the API. A lot of the responses could be reworked to be structured much better and to be more consistent in general. @dwillis is this something you guys would be interested in pursuing?

@dwillis
Copy link
Contributor

dwillis commented Nov 15, 2019

@ndawg Yeah, that seems doable.

@dwillis dwillis self-assigned this Nov 15, 2019
@wsugarman
Copy link
Author

Perhaps the documentation could leverage the OpenAPI Specification 3.0 for detailing request and response schemas.

@ndawg
Copy link

ndawg commented Nov 20, 2019

Definitely agree, OpenAPI spec is the way to go. It's a widely used standard, and it allows codegen and other features.

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

3 participants