Bug 45021 – [RESTful Import API] Python-API & HTTP-API documentation

Bug 45021 - [RESTful Import API] Python-API & HTTP-API documentation


Summary:	[RESTful Import API] Python-API & HTTP-API documentation

Status:	RESOLVED FIXED

Product:	UCS@school
Classification:	Unclassified
Component:	HTTP-API (Kelvin)
Version:	UCS@school 4.2
Hardware:	Other Linux

Importance:	P5 normal (vote)
Target Milestone:	---
Assigned To:	Daniel Tröder
QA Contact:

URL:
Keywords:

Duplicates:	47093 (view as bug list)
Depends on:	45026 47758
Blocks:	45019 45024 47118
	Show dependency tree / graph

Reported:	2017-07-17 14:35 CEST by Daniel Tröder
Modified:	2020-07-14 11:03 CEST (History)
CC List:	2 users (show)

See Also:
What kind of report is it?:	Feature Request
What type of bug is this?:	---
Who will be affected by this bug?:	---
How will those affected feel about the bug?:	---
User Pain:
Enterprise Customer affected?:
School Customer affected?:	Yes
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Max CVSS v3 score:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Daniel Tröder

2017-07-17 14:35:57 CEST

Create a [swagger-like] API documentation.

Comment 1 Daniel Tröder

2017-07-17 15:11:40 CEST

The API should allow the upload of unaltered CSV files in the format currently in use by the customer.

Comment 2 Daniel Tröder

2017-07-26 12:40:32 CEST

Auto-generation of a Swagger schema won't be possible, because the django-rest-framework version in Debian is no much out of date :/

A Swagger schema would have allowed client programmers to auto-generate their API client for ActionScript, Apex, Bash, C# (.net 2.0, 4.0 or later), C++ (cpprest, Qt5, Tizen), Clojure, Dart, Elixir, Eiffel, Go, Groovy, Haskell, Java (Jersey1.x, Jersey2.x, OkHttp, Retrofit1.x, Retrofit2.x, Feign, RestTemplate, RESTEasy), Kotlin, Node.js (ES5, ES6, AngularJS with Google Closure Compiler annotations) Objective-C, Perl, PHP, PowerShell, Python, Ruby, Scala, Swift (2.x, 3.x, 4.x), Typescript (Angular1.x, Angular2.x, Fetch, jQuery, Node)!

Comment 3 Daniel Tröder

2018-04-17 09:52:47 CEST

Also document the Python client API.

Comment 4 Daniel Tröder

2018-09-05 19:48:29 CEST

*** Bug 47093 has been marked as a duplicate of this bug. ***

Comment 5 Michel Smidt 2020-07-14 11:03:55 CEST

Done.
Manual: http://docs.software-univention.de/ucsschool-umc-import-handbuch-4.4.html