Bug 53242 – Add example data to Kelvins OpenAPI page

Bug 53242 - Add example data to Kelvins OpenAPI page


Summary:	Add example data to Kelvins OpenAPI page

Status:	NEW

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

Importance:	P5 normal (vote)
Target Milestone:	---
Assigned To:	UCS@school maintainers
QA Contact:

URL:
Keywords:

Depends on:
Blocks:
	Show dependency tree / graph

Reported:	2021-05-10 19:10 CEST by Daniel Tröder
Modified:	2021-05-10 19:10 CEST (History)
CC List:	0 users

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?:
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

2021-05-10 19:10:53 CEST

Since version 0.64.0 FastAPI supports adding (multiple) example(s) to each resource and method: https://fastapi.tiangolo.com/tutorial/schema-extra-example/#body-with-multiple-examples

This helps customers to understand what the payload of their requests should be.

Add one or more examples to each resource and method that supports patch/put/post. Maybe keep data similar to the examples in the documentation (for example https://docs.software-univention.de/ucsschool-kelvin-rest-api/resource-users.html#create).