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

Improve OpenAPI (REST) documentation for the website with a docusaurus plugin #1001

Open
rikoe opened this issue May 24, 2023 · 1 comment
Open

Comments

@rikoe
Copy link
Contributor

rikoe commented May 24, 2023

The App Directory documentation uses a generated ReDoc static html file for the API docs, based on appd.yaml, but docusaurus now have several nice plugins for integrating OpenAPI documentation which we should incorporate.

One of them is https://github.com/cloud-annotations/docusaurus-openapi (example: https://docusaurus-openapi.netlify.app/).

The other is https://github.com/rohit-gohri/redocusaurus (example: https://redocusaurus.vercel.app/).

@kriswest
Copy link
Contributor

kriswest commented May 24, 2023

Currently, the docs are rendered by a static html file that dynamically renders the current spec file: https://github.com/finos/FDC3/blob/master/website/static/schemas/next/app-directory.html
(my inner pedant is an extrovert)

That said, the docusaurus plugins clearly do a better job of the integration with the site - particularly if they can get it into the versioned sidebar nav (where currently the full spec is a static file that opens in a new window).

Is this something you're up for/have time to work on? or do we add it to the queue?

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

No branches or pull requests

3 participants