Skip to content
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.

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

Allow to interact with the API from the reference docs #1

Open
odrotbohm opened this issue Jan 19, 2023 · 0 comments
Open

Allow to interact with the API from the reference docs #1

odrotbohm opened this issue Jan 19, 2023 · 0 comments

Comments

@odrotbohm
Copy link

As the API uses HAL as media type, it would be nice to have the HAL explorer (available as WebJAR) deployed with it and linked to from the reference documentation. Alternatively, CORS configuration could be defined so that the API can be interacted with from a publicly deployed HAL Explorer instance.

This would of course only allow browsing the reading endpoints, for starters. Also, HAL curies could be used to link to and transclude sections of the reference documentation in the browser itself, if link relations can be translated into pointers into the docs.

The server could also expose HAL FORMS templates for the state transitions that add and delete releases so that HAL Browser would present a UI for those and render the resulting JSON payload as preview.

@odrotbohm odrotbohm changed the title Allow to interact with the API from the refernce docs Allow to interact with the API from the reference docs Jan 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant