Skip to content

Demo/api docs exploration #772

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

Open
brad-dow wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Demo/api docs exploration #772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
20baa3a
demo: API docs exploration branch
brad-dow Mar 31, 2026
d9979ba
chore: apply formatting to demo pages and spec improvements doc
brad-dow Mar 31, 2026
ef43ccd
Update links
brad-dow Mar 31, 2026
4129f92
chore: rebuild Redoc output with updated spec descriptions
brad-dow Mar 31, 2026
323c1a1
fix: point build:redoc script to local spec copies in public/specs
brad-dow Mar 31, 2026
a5ef99f
demo: point starlight plugin to local spec copies for comparison
brad-dow Mar 31, 2026
6f3eacf
chore: apply formatting to astro.config.mjs
brad-dow Mar 31, 2026
2629ee3
chore: trigger Netlify rebuild
brad-dow Apr 13, 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
5 changes: 5 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Claude Code

.claude/
CLAUDE.md

# Macs
.DS_Store

Expand Down
2 changes: 1 addition & 1 deletion .npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
auto-install-peers=true
engine-strict=true
engine-strict=false
66 changes: 55 additions & 11 deletions docs/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,36 +66,32 @@ export default defineConfig({
starlightOpenAPI([
{
base: 'apis/resource-server',
schema:
'../open-payments-specifications/openapi/resource-server.yaml',
schema: './public/specs/resource-server.yaml',
sidebar: { label: 'Open Payments' }
},
{
base: 'es/apis/resource-server',
schema:
'../open-payments-specifications/openapi/resource-server.yaml',
schema: './public/specs/resource-server.yaml',
sidebar: { label: 'Open Payments' }
},
{
base: 'apis/wallet-address-server',
schema:
'../open-payments-specifications/openapi/wallet-address-server.yaml',
schema: './public/specs/wallet-address-server.yaml',
sidebar: { label: 'Wallet Addresses' }
},
{
base: 'es/apis/wallet-address-server',
schema:
'../open-payments-specifications/openapi/wallet-address-server.yaml',
schema: './public/specs/wallet-address-server.yaml',
sidebar: { label: 'Wallet Addresses' }
},
{
base: 'apis/auth-server',
schema: '../open-payments-specifications/openapi/auth-server.yaml',
schema: './public/specs/auth-server.yaml',
sidebar: { label: 'Open Payments Authorization Server' }
},
{
base: 'es/apis/auth-server',
schema: '../open-payments-specifications/openapi/auth-server.yaml',
schema: './public/specs/auth-server.yaml',
sidebar: { label: 'Open Payments Authorization Server' }
}
]),
Expand All @@ -104,7 +100,9 @@ export default defineConfig({
errorOnFallbackPages: false,
exclude: [
'/apis/{auth-server,resource-server,wallet-address-server}/**/*',
'/es/apis/{auth-server,resource-server,wallet-address-server}/**/*'
'/es/apis/{auth-server,resource-server,wallet-address-server}/**/*',
'/apis/scalar/**',
'/apis/redoc/**'
]
}),
starlightFullViewMode()
Expand Down Expand Up @@ -398,6 +396,52 @@ export default defineConfig({
}
]
},
{
label: 'Demo: Spec improvements',
link: '/resources/spec-improvements'
},
{
label: 'Demo: Redoc',
collapsed: false,
items: [
{
label: 'Resource Server',
link: '/apis/redoc/resource-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
},
{
label: 'Auth Server',
link: '/apis/redoc/auth-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
},
{
label: 'Wallet Address Server',
link: '/apis/redoc/wallet-address-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
}
]
},
{
label: 'Demo: Scalar',
collapsed: false,
items: [
{
label: 'Resource Server',
link: '/apis/scalar/resource-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
},
{
label: 'Auth Server',
link: '/apis/scalar/auth-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
},
{
label: 'Wallet Address Server',
link: '/apis/scalar/wallet-address-server',
attrs: { target: '_blank', rel: 'noopener noreferrer' }
}
]
},
{
label: 'API specifications',
collapsed: true,
Expand Down
4 changes: 4 additions & 0 deletions docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,15 @@
"build": "astro build",
"preview": "astro preview",
"astro": "astro",
"build:redoc": "redocly build-docs public/specs/resource-server.yaml --output public/apis/redoc/resource-server/index.html && redocly build-docs public/specs/auth-server.yaml --output public/apis/redoc/auth-server/index.html && redocly build-docs public/specs/wallet-address-server.yaml --output public/apis/redoc/wallet-address-server/index.html",
"format": "prettier --write '**/*.{js,mjs,ts,tsx,json,md,mdx,astro}' && eslint --max-warnings=0 --fix .",
"lint": "prettier --check '**/*.{js,mjs,ts,tsx,json,md,mdx,astro}' && eslint --max-warnings=0 . "
},
"dependencies": {
"@astrojs/starlight": "^0.37.4",
"@interledger/docs-design-system": "^0.11.0",
"@scalar/astro": "^0.2.4",
"@scalar/core": "^0.4.4",
"astro": "5.17.1",
"katex": "^0.16.28",
"mermaid": "^11.12.2",
Expand All @@ -28,6 +31,7 @@
"devDependencies": {
"@eslint/js": "^9.39.2",
"@prettier/plugin-php": "^0.24.0",
"@redocly/cli": "^2.24.1",
"@typescript-eslint/parser": "^8.54.0",
"astro-eslint-parser": "^1.2.2",
"eslint": "^9.39.2",
Expand Down
Loading
Loading