Bug 55556 - useless portal entry for installed Kelvin-API
Summary: useless portal entry for installed Kelvin-API
Status: CLOSED FIXED
Alias: None
Product: UCS@school
Classification: Unclassified
Component: HTTP-API (Kelvin)
Version: UCS@school 5.0
Hardware: Other Linux
: P5 normal
Target Milestone: ---
Assignee: Jürn Brodersen
QA Contact: Tobias Wenzel
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-01-10 17:45 CET by Dirk Ahrnke
Modified: 2024-03-05 16:00 CET (History)
3 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?: 2: Will only affect a few installed domains
How will those affected feel about the bug?: 2: A Pain – users won’t like this once they notice it
User Pain: 0.023
Enterprise Customer affected?:
School Customer affected?:
ISV affected?:
Waiting Support:
Flags outvoted (downgraded) after PO Review:
Ticket number:
Bug group (optional):
Customer ID:
Max CVSS v3 score:


Attachments
new-behavior (124.64 KB, image/gif)
2024-02-21 09:15 CET, Tobias Wenzel
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Dirk Ahrnke univentionstaff 2023-01-10 17:45:34 CET
The installation of the Kelvin-API also creates a portal entry to "/ucsschool/kelvin". 
This is quite pointless because there is nothing to be shown at this URL. This might confuse and doesn't really look professional.

what could be shown else?
- point to the documentation of the API
- point to the (Swagger)-UI
- point to another (local) landingpage

Note: I am creating this not as a feature request because I expect that some users (or people who notice this behaviour) might think that the API is not working at all.
Comment 1 Jürn Brodersen univentionstaff 2023-10-04 20:34:27 CEST
Note to self in case we change this:

Change the WebInterface key in the app ini. This should work:

```
WebInterface = /ucsschool/kelvin/v1/docs
```
Comment 3 Jürn Brodersen univentionstaff 2023-12-11 12:45:26 CET
(In reply to Jürn Brodersen from comment #1)
> Note to self in case we change this:
> 
> Change the WebInterface key in the app ini. This should work:
> 
> ```
> WebInterface = /ucsschool/kelvin/v1/docs
> ```

This DOES NOT work! WebInterface also changes the apache config and not just the link. Which breaks the swagger interface (the openapi.json can not be loaded)

See:

/etc/apache2/sites-available/000-default.conf

Alternative:

ucr set ucs/web/overview/entries/service/ucsschool-id-connector/link='/ucsschool-id-connector/api/v1/docs'

in the configure_host script
Comment 4 Jürn Brodersen univentionstaff 2023-12-11 12:47:36 CET
For kelvin:

ucr set ucs/web/overview/entries/service/ucsschool-kelvin-rest-api/link='/ucsschool/kelvin/v1/docs'
Comment 5 Jürn Brodersen univentionstaff 2024-02-15 12:52:10 CET
Issue has been resolved by explicitly redirecting the base url to the docs page in the kelvin api.

https://git.knut.univention.de/univention/components/ucsschool-kelvin-rest-api/-/issues/136
Comment 6 Tobias Wenzel univentionstaff 2024-02-21 09:15:31 CET
Created attachment 11195 [details]
new-behavior
Comment 8 Johannes Königer univentionstaff 2024-03-05 16:00:52 CET
Kelvin 1.10.0 was released today, if this bug occurs again please clone this bug.