Skip to content

Commit aef9ec2

Browse files
authored
fix: Subscriber Invite endpoint takes bearer token (#331)
1 parent 9346306 commit aef9ec2

4 files changed

Lines changed: 10 additions & 4 deletions

File tree

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ node_modules
88
.env
99
.env.*
1010
!.env.example
11+
12+
.docs-review

fern/apis/signalwire-rest/openapi.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1410,7 +1410,7 @@ paths:
14101410
operationId: create_subscriber_guest_token
14111411
summary: Create Subscriber guest token
14121412
description: |-
1413-
Creates a [Subscriber](/docs/platform/subscribers) Guest Token. The token is authorized using an existing API token.
1413+
Creates a [Subscriber](/docs/platform/subscribers) Guest Token. Authenticate this request with your project's API token.
14141414

14151415
#### Permissions
14161416

@@ -5661,7 +5661,7 @@ paths:
56615661
operationId: create_subscriber_invite_token
56625662
summary: Create Subscriber invite token
56635663
description: |-
5664-
Creates a [Subscriber](/docs/platform/subscribers) Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token).
5664+
Creates a [Subscriber](/docs/platform/subscribers) Invite Token for use with client-side API calls. Authenticate this request with a subscriber's SAT (Subscriber Access Token), not the project level Basic Auth.
56655665

56665666
#### Permissions
56675667

@@ -5708,6 +5708,8 @@ paths:
57085708
application/json:
57095709
schema:
57105710
$ref: '#/components/schemas/SubscriberInviteTokenCreateRequest'
5711+
security:
5712+
- SignalWireBearerAuth: []
57115713
/api/fabric/subscribers/tokens:
57125714
post:
57135715
operationId: create_subscriber_token

specs/signalwire-rest/fabric-api/subscribers/guest-tokens/main.tsp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ namespace SignalWireAPI.Fabric.SubscriberGuestTokens {
1919
@operationId("create_subscriber_guest_token")
2020
@summary("Create Subscriber guest token")
2121
@doc("""
22-
Creates a [Subscriber](/docs/platform/subscribers) Guest Token. The token is authorized using an existing API token.
22+
Creates a [Subscriber](/docs/platform/subscribers) Guest Token. Authenticate this request with your project's API token.
2323
2424
${tokenPermissions<"_Voice_, _Messaging_, _Fax_, or _Video_">}
2525
""")

specs/signalwire-rest/fabric-api/subscribers/invite-tokens/main.tsp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ import "./models/responses.tsp";
55
import "./models/errors.tsp";
66
import "../../../types";
77
import "../../tags.tsp";
8+
import "../../../../_shared/auth.tsp";
89
import "../../../../_shared/alias/token-permissions.tsp";
910

1011
using TypeSpec.Http;
1112
using TypeSpec.OpenAPI;
1213
using Types.StatusCodes;
1314

15+
@useAuth(SignalWireBearerAuth)
1416
@route("/subscriber/invites")
1517
namespace SignalWireAPI.Fabric.SubscriberInviteTokens {
1618
@tag(SUBSCRIBERS_TOKENS_TAG)
@@ -19,7 +21,7 @@ namespace SignalWireAPI.Fabric.SubscriberInviteTokens {
1921
@operationId("create_subscriber_invite_token")
2022
@summary("Create Subscriber invite token")
2123
@doc("""
22-
Creates a [Subscriber](/docs/platform/subscribers) Invite Token to be used for client-side API calls. The token is authorized using a subscriber's SAT (Subscriber Access Token).
24+
Creates a [Subscriber](/docs/platform/subscribers) Invite Token for use with client-side API calls. Authenticate this request with a subscriber's SAT (Subscriber Access Token), not the project level Basic Auth.
2325
2426
${tokenPermissions<"_Voice_, _Messaging_, _Fax_, or _Video_">}
2527
""")

0 commit comments

Comments
 (0)