New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve API URL documentation #245

Open

Pfeil opened this issue Dec 4, 2024 · 0 comments

Labels

Member

Pfeil commented Dec 4, 2024

Describe the bug

The openApi/swagger documentation displays some URLs in a misinterpretable way and does not provide a proper testing interface.

To Reproduce

Steps to reproduce the behavior:

Go to https://kit-data-manager.github.io/webpage/typed-pid-maker/openapi.html
Check the following urls and their swagger interaction possibilities

for resolving pids (GET /api/v1/pit/pid/**)
for retriving known PIDs (GET /api/v1/pit/known-pid/**)
for updating PIDs (GET /api/v1/pit/pid/**)

Expected behavior

when trying out the call in the swagger interface, there should be an input element for assigning a value to the ** placeholder
it would be nicer to have a variable name instead of **

Additional context

It is an issue that PIDs may contain slashes
One approach would be for the API to assume a "prefix/suffix" scheme, but it may limit the API to the common Handle-PID scheme.
We could instead investigate if we can catch all fragments in a list in another way and join them, and how this is being displayed in the swagger interface.

Pfeil added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment