Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Auth API References #270

Open
chpapa opened this issue Feb 4, 2020 · 0 comments
Open

Improve Auth API References #270

chpapa opened this issue Feb 4, 2020 · 0 comments

Comments

@chpapa
Copy link
Contributor

chpapa commented Feb 4, 2020 •
edited
Loading

https://generator.swagger.io/?url=https://skygeario.github.io/skygear-server/apis/auth/1ee2cce.yaml

  1. Make it explicit which request parameters is optional / required, both on schema and example values
  2. Use real-life example value instead of dummy string like "type string" as of now, make it more descriptive and easier to read
@chpapa chpapa changed the title Make it clear on API reference, what request parameters are required/optional Improve Auth API References Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chpapa