Skip to content

Update online documentation, remove outdated docs

Johannes Zumthurm requested to merge doc_online into master

Created by: NotSpecial

  • Remove outdated developer and admin documentation.
  • Move documents such as the cheatsheet or the OAuth user guide into the online docs, which are now the 'single source of truth' for users.
  • Extend the cheatsheet to cover sending data with multipart/form-data
  • Add general introductions to REST and API auth.
  • In the online docs, add support for:
    • Query parameters.
    • Authorization header.
    • Additional lookup path for GET.
    • Error Responses.
  • Do not show hook docstrings anymore, as they are only relevant for API developers and not for users.
  • Update 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.

Merge request reports