- split the massive bookmarks/routes.yaml into several files
- moved big markdown contents to individual files
- moved the OAuth documentation to the API description
- fixed a few minor bugs with schemas
- added a "data" definition to file-based import routes
- Moved method to "routes.yaml" files; it simplifies the api.yaml contents
- Presentation options
- Some API documentation fixes here and there
- Switch to "view" render-style when screen width is less than 814px
resolves#653
A label can be anything and this means you can't always use it as a
path parameter. A label "#/../test" is perfectly valid but, even with
path escaping, it fails in a browser.
We now use the same route ("/labels") for label operations and split
the middlewares and handlers based on the presence of a "name" parameter
in the request URL.
resolves#277 once and for all
- Changed from padding to margin in .layout-content block in order
to keep a consistent width when it receives max-w-std
- Added breadcrumbs on all documentation views
- API documentation layout consistency
- Fixed API documentation for POST /auth and GET /profile
Trying the API works without providing a token; it uses the session
cookie. But it fails on POST/PUT/PATCH requests. This adds a script
that injects the CSRF token for these requests.
Font styling is now in the doc.sass file.
This is the first commit with very few routes documentation.
The documentation source is divided in several files that are merged
together using file-compose, which provides a mechanism to merge parts
of yaml files together.
The documentation is served by RapiDoc. It's a true web component and
it provides some features for future improvements, should we need them.
Thank to a good styling system, and the use of variables, it was a few
lines of code to customize RapiDoc to Readeck's colors :)
Olivier Meunier
Mislav Marohnić