Univention Bugzilla – Bug 45020
[RESTful Import API] technical concept documentation
Last modified: 2018-07-04 18:12:27 CEST
Create a document that explains the interaction between the components that are involved an import job.
Created attachment 9107 [details] remote-import-concept.png
Created attachment 9108 [details] remote-import-concept.graphml
Documentation about components, interactions, setup etc has been created as reStructuredText, compiled by Sphinx. It will be automatically build to a package ucs-school-import-http-api-doc. [4.3] 7f3696d8 Bug #45021: HTTP-API documentation TODO: file locations, HTTP-API and Python-API method and attribute doc. Currently the source code documentation cannot be built properly without an already installed ucs-school-import. But that's not a primary focus for now. A current build (incl. source code documentation from a VM) to browse the result can be found at: https://billy.knut.univention.de/~dtroeder/http-api-doc/
TODO: clearify publishing with docu team
* Split of "TODO: HTTP-API and Python-API method and attribute doc" to Bug #47093. * Docu-Team has been contacted to create a place for publishing. * TODO: file locations
(In reply to Daniel Tröder from comment #5) > * TODO: file locations [4.3] 22bfc995 Bug #45020: change to RTD Sphinx theme [4.3] 4496b619 Bug #45020: convert tabs to spaces [4.3] bf74fee1 Bug #45020: add page on file locations [4.3] 242d34c2 Bug #47156: switch to "important" box, as sphinx-rtd-theme has a bug in it before v0.4.0 [4.3] 58c4ecff Bug #47156: add section about CSV file format and warning about class names and school [4.3] d1c7d8dd Bug #45020: changelog ucs-school-import (16.0.2-6)
See https://billy.knut.univention.de/~dtroeder/http-api-doc/
Internal documentation → as discussed, no QA required
UCS@school 4.3 v4 has been released. https://docs.software-univention.de/changelog-ucsschool-4.3v4-de.html If this error occurs again, please clone this bug.