Skip to content

Commit 7291c05

Browse files
author
cibot
committed
Definitions Update aetag
1 parent 4f94eda commit 7291c05

File tree

1 file changed

+185
-0
lines changed

1 file changed

+185
-0
lines changed

‎alsdkdefs/apis/aetag/aetag.v1.yaml‎

Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,121 @@ paths:
137137
name: id
138138
in: path
139139
required: true
140+
'/aetag/v1/tags/key/paths/{path}':
141+
parameters:
142+
- schema:
143+
type: string
144+
name: path
145+
in: path
146+
required: true
147+
description: url-encoded path
148+
post:
149+
summary: Atomically perform CRUD operations on specific keys of a tagset.
150+
tags:
151+
- Tags Resources
152+
responses:
153+
'200':
154+
description: Combination of reads (if any) and modified tagset uuid (if any modification)
155+
operationId: crud_global_tagset_keys_by_path
156+
security:
157+
- X-AIMS-Auth-Token: []
158+
description: >-
159+
Specific operations to be performed are specified through the call body. This body is of one or more objects
160+
executed sequentially. Each objects have at least an "operation" key, which has a value being one of
161+
"read", "write", "delete", "add", or "subtract":
162+
163+
- read: returns the tuning tagset key identified in the object's key "key"
164+
165+
- write: replaces the tuning tagset key identified in the object's key "key" with the object's key "value"; may
166+
take an optional "expiration_ts" key
167+
168+
- delete: removes the tuning tagset key identified in the object's key "key"
169+
170+
- add: if the tuning tagset key identified in the object's key "key" is a list, adds the object's key "value"
171+
provided it is not already in the list; may take an optional "expiration_ts" key
172+
173+
- subtract: if the tuning tagset key identified in the object's key "key" is a list, removes all occurrences of
174+
the object's key "value"
175+
176+
Operations are performed in the order they are specified.
177+
178+
179+
Specifying an "expiration_ts" key (where allowed) causes the tagset key to expire at a given time. The value of
180+
the key is an integer representing the expiration time as a Unix epoch.
181+
182+
183+
Tags requested for a specific customer id are **composed** tuning tagset which uses the definition to decide
184+
from where, what and how to merge tagsets together. The 'etag' header is set and may be used to cache the
185+
response by the caller. Global tags are not composed.
186+
requestBody: &crudBody
187+
required: true
188+
content:
189+
application/json:
190+
schema:
191+
type: array
192+
items:
193+
anyOf:
194+
- $ref: '#/components/schemas/CrudKeyWrite'
195+
- $ref: '#/components/schemas/CrudKeyRead'
196+
- $ref: '#/components/schemas/CrudKeyDelete'
197+
- $ref: '#/components/schemas/CrudKeyAdd'
198+
- $ref: '#/components/schemas/CrudKeySubtract'
199+
x-alertlogic-schema:
200+
name: crud_list
201+
encoding:
202+
explode: true
203+
description: JSON array of crud operations to perform.
204+
'/aetag/v1/{account_id}/tags/key/paths/{path}':
205+
parameters:
206+
- schema:
207+
type: string
208+
name: account_id
209+
in: path
210+
required: true
211+
description: AIMS Account ID
212+
- schema:
213+
type: string
214+
name: path
215+
in: path
216+
required: true
217+
description: url-encoded path
218+
post:
219+
summary: Atomically perform CRUD operations on specific keys of a tagset.
220+
tags:
221+
- Tags Resources
222+
responses:
223+
'200':
224+
description: Combination of reads (if any) and modified tagset uuid (if any modification)
225+
operationId: crud_tagset_keys_by_path
226+
security:
227+
- X-AIMS-Auth-Token: []
228+
description: >-
229+
Specific operations to be performed are specified through the call body. This body is of one or more objects
230+
executed sequentially. Each objects have at least an "operation" key, which has a value being one of
231+
"read", "write", "delete", "add", or "subtract":
232+
233+
- read: returns the tuning tagset key identified in the object's key "key"
234+
235+
- write: replaces the tuning tagset key identified in the object's key "key" with the object's key "value"; may
236+
take an optional "expiration_ts" key
237+
238+
- delete: removes the tuning tagset key identified in the object's key "key"
239+
240+
- add: if the tuning tagset key identified in the object's key "key" is a list, adds the object's key "value"
241+
provided it is not already in the list; may take an optional "expiration_ts" key
242+
243+
- subtract: if the tuning tagset key identified in the object's key "key" is a list, removes all occurrences of
244+
the object's key "value"
245+
246+
Operations are performed in the order they are specified.
247+
248+
Specifying an "expiration_ts" key (where allowed) causes the tagset key to expire at a given time. The value of
249+
the key is an integer representing the expiration time as a Unix epoch.
250+
251+
Tags requested for a specific customer id are **composed** tuning tagset which uses the definition to decide
252+
from where, what and how to merge tagsets together. The 'etag' header is set and may be used to cache the
253+
response by the caller. Global tags are not composed.
254+
requestBody: *crudBody
140255
/aetag/v1/tags:
141256
parameters: []
142257
post:
@@ -1001,6 +1116,76 @@ components:
10011116
- inherit
10021117
- direction
10031118
- expiration
1119+
CrudKeyWrite:
1120+
type: object
1121+
properties:
1122+
operation:
1123+
type: string
1124+
pattern: "^write$"
1125+
key:
1126+
type: string
1127+
value: {}
1128+
expiration_ts:
1129+
type: integer
1130+
required:
1131+
- operation
1132+
- key
1133+
- value
1134+
additionalProperties: false
1135+
CrudKeyAdd:
1136+
type: object
1137+
properties:
1138+
operation:
1139+
type: string
1140+
pattern: "^add$"
1141+
key:
1142+
type: string
1143+
value: {}
1144+
expiration_ts:
1145+
type: integer
1146+
required:
1147+
- operation
1148+
- key
1149+
- value
1150+
additionalProperties: false
1151+
CrudKeySubtract:
1152+
type: object
1153+
properties:
1154+
operation:
1155+
type: string
1156+
pattern: "^subtract$"
1157+
key:
1158+
type: string
1159+
value: {}
1160+
required:
1161+
- operation
1162+
- key
1163+
- value
1164+
additionalProperties: false
1165+
CrudKeyDelete:
1166+
type: object
1167+
properties:
1168+
operation:
1169+
type: string
1170+
pattern: "^delete$"
1171+
key:
1172+
type: string
1173+
required:
1174+
- operation
1175+
- key
1176+
additionalProperties: false
1177+
CrudKeyRead:
1178+
type: object
1179+
properties:
1180+
operation:
1181+
type: string
1182+
pattern: "^read$"
1183+
key:
1184+
type: string
1185+
required:
1186+
- operation
1187+
- key
1188+
additionalProperties: false
10041189
securitySchemes:
10051190
X-AIMS-Auth-Token:
10061191
name: X-AIMS-Auth-Token

0 commit comments

Comments
 (0)