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

Introducing swagger in the Admin API [Hackathon project] #211

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

asloobq
Copy link
Contributor

@asloobq asloobq commented Jan 25, 2024

To access ->
1] run the app and visit http://localhost:8089/swagger-ui/#/
2] Get your API Token. You can do this by calling GET /api/token/get and copying the key. Or just open admin UI, select any resource which will call the endpoint in the background and copy the token from the network tab
3] Click 'Authorize' (top right) and paste the value.

Benefits

  • No need to guess what operations require which fields
  • Know exactly which endpoints are available. No second guessing
  • Easier to expose API for usage than current UI by just defining the OpenAPI spec (which could be part of the design doc)

Pending stuff

  • Other resources like operator keys, keysets, etc.
  • Automatic API token retrieval
  • Role requirements for each endpoint
    Swagger-admin-screencap

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

Successfully merging this pull request may close these issues.

1 participant