Improve OpenAPI (REST) documentation for the website with a docusaurus plugin - #2001
Improve OpenAPI (REST) documentation for the website with a docusaurus plugin#2001Sziszka90 wants to merge 5 commits into
Conversation
- Add Redoc links to sidebars.json and versioned sidebars - Replace pathname schema links in spec.md and website/versioned_docs/*/app-directory/spec.md - Remove obsolete generated website/static/schemas/*/app-directory.html - Update CHANGELOG.md (Unreleased → Added)
✅ Deploy Preview for fdc3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
kriswest
left a comment
There was a problem hiding this comment.
Thank you for taking this one on.
I'm having trouble with version selection. Its rendering the next version for me instead of 2.2 when thats selected in teh version.menu top right:
then when the next version is selected it switches to 2.2 when you navigate to it. Hence, this needds a nother look (+conflicts resolving)
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2001 +/- ##
=======================================
Coverage 95.48% 95.48%
=======================================
Files 85 85
Lines 6705 6705
Branches 873 939 +66
=======================================
Hits 6402 6402
Misses 303 303 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
@kriswest Should work now. Can you please retry? |

Describe your change
Integrated Redocusaurus to render the App Directory OpenAPI documentation:
Issue: #1001
redocusauruspreset towebsite/docusaurus.config.jsandwebsite/package.jsonto render OpenAPI specs with Redoc.website/sidebars.jsonand the versioned sidebars (website/versioned_sidebars/version-2.0-sidebars.json,version-2.1-sidebars.json,version-2.2-sidebars.json) so the App Directory API reference is reachable from site navigation.website/docs/app-directory/spec.mdandwebsite/versioned_docs/version-*/app-directory/spec.mdto point at the new Redoc routes.app-directory.htmlfiles underwebsite/static/schemas/2.0,2.1,2.2, andnext, which are superseded by the Redoc-rendered docs.CHANGELOG.mdunderUnreleased > Added.Contributor License Agreement
Review Checklist
DesktopAgent,Channel,PrivateChannel,Listener,Bridging)?npm run build) run and the results checked in?BaseContextschema applied viaallOf(as it is in existing types)?titleanddescriptionprovided for all properties defined in the schema?npm run build) run and the results checked in?