Add token scopes to all API endpoints

specs/signalwire-rest/calling-api/calls/main.tsp

@@ -19,6 +19,12 @@ namespace CallingAPI.Calls {
     Unified JSON-RPC style endpoint for executing call methods through command-based dispatch.
     Send a request with the appropriate `command` field to invoke the desired call operation.
     This endpoint provides a single interface for all call-related methods including creation, updates, termination, and AI conversation control.
+
+    #### Permissions
+
+    The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_.
+
+    [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
     """)
     @opExample(
       #{ parameters: dialCallExample },

specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml

@@ -29,6 +29,12 @@ paths:
         Unified JSON-RPC style endpoint for executing call methods through command-based dispatch.
         Send a request with the appropriate `command` field to invoke the desired call operation.
         This endpoint provides a single interface for all call-related methods including creation, updates, termination, and AI conversation control.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _Voice_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters: []
       responses:
         '200':

specs/signalwire-rest/chat-api/_spec_.yaml

@@ -32,7 +32,7 @@ paths:
 
         #### Permissions
 
-        The API token must include the following scopes: _Chat_.
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_.
       tags:
         - Tokens
       requestBody:

specs/signalwire-rest/chat-api/tokens/main.tsp

@@ -19,7 +19,9 @@ namespace ChatAPI.Tokens {
 
       #### Permissions
 
-      The API token must include the following scopes: `Chat`.
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       """)
     create(...NewChatToken):
       | {

specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml

@@ -16,7 +16,9 @@ paths:
 
         #### Permissions
 
-        The API token must include the following scopes: `Chat`.
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _Chat_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters: []
       responses:
         '201':

specs/signalwire-rest/datasphere-api/document/main.tsp

@@ -12,11 +12,27 @@ namespace DatasphereAPI.Documents {
   @route("/documents")
   @tag("Documents")
   interface Documents {
-    @doc("A list of Datasphere Documents")
+    @doc("""
+      A list of Datasphere Documents.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("List Documents")
     list(): DocumentListResponse | StatusCode401 | StatusCode404;
 
-    @doc("Creates a Datasphere Document")
+    @doc("""
+      Creates a Datasphere Document.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("Create a Document")
     @post
     create(@body body: DocumentCreateRequest):
@@ -28,7 +44,15 @@ namespace DatasphereAPI.Documents {
       | StatusCode404
       | CreateStatusCode422;
 
-    @doc("Updates a Datasphere Document by ID")
+    @doc("""
+      Updates a Datasphere Document by ID.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("Update a Document")
     @patch(#{ implicitOptionality: true })
     update(...PathID, ...DocumentUpdateRequest):
@@ -40,14 +64,30 @@ namespace DatasphereAPI.Documents {
       | StatusCode404
       | SearchStatusCode422;
 
-    @doc("Deletes a Datasphere Document by ID")
+    @doc("""
+      Deletes a Datasphere Document by ID.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("Delete a Document")
     @delete
     delete(...PathID): {
       @statusCode statusCode: 204;
     } | StatusCode401 | StatusCode404;
 
-    @doc("Search Datasphere Documents")
+    @doc("""
+      Search Datasphere Documents.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @route("/search")
     @summary("Search Documents")
     @post
@@ -64,16 +104,40 @@ namespace DatasphereAPI.Chunks {
   @tag("Chunks")
   @friendlyName("Chunks")
   interface Chunks {
-    @doc("A list of chunks for a Datasphere Document.")
+    @doc("""
+      A list of chunks for a Datasphere Document.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("List Chunks")
     list(...DocumentPathID): ChunkListResponse | StatusCode401 | StatusCode404;
 
-    @doc("Retrieves a specific chunk for a Datasphere Document by ID.")
+    @doc("""
+      Retrieves a specific chunk for a Datasphere Document by ID.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("Retrieve Chunk")
     @route("/{chunkId}")
     get(...ChunkPathID): ChunkResponse | StatusCode401 | StatusCode404;
 
-    @doc("Deletes a specific chunk for a Datasphere Document by ID.")
+    @doc("""
+      Deletes a specific chunk for a Datasphere Document by ID.
+
+      #### Permissions
+
+      The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     @summary("Delete Chunk")
     @route("/{chunkId}")
     @delete

specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml

@@ -11,7 +11,14 @@ paths:
     get:
       operationId: Documents_list
       summary: List Documents
-      description: A list of Datasphere Documents
+      description: |-
+        A list of Datasphere Documents.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters: []
       responses:
         '200':
@@ -37,7 +44,14 @@ paths:
     post:
       operationId: Documents_create
       summary: Create a Document
-      description: Creates a Datasphere Document
+      description: |-
+        Creates a Datasphere Document.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters: []
       responses:
         '201':
@@ -76,7 +90,14 @@ paths:
     post:
       operationId: Documents_search
       summary: Search Documents
-      description: Search Datasphere Documents
+      description: |-
+        Search Datasphere Documents.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters: []
       responses:
         '200':
@@ -117,7 +138,14 @@ paths:
     get:
       operationId: Chunks_list
       summary: List Chunks
-      description: A list of chunks for a Datasphere Document.
+      description: |-
+        A list of chunks for a Datasphere Document.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters:
         - $ref: '#/components/parameters/DocumentPathID'
       responses:
@@ -145,7 +173,14 @@ paths:
     get:
       operationId: Chunks_get
       summary: Retrieve Chunk
-      description: Retrieves a specific chunk for a Datasphere Document by ID.
+      description: |-
+        Retrieves a specific chunk for a Datasphere Document by ID.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters:
         - $ref: '#/components/parameters/ChunkPathID.documentId'
         - $ref: '#/components/parameters/ChunkPathID.chunkId'
@@ -173,7 +208,14 @@ paths:
     delete:
       operationId: Chunks_delete
       summary: Delete Chunk
-      description: Deletes a specific chunk for a Datasphere Document by ID.
+      description: |-
+        Deletes a specific chunk for a Datasphere Document by ID.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters:
         - $ref: '#/components/parameters/ChunkPathID.documentId'
         - $ref: '#/components/parameters/ChunkPathID.chunkId'
@@ -198,7 +240,14 @@ paths:
     patch:
       operationId: Documents_update
       summary: Update a Document
-      description: Updates a Datasphere Document by ID
+      description: |-
+        Updates a Datasphere Document by ID.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters:
         - $ref: '#/components/parameters/PathID'
       responses:
@@ -237,7 +286,14 @@ paths:
     delete:
       operationId: Documents_delete
       summary: Delete a Document
-      description: Deletes a Datasphere Document by ID
+      description: |-
+        Deletes a Datasphere Document by ID.
+
+        #### Permissions
+
+        The API token used to authenticate must have the following scopes enabled to make a successful request: _DataSphere_.
+
+        [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       parameters:
         - $ref: '#/components/parameters/PathID'
       responses:

specs/signalwire-rest/fabric-api/addresses/main.tsp

@@ -17,6 +17,13 @@ namespace FabricAPI.FabricAddresses {
     @doc("""
       A list of Fabric Addresses. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be
       generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create).
+
+
+      #### Permissions
+
+      The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       """)
     list():
       | FabricAddressesResponse
@@ -28,6 +35,13 @@ namespace FabricAPI.FabricAddresses {
     @doc("""
       Returns a Fabric Address by ID. This endpoint uses the bearer token authentication method with the SAT (Subscriber Access Token) which can be
       generated using the [Create Subscriber Token endpoint](/rest/signalwire-rest/endpoints/fabric/subscriber-tokens-create).
+
+
+      #### Permissions
+
+      The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
       """)
     read(...FabricAddressID):
       | {

specs/signalwire-rest/fabric-api/ai-agent/addresses/main.tsp

@@ -13,7 +13,15 @@ namespace FabricAPI.AIAgent.Addresses {
   @tag(AI_CUSTOM_TAG)
   interface AIAgentAddresses {
     @summary("List AI Agent Addresses")
-    @doc("This endpoint returns a list of addresses associated with a specific AI Agent.")
+    @doc("""
+      This endpoint returns a list of addresses associated with a specific AI Agent.
+
+      #### Permissions
+
+      The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_.
+
+      [Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
+      """)
     list(...AIAgentIDPath):
       | AIAgentAddressListResponse
       | StatusCode401