Update online documentation, remove outdated docs (#323)
- Removed outdated developer and admin documentation. - Moved documents such as the Cheatsheet or the OAuth user guide into the online docs, which are now the 'single source of truth' for users. - Extended the Cheatsheet to cover sending data with multipart/form-data - Added general introductions to REST and API auth. - In the online docs, added support for: - Query parameters. - Authorization header. - Additional lookup path for GET. - Error Responses. - Hooks are not displayed anymore, as they are only relevant for API developers and not for users. - Updates ReDoc to version 2. Regarding the documentation updates, I briefly considered putting them into a pull request to Eve-Swagger. However, development on Eve-Swagger seems stale, with two open pull requests without response. Furthermore, most additions include AMIV API specific detail (e.g. a link to the cheatsheet), so I opted for a API specific solution instead.
Showing
- README.md 31 additions, 16 deletionsREADME.md
- amivapi/documentation.py 0 additions, 95 deletionsamivapi/documentation.py
- amivapi/documentation/Auth.md 83 additions, 0 deletionsamivapi/documentation/Auth.md
- amivapi/documentation/Cheatsheet.md 145 additions, 0 deletionsamivapi/documentation/Cheatsheet.md
- amivapi/documentation/Introduction.md 46 additions, 0 deletionsamivapi/documentation/Introduction.md
- amivapi/documentation/OAuth.md 59 additions, 0 deletionsamivapi/documentation/OAuth.md
- amivapi/documentation/__init__.py 62 additions, 0 deletionsamivapi/documentation/__init__.py
- amivapi/documentation/update_documentation.py 301 additions, 0 deletionsamivapi/documentation/update_documentation.py
- docs/Admin_Guide.md 0 additions, 29 deletionsdocs/Admin_Guide.md
- docs/Cheatsheet.md 0 additions, 57 deletionsdocs/Cheatsheet.md
- docs/Developer_Guide.md 0 additions, 378 deletionsdocs/Developer_Guide.md
- docs/OAuth.md 0 additions, 32 deletionsdocs/OAuth.md
- docs/User_Guide.md 0 additions, 552 deletionsdocs/User_Guide.md
Loading
Please register or sign in to comment