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

Toplevel README doc section for "Getting Started" should mention api endpoint URIs #1642

Open
truedat101 opened this issue Feb 14, 2024 · 0 comments

Comments

@truedat101
Copy link

In https://github.com/eclipse/hawkbit?tab=readme-ov-file#getting-started (README.md)

it would be helpful to mention the URIs for accessing:

  • openapi JSON endpoint: /v3/api-docs
  • openapi YAML endpoint: /v3/api-docs.yaml
  • swagger_ui endpoint: /swagger-ui/index.html

Some digging around and it looks like in the Docker maps to the above URIs. I realize the API docs are linked in the main docs to the eclipse org site, but this possibly isn't available on easily when developing offline, so it's nice to know how to quickly get to this.

If I've missed this somewhere else in the docs this can be closed.

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