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

Add more detailed API documentation to the README #79

Closed
4 tasks
simonw opened this issue Nov 13, 2017 · 3 comments
Closed
4 tasks

Add more detailed API documentation to the README #79

simonw opened this issue Nov 13, 2017 · 3 comments
Labels
medium

Comments

@simonw
Copy link
Owner

simonw commented Nov 13, 2017

Need to document:

  • The ?column__gt=4 style filter arguments for tables
  • The ?sql= API, and how named parameters work
  • How API pagination works
  • How redirects and cache headers work
@simonw simonw added this to the Ship v1 milestone Nov 13, 2017
@simonw simonw added the medium label Nov 13, 2017
@simonw simonw modified the milestones: Ship v1, v1 stretch goals Nov 13, 2017
@simonw
Copy link
Owner Author

simonw commented Nov 14, 2017

This is probably a bit too much for the README - I should get readthedocs working.

@simonw simonw modified the milestones: v1 stretch goals, v2: visualization edition Nov 14, 2017
@simonw simonw modified the milestones: v2: visualization edition, Advanced JSON edition Dec 10, 2017
@simonw
Copy link
Owner Author

simonw commented Apr 26, 2018

Docs now live at http://datasette.readthedocs.io/

I still need to document a few more parts of the API before closing this.

@simonw
Copy link
Owner Author

simonw commented May 28, 2018

Closing this as obsolete in favor of other issues tagged documentation.

@simonw simonw closed this as completed May 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
medium
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw