Skip to content

Commit ddda6f6

Browse files
committed
Add token scopes to logs endpoint
1 parent bbd851c commit ddda6f6

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

specs/signalwire-rest/logs-api/conferences/main.tsp

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,15 @@ namespace LogsAPI.Conferences {
1414
@friendlyName("Conferences")
1515
interface Conferences {
1616
@summary("List Conferences")
17-
@doc("A list of Conferences.")
17+
@doc("""
18+
A list of Conferences.
19+
20+
#### Permissions
21+
22+
The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Video_.
23+
24+
[Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
25+
""")
1826
list(): ConferencesResponse | StatusCode401 | StatusCode404;
1927
}
2028
}

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

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ paths:
1010
get:
1111
operationId: Conferences_list
1212
summary: List Conferences
13-
description: A list of Conferences.
13+
description: |-
14+
A list of Conferences.
15+
16+
#### Permissions
17+
18+
The API token used to authenticate must have one of the following scopes enabled to make a successful request: _Voice_ or _Video_.
19+
20+
[Learn more about API scopes](/platform/dashboard/getting-started/your-signalwire-api-space#api-token-scopes).
1421
parameters: []
1522
responses:
1623
'200':

0 commit comments

Comments
 (0)