Skip to content

Commit 0262d50

Browse files
Document relay rest api endpoints
GET https://{{Space}}/api/relay/rest/queues GET https://{{Space}}/api/relay/rest/queues/:id PUT https://{{Space}}/api/relay/rest/queues/:id DELETE https://{{Space}}/api/relay/rest/queues/:id POST https://{{Space}}/api/relay/rest/queues
1 parent 30aa142 commit 0262d50

File tree

1 file changed

+186
-0
lines changed

1 file changed

+186
-0
lines changed

api/signalwire-rest/space-api/_spec_.yaml

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,71 @@ components:
412412
type: string
413413
format: uuid
414414
description: Universal Unique Identifier.
415+
Queue:
416+
type: object
417+
required:
418+
- id
419+
- project_id
420+
- friendly_name
421+
- uri
422+
properties:
423+
id:
424+
type: string
425+
format: uuid
426+
example: aae131db-214c-46f5-88b6-92004f8467cf
427+
project_id:
428+
type: string
429+
format: uuid
430+
example: c6c4679b-716a-456a-9e41-a03821005005
431+
average_wait_time:
432+
type: integer
433+
format: int32
434+
example: 0
435+
current_size:
436+
type: integer
437+
format: int32
438+
example: 0
439+
date_created:
440+
type: string
441+
format: date-time
442+
example: 2025-05-30T15:16:52Z
443+
date_updated:
444+
type: string
445+
format: date-time
446+
example: 2025-05-30T15:16:52Z
447+
friendly_name:
448+
type: string
449+
example: test
450+
max_size:
451+
type: integer
452+
format: int32
453+
example: 5
454+
uri:
455+
type: string
456+
format: uri
457+
example: /api/relay/rest/queues/aae131db-214c-46f5-88b6-92004f8467cf
458+
QueueListResponse:
459+
type: object
460+
required:
461+
- data
462+
- links
463+
properties:
464+
data:
465+
type: array
466+
items:
467+
$ref: '#/components/schemas/Queue'
468+
links:
469+
$ref: '#/components/schemas/pagination'
470+
UpdateQueueRequest:
471+
type: object
472+
properties:
473+
name:
474+
type: string
475+
example: Name 2
476+
max_size:
477+
type: integer
478+
format: int32
479+
example: 600
415480
parameters:
416481
RecordingPathID:
417482
name: id
@@ -470,6 +535,7 @@ tags:
470535
3. When the phone is answered, we will read a six-digit code.
471536
4. To verify that you are the owner, take that number and submit it to the Validate Verifications Endpoint.
472537
* You have 5 attempts to enter the code correctly.
538+
- name: Queues
473539
paths:
474540
/addresses:
475541
get:
@@ -9868,3 +9934,123 @@ paths:
98689934
- Not Found
98699935
tags:
98709936
- Recordings
9937+
/queues:
9938+
get:
9939+
tags:
9940+
- Queues
9941+
summary: List Queues
9942+
description: Returns a paginated list of queues.
9943+
responses:
9944+
'200':
9945+
description: A list of queues
9946+
content:
9947+
application/json:
9948+
schema:
9949+
$ref: '#/components/schemas/QueueListResponse'
9950+
post:
9951+
tags:
9952+
- Queues
9953+
summary: Create a Queue
9954+
description: Creates a new queue.
9955+
requestBody:
9956+
required: true
9957+
content:
9958+
application/json:
9959+
schema:
9960+
$ref: '#/components/schemas/UpdateQueueRequest'
9961+
responses:
9962+
'201':
9963+
description: Queue created
9964+
content:
9965+
application/json:
9966+
schema:
9967+
$ref: '#/components/schemas/Queue'
9968+
'422':
9969+
$ref: '#/components/responses/422'
9970+
'401':
9971+
description: Access is unauthorized.
9972+
content:
9973+
application/json:
9974+
schema:
9975+
type: string
9976+
enum:
9977+
- Unauthorized
9978+
/queues/{id}:
9979+
get:
9980+
tags:
9981+
- Queues
9982+
summary: Retrieve a Queue
9983+
description: Returns information about a specific queue.
9984+
parameters:
9985+
- $ref: '#/components/parameters/RecordingPathID'
9986+
responses:
9987+
'200':
9988+
description: Queue found
9989+
content:
9990+
application/json:
9991+
schema:
9992+
$ref: '#/components/schemas/Queue'
9993+
'401':
9994+
description: Access is unauthorized.
9995+
content:
9996+
application/json:
9997+
schema:
9998+
type: string
9999+
enum:
10000+
- Unauthorized
10001+
'404':
10002+
description: Queue not found
10003+
put:
10004+
tags:
10005+
- Queues
10006+
summary: Update a Queue
10007+
description: Updates the properties of a specific queue.
10008+
parameters:
10009+
- $ref: '#/components/parameters/RecordingPathID'
10010+
requestBody:
10011+
required: true
10012+
content:
10013+
application/json:
10014+
schema:
10015+
$ref: '#/components/schemas/UpdateQueueRequest'
10016+
responses:
10017+
'200':
10018+
description: Queue updated
10019+
content:
10020+
application/json:
10021+
schema:
10022+
$ref: '#/components/schemas/Queue'
10023+
'400':
10024+
$ref: '#/components/responses/400'
10025+
'422':
10026+
$ref: '#/components/responses/422'
10027+
'401':
10028+
description: Access is unauthorized.
10029+
content:
10030+
application/json:
10031+
schema:
10032+
type: string
10033+
enum:
10034+
- Unauthorized
10035+
delete:
10036+
tags:
10037+
- Queues
10038+
summary: Delete a Queue
10039+
description: Deletes a specific queue.
10040+
parameters:
10041+
- $ref: '#/components/parameters/RecordingPathID'
10042+
responses:
10043+
'204':
10044+
$ref: '#/components/responses/204'
10045+
'400':
10046+
$ref: '#/components/responses/400'
10047+
'401':
10048+
description: Access is unauthorized.
10049+
content:
10050+
application/json:
10051+
schema:
10052+
type: string
10053+
enum:
10054+
- Unauthorized
10055+
'404':
10056+
description: Queue not found

0 commit comments

Comments
 (0)