Skip to content

Commit f2734f7

Browse files
committed
Model locations and sessions as REST resources
Remove the action from the URI for the resource to allow individual referencing and collections of nested resources.
1 parent e42b8c2 commit f2734f7

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

api/openapi.yaml

+6-5
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,13 @@ paths:
3434
'400':
3535
$ref: '#/components/responses/ErrorResponse'
3636

37-
/list_locations:
37+
/locations:
3838
get:
39+
description: Lists all the visible locations to the caller.
3940
parameters:
4041
- name: asn
4142
in: query
42-
description: List avaible locations for peering with the given ASN
43+
description: List available locations for peering with the given ASN
4344
required: true
4445
schema:
4546
type: integer
@@ -63,9 +64,9 @@ paths:
6364
'400':
6465
$ref: '#/components/responses/ErrorResponse'
6566

66-
/add_sessions:
67+
/sessions:
6768
post:
68-
description: Request peering
69+
description: Requests a new set of sessions to be created.
6970
requestBody:
7071
description: Request to create peering sessions
7172
content:
@@ -89,8 +90,8 @@ paths:
8990
'400':
9091
$ref: '#/components/responses/ErrorResponse'
9192

92-
/get_status:
9393
get:
94+
description: Lists a set of sessions visible to the caller. Each session in the set contains a summary of its current status.
9495
parameters:
9596
- name: asn
9697
in: query

0 commit comments

Comments
 (0)