Skip to content

docs: replace openapi-docs plugin with Scalar #411

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.

Sign up for GitHub

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

Draft
adilansari wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

docs: replace openapi-docs plugin with Scalar #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
08c5eec
docs: replace docusaurus-plugin-openapi-docs with @scalar/docusaurus
adilansari Apr 7, 2026
838b674
fix: add CSS overrides for Scalar API reference layout
adilansari Apr 7, 2026
8d9145f
fix: use Scalar config options instead of CSS hacks for layout
adilansari Apr 8, 2026
ff3b03e
custom css work
adilansari Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/partner-integrations/access-control.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ You pass it on provisioning, access key, and org management endpoints.
| `Member` | Standard access. Can only manage their own access keys and resources. |

The behavioral difference shows up immediately. When you call
[List Access Keys](/docs/partner-integrations/api/tigris-list-access-keys) with
`user_role: "Admin"`, the response includes **all** access keys in the org. With
`user_role: "Member"` (or omitted), you get back **only keys owned by that
user**.
[List Access Keys](/docs/partner-integrations/api/) with `user_role: "Admin"`,
the response includes **all** access keys in the org. With `user_role: "Member"`
(or omitted), you get back **only keys owned by that user**.

This same scoping applies to other management operations. Admin-only operations
include:
Expand Down
29 changes: 12 additions & 17 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,7 @@ const config = {
breadcrumbs: false,
showLastUpdateAuthor: true,
showLastUpdateTime: true,
docRootComponent: "@theme/DocRoot", // added for OpenAPI plugin
docItemComponent: "@theme/ApiItem", // added for OpenAPI plugin
docRootComponent: "@theme/DocRoot",
},
blog: false,
theme: {
Expand All @@ -107,21 +106,17 @@ const config = {
},
],
[
"docusaurus-plugin-openapi-docs",
"@scalar/docusaurus",
{
id: "openapi", // plugin id
docsPluginId: "classic", // configured for preset-classic
config: {
extensions: {
specPath: "static/api/extensions/v1/api.yaml",
outputDir: "docs/partner-integrations/api",
sidebarOptions: {
groupPathsBy: "tag",
categoryLinkSource: "tag",
},
downloadUrl: "/docs/api/extensions/v1/api.yaml",
showSchemas: true,
},
label: "API Reference",
route: "/partner-integrations/api",
showNavLink: false,
configuration: {
url: "/docs/api/extensions/v1/api.yaml",
theme: "none",
darkMode: true,
hideDarkModeToggle: true,
withDefaultFonts: false,
},
},
],
Expand Down Expand Up @@ -405,7 +400,7 @@ const config = {
onBrokenMarkdownLinks: "throw",
},
},
themes: ["@docusaurus/theme-mermaid", "docusaurus-theme-openapi-docs"],
themes: ["@docusaurus/theme-mermaid"],
};

module.exports = config;
Loading
Loading