8000 Add API response payload structure info and examples to the docs site · Issue #381 · appwrite/appwrite · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add API response payload structure info and examples to the docs site #381

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
Closed
eldadfux opened this issue Jun 5, 2020 · 7 comments
Closed

Add API response payload structure info and examples to the docs site #381

eldadfux opened this issue Jun 5, 2020 · 7 comments
Assignees
@eldadfux @christyjacob4
Labels
enhancement New feature or request

Comments

@eldadfux
Copy link
Member
eldadfux commented Jun 5, 2020

This is the one major things the API spec docs are still missing. I have started working on creating a code layer to define all the API endpoint result objects and verify them. This will also come very handy for the GraphQL support issue (#272)
@eldadfux eldadfux added the enhancement New feature or request label Jun 5, 2020
@eldadfux eldadfux self-assigned this Jun 5, 2020
@eldadfux eldadfux mentioned this issue Sep 27, 2020
Closed
@eldadfux
Copy link
Member Author

@christyjacob4 We'll need to work on this together, because the homepage code is still not open-source.

The idea is to use the new Response object we introduced with Cloud Functions (branch: swoole-and-functions) and use it to parse the different response models inside our open-api spec route (https://localhost/v1/open-api-2.json?extensions=1&platform=console). Later we use the response of this route to parse appwrite.io docs.

Resources:

@christyjacob4
Copy link
Member

Sure @eldadfux just let me know a time and we can connect 👍

@eldadfux eldadfux mentioned this issue Nov 12, 2020
Merged
@eldadfux
Copy link
Member Author

This PR is a major step to get this issue resolved: #734

@eldadfux
Copy link
Member Author

This issue is now ready for deployment when v0.7 is available!

@eldadfux eldadfux 8000 added the waiting for release Fixed or implemented and waiting for a new version to be released label Nov 16, 2020
@eldadfux
Copy link
Member Author

image

@eldadfux
Copy link
Member Author

image

@eldadfux
Copy link
Member Author

Ready and available on https://appwrite.io/docs

@eldadfux eldadfux removed the waiting for release Fixed or implemented and waiting for a new version to be released label Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eldadfux eldadfux

@christyjacob4 christyjacob4

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@eldadfux @christyjacob4
0