Document Seam workspace scope

seamapi · Jan 14, 2025 · a52ca08 · a52ca08
1 parent a3d2a7d
commit a52ca08
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/layouts/api-endpoint.hbs b/src/layouts/api-endpoint.hbs
@@ -34,6 +34,9 @@
 
 {{#each authMethods}}
 - {{this}}
+{{#if (eq this 'Personal access token')}}
+  - {{#if (eq ../workspaceScope 'required')}}Must also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'optional')}}Can also include the `seam-workspace` header in the request{{/if}}{{#if (eq ../workspaceScope 'none')}}Must omit the `seam-workspace` header from the request{{/if}}
+{{/if}}
 {{/each}}
 
 {{/if}}

diff --git a/src/lib/layout/api-endpoint.ts b/src/lib/layout/api-endpoint.ts
@@ -2,6 +2,7 @@ import type {
   CodeSampleSdk,
   Endpoint,
   SeamAuthMethod,
+  SeamWorkspaceScope,
 } from '@seamapi/blueprint'
 
 const supportedSdks: CodeSampleSdk[] = [
@@ -18,6 +19,7 @@ export interface ApiEndpointLayoutContext {
   title: string
   path: string
   authMethods: AuthMethodDisplayName[]
+  workspaceScope: SeamWorkspaceScope
   request: {
     preferredMethod: string
     parameters: Array<{
@@ -73,6 +75,7 @@ export function setEndpointLayoutContext(
   file.description = endpoint.description
   file.title = endpoint.title
   file.path = endpoint.path
+  file.workspaceScope = endpoint.workspaceScope
 
   file.authMethods = endpoint.authMethods
     .filter(