The documentation should contain: * resources * methods * authentication * expected attributes and formats * missing parts (e.g. pagination) * examples (curl / JSON) The documentation should be written using Sphinx and published on docs.univenion.de.
Installation and configuration Installation This can done either through -> This can be done either through
Finished the documentation. Content tree: ------------- Overview Components Installation and configuration Installation Configuration Token validity Log level Configuration of user object management (import configuration) Python hooks for user object management (import-user) Authentication and authorization Authentication Authorization OpenAPI / Swagger / ReDoc Interactive API browser Generating client code from OpenAPI schema Resources Resource Roles Resource representation List / Search Retrieve Resource Schools Resource representation List / Search Retrieve Resource Users Resource representation school[s] school_classes udm_properties List / Search Retrieve Create Modify / Move PUT example PATCH example Move Delete Known Issues Rebuilding the UDM REST API Client No pagination [feature/kelvin] 5b4c39d54 Bug #50721: documentation stub [feature/kelvin] 17d18ff2a Bug #50721: include theme, add build instructions [feature/kelvin] 9f8d92cd4 Bug #50721: document Kelvin API [feature/kelvin] a874ecece Bug #50721: API documentation
Commited copy of HTML build to "docs.univention.de" git repo: [master 55b6065] Bug #50721: complete ucsschool-kelvin-rest-api docu
User Resource: 1 school_classes must exist (als URLs) in schools -> ... (as URLs) ... 2 In the user resource urls are represented as "https://<fqdn>/ucsschool/kelvin/v1/schools/DEMOSCHOOL" In the other resource examples the (I presume original) URLs like "https://m66.uni.dtr/ucsschool/kelvin/v1/schools/DEMOSCHOOL" show. I personally prefer the version with <fqdn> but at the very least it should be consistent. OpenAPI/Swagger/ReDoc: 3 To use it, a token must first be retrieved by by clicking -> ... retrieved by clicking Installation and Configuration: 4 The differences are explained in chapter TODO. -> Remove the TODO
commit 481c7457 Bug #50721: Fix minor issues with the documentation. I fixed the mentioned issues with this commit.
Thanks, I reviewed the change. I moved the section about file locations and import hooks from the readme to the installation page: [feature/kelvin f7fdae9e1] Bug #50721: move section about file locations and import hooks from readme to installation page .. and pushed it into the docs repo: [master fd3e748] Bug #50721: add section about file locations and import hooks
Changes look good. I VERIFY as soon as the doc is published.
Published -> VERIFIED
A Kelvin API app with the changes in this bug has been published.