Bug 54739 - Aged descriptions in Kelvin Swagger UI
Summary: Aged descriptions in Kelvin Swagger UI
Status: CLOSED FIXED
Alias: None
Product: UCS@school
Classification: Unclassified
Component: kelvin-rest-api-client
Version: unspecified
Hardware: Other Linux
: P5 normal
Target Milestone: ---
Assignee: Alexander Steffen
QA Contact: Tobias Wenzel
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-05-11 07:58 CEST by Alexander Steffen
Modified: 2022-07-04 10:11 CEST (History)
4 users (show)

See Also:
What kind of report is it?: Bug Report
What type of bug is this?: 1: Cosmetic issue or missing function but workaround exists
Who will be affected by this bug?: 5: Will affect all installed domains
How will those affected feel about the bug?: 5: Blocking further progress on the daily work
User Pain: 0.143
Enterprise Customer affected?: Yes
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional): Typo/text changes
Customer ID: 00424
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 Alexander Steffen univentionstaff 2022-05-11 07:58:07 CEST 
The Kelvin Swagger UI wrongly specifies the  type of input that is needed for certain requests.

For example:

The route "/ucsschool/kelvin/v1/classes (create)" specifies the required input "school", as the name of the school where a class will be created, but the field requires the URL of the school, which leads to a HTTP 500 response which only states an internal server error. 

{"name":"X","school":"Y"} --> 500
{"name":"X","school":"http://<fqdn>/ucsschool/kelvin/v1/schools/Y"} --> 201

This is just one example and it inherits from inconsistent documentation i.e. descriptions, as well as different input patterns within the Swagger UI.

Even if a user would not use this as a daily driver the generated Curl requests will also be wrong.
Comment 2 Alexander Steffen univentionstaff 2022-06-07 08:17:07 CEST 
Successfully merged with:

https://git.knut.univention.de/univention/components/ucsschool-kelvin-rest-api/-/merge_requests/5
Comment 3 Tobias Wenzel univentionstaff 2022-06-07 09:28:05 CEST 
QA

All Ok, verify

- merge OK
- pipeline green

will be released with next release
Comment 4 Tobias Wenzel univentionstaff 2022-06-24 08:37:17 CEST 
Released with 1.5.5 -> closing this issue.