Skip to content

Conversation

@katexochen
Copy link
Member

The Swagger Doc should replace the Coordinator API page of the documentation, the annotations in this PR are up to date with deaa486.

I could not fix the following problems/downsides:

  • The docs search does not index the content of the Swagger UI iframe.
  • Deep linking of the Swagger UI does not work (also caused by placement in iframe)
  • Links that point from the Swagger UI to other internal pages of our documentation are opened in new tab. This is wanted behavior of Swagger UI.

Swagger documentation will be generated and published through GitHub Action, see edgelesssys/marblerun#230 .

@netlify
Copy link

netlify bot commented Aug 12, 2021

✔️ Deploy Preview for edgeless-docs ready!

🔨 Explore the source changes: f975cfc

🔍 Inspect the deploy log: https://app.netlify.com/sites/edgeless-docs/deploys/611bc2021fb4020007cbe37e

😎 Browse the preview: https://deploy-preview-17--edgeless-docs.netlify.app

@katexochen katexochen requested a review from thomasten August 16, 2021 14:12
@thomasten thomasten requested a review from m1ghtym0 August 16, 2021 16:55
@m1ghtym0
Copy link
Member

recover and secrets don't seem to have Parameters for their POST requests, is there something missing?

Copy link
Member

@m1ghtym0 m1ghtym0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM now:-)

@m1ghtym0 m1ghtym0 self-requested a review August 18, 2021 07:14
@katexochen katexochen merged commit cc3e5d8 into main Aug 20, 2021
@katexochen katexochen deleted the feat/swagger branch August 20, 2021 08:47
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.

3 participants