Skip to content

Commit fb1989f

Browse files
committed
Documnt URI parameters
1 parent 9299ec6 commit fb1989f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

ramls/cyclops.raml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,11 @@ documentation:
7070
description: No content is returned.
7171

7272
/{setName}:
73+
uriParameters:
74+
setName:
75+
description: The name of the set to retrieve from, modify or tag
76+
type: string
77+
required: true
7378
get:
7479
description: "Retrieve elements of a set"
7580
queryParameters:
@@ -130,6 +135,11 @@ documentation:
130135
description: No content is returned.
131136
/tag:
132137
/{tagName}:
138+
uriParameters:
139+
tagName:
140+
description: The name of the tag to add or remove to object within the set. The path `/cyclops/sets/mike/tag/dino` represents the resource "the set of records that are tagged with `dino` in the set `mike`.
141+
type: string
142+
required: true
133143
post:
134144
description: "add tag to, or remove tag from, objects within in a set"
135145
body:

0 commit comments

Comments
 (0)