Definitions Update aetag

alertlogic · Sep 8, 2020 · 4774b04 · 4774b04
1 parent 7c67579
commit 4774b04
Showing 1 changed file with 171 additions and 2 deletions.
diff --git a/alsdkdefs/apis/aetag/aetag.v1.yaml b/alsdkdefs/apis/aetag/aetag.v1.yaml
@@ -189,7 +189,81 @@ paths:
         Tags requested for a specific customer id are **composed** tuning tagset which uses the definition to decide
         from where, what and how to merge tagsets together. The 'etag' header is set and may be used to cache the
         response by the caller. Global tags are not composed.
-      requestBody: &crudBody
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                anyOf:
+                  - $ref: '#/components/schemas/CrudKeyWrite'
+                  - $ref: '#/components/schemas/CrudKeyRead'
+                  - $ref: '#/components/schemas/CrudKeyDelete'
+                  - $ref: '#/components/schemas/CrudKeyAdd'
+                  - $ref: '#/components/schemas/CrudKeySubtract'
+            x-alertlogic-schema:
+              name: crud_list
+              encoding:
+                explode: true
+        description: JSON array of crud operations to perform.
+  '/aetag/v1/tunings/key/paths/{path}':
+    parameters:
+      - schema:
+          type: string
+        name: path
+        in: path
+        required: true
+        description: url-encoded path
+    post:
+      summary: >-
+        Atomically perform CRUD operations on specific keys of a tuning tagset.
+      tags:
+        - Tunings Resources
+      responses:
+        '200':
+          description: >-
+            Combination of reads (if any) and modified tuning uuid (if any
+            modification)
+      operationId: crud_global_tuning_keys_by_path
+      security:
+        - X-AIMS-Auth-Token: []
+      description: >-
+        Specific operations to be performed are specified through the call body.
+        This body is of one or more objects executed sequentially. Each objects
+        have at least an "operation" key, which has a value being one of "read",
+        "write", "delete", "add", or "subtract":
+
+        - read: returns the tuning tagset key identified in the object's key
+          "key"
+
+        - write: replaces the tuning tagset key identified in the object's key
+          "key" with the object's key "value"; may take an optional
+          "expiration_ts" key
+
+        - delete: removes the tuning tagset key identified in the object's key
+          "key"
+
+        - add: if the tuning tagset key identified in the object's key "key" is
+          a list, adds the object's key "value" provided it is not already in
+          the list; may take an optional "expiration_ts" key
+
+        - subtract: if the tuning tagset key identified in the object's key
+          "key" is a list, removes all occurrences of the object's key "value"
+
+        Operations are performed in the order they are specified.
+
+
+        Specifying an "expiration_ts" key (where allowed) causes the tagset key
+        to expire at a given time. The value of the key is an integer
+        representing the expiration time as a Unix epoch.
+
+
+        Tags requested for a specific customer id are composed tuning tagset
+        which uses the definition to decide from where, what and how to merge
+        tagsets together. The 'etag' header is set and may be used to cache the
+        response by the caller. Global tags are not composed.
+      requestBody:
         required: true
         content:
           application/json:
@@ -257,7 +331,102 @@ paths:
         Tags requested for a specific customer id are **composed** tuning tagset which uses the definition to decide
         from where, what and how to merge tagsets together. The 'etag' header is set and may be used to cache the
         response by the caller. Global tags are not composed.
-      requestBody: *crudBody
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                anyOf:
+                  - $ref: '#/components/schemas/CrudKeyWrite'
+                  - $ref: '#/components/schemas/CrudKeyRead'
+                  - $ref: '#/components/schemas/CrudKeyDelete'
+                  - $ref: '#/components/schemas/CrudKeyAdd'
+                  - $ref: '#/components/schemas/CrudKeySubtract'
+            x-alertlogic-schema:
+              name: crud_list
+              encoding:
+                explode: true
+        description: JSON array of crud operations to perform.
+  '/aetag/v1/{account_id}/tunings/key/paths/{path}':
+    parameters:
+      - schema:
+          type: string
+        name: account_id
+        in: path
+        required: true
+        description: AIMS Account ID
+      - schema:
+          type: string
+        name: path
+        in: path
+        required: true
+        description: url-encoded path
+    post:
+      summary: >-
+        Atomically perform CRUD operations on specific keys of a tuning tagset.
+      tags:
+        - Tunings Resources
+      responses:
+        '200':
+          description: >-
+            Combination of reads (if any) and modified tagset uuid (if any
+            modification)
+      operationId: crud_tuning_keys_by_path
+      security:
+        - X-AIMS-Auth-Token: []
+      description: >-
+        Specific operations to be performed are specified through the call body.
+        This body is of one or more objects executed sequentially. Each objects
+        have at least an "operation" key, which has a value being one of "read",
+        "write", "delete", "add", or "subtract":
+
+        - read: returns the tuning tagset key identified in the object's key
+          "key"
+
+        - write: replaces the tuning tagset key identified in the object's key
+          "key" with the object's key "value"; may take an optional
+          "expiration_ts" key
+
+        - delete: removes the tuning tagset key identified in the object's key
+          "key"
+
+        - add: if the tuning tagset key identified in the object's key "key" is
+          a list, adds the object's key "value" provided it is not already in
+          the list; may take an optional "expiration_ts" key
+
+        - subtract: if the tuning tagset key identified in the object's key
+          "key" is a list, removes all occurrences of the object's key "value"
+
+        Operations are performed in the order they are specified.
+
+        Specifying an "expiration_ts" key (where allowed) causes the tagset key
+        to expire at a given time. The value of the key is an integer
+        representing the expiration time as a Unix epoch.
+
+        Tags requested for a specific customer id are composed tuning tagset
+        which uses the definition to decide from where, what and how to merge
+        tagsets together. The 'etag' header is set and may be used to cache the
+        response by the caller. Global tags are not composed.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                anyOf:
+                  - $ref: '#/components/schemas/CrudKeyWrite'
+                  - $ref: '#/components/schemas/CrudKeyRead'
+                  - $ref: '#/components/schemas/CrudKeyDelete'
+                  - $ref: '#/components/schemas/CrudKeyAdd'
+                  - $ref: '#/components/schemas/CrudKeySubtract'
+            x-alertlogic-schema:
+              name: crud_list
+              encoding:
+                explode: true
+        description: JSON array of crud operations to perform.
   /aetag/v1/tags:
     parameters: []
     post: