Skip to content

improvement(api): declare OAuth scopes in OpenAPI, JSON 404s for unknown API paths, and root MCP resource metadata #9026

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

Merged
waleedlatif1 merged 2 commits into from
Oct 14, 2026
Merged

improvement(api): declare OAuth scopes in OpenAPI, JSON 404s for unknown API paths, and root MCP resource metadata #9026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
178e15c
improvement(api): declare OAuth scopes in OpenAPI, JSON 404s for unkn…
waleedlatif1 Oct 14, 2026
deeddaa
fix(api): shrink the unused-exports baseline and keep rewrite checks …
waleedlatif1 Oct 14, 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
2 changes: 1 addition & 1 deletion apps/docs/lib/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ function resolveAuthHeaders(
headers[scheme.name] = AUTH_SAMPLE_VALUE
continue
}
if (scheme.type === 'http' && scheme.scheme === 'bearer') {
if (scheme.type === 'oauth2' || (scheme.type === 'http' && scheme.scheme === 'bearer')) {
headers.Authorization = `Bearer ${AUTH_SAMPLE_VALUE}`
continue
}
Expand Down
34 changes: 30 additions & 4 deletions apps/docs/openapi-v2-billing.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,14 @@
"x-sim-operation": "billing.status.read",
"x-oauth-scope": "api:read",
"tags": ["Billing"],
"security": [
{
"apiKey": []
},
{
"oauthBearer": ["api:read"]
}
],
"parameters": [
{
"name": "workspaceId",
Expand Down Expand Up @@ -111,6 +119,14 @@
"x-sim-operation": "billing.logs.list",
"x-oauth-scope": "api:read",
"tags": ["Billing"],
"security": [
{
"apiKey": []
},
{
"oauthBearer": ["api:read"]
}
],
"parameters": [
{
"name": "source",
Expand Down Expand Up @@ -263,10 +279,20 @@
"description": "Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description."
},
"oauthBearer": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "OAuth 2.0 access token",
"description": "A Sim OAuth access token obtained by a registered client through the authorization-code flow. Each operation declares its required scope: api:read permits reads and searches; api:write also permits changes and execution and implies api:read. Scope requirements follow the application operation, independent of HTTP method or workspace role."
"type": "oauth2",
"description": "A Sim OAuth access token obtained by a registered client through the authorization-code flow with PKCE (S256), sent as `Authorization: Bearer`. Each operation declares the scope it requires: api:read permits reads and searches; api:write also permits changes and execution and implies api:read. Scope requirements follow the application operation, independent of HTTP method or workspace role.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://www.sim.ai/api/auth/oauth2/authorize",
"tokenUrl": "https://www.sim.ai/api/auth/oauth2/token",
"refreshUrl": "https://www.sim.ai/api/auth/oauth2/token",
"scopes": {
"api:read": "Read your workspaces, workflows, files, tables, and logs",
"api:write": "Read, create, change, run, and delete resources in your workspaces",
"offline_access": "Stay signed in without asking again"
}
}
}
}
},
"headers": {
Expand Down
Loading
Loading