Definitions Update assets_query

Author: cibot

alsdkdefs/apis/assets_query/assets_query.v1.yaml

@@ -408,6 +408,29 @@ paths:
           $ref: 'responses.yaml#/UnavailableError'
       security:
         - x-aims-auth-token: []
+    put:
+      operationId: asset_group
+      summary: Asset Group (Delete)
+      description: |-
+        ### Delete Asset Group (operation:delete_asset_group)
+        Delete an existing `asset-group` asset.
+      tags:
+        - Asset Groups
+      requestBody:
+        content:
+          application/json:
+            schema:
+                $ref: 'schemas.yaml#/DeleteAssetGroupRequestBody'
+            examples:
+              Delete Asset Group Request Body Example:
+                $ref: 'examples.yaml#/DeleteAssetGroupRequestBodyExample'
+      responses:
+        "204":
+          description: No Content (Delete Asset Group successful response)
+        "400":
+          $ref: 'responses.yaml#/AssetGroupsBadRequest'
+        "404":
+          $ref: 'responses.yaml#/NotFound'
   /assets_query/v1/{account_id}/deployments/{deployment_id}/assets:
     parameters:
       - $ref: 'parameters.yaml#/UrlParamAccountId'

alsdkdefs/apis/assets_query/examples.yaml

@@ -4798,3 +4798,8 @@ AssetTypeSchemaResponseExample:
     topological_successors_list: [ ]
     unscoped_properties: [ ]
     vulnerable: true
+DeleteAssetGroupRequestBodyExample:
+  value:
+    operation: delete_asset_group
+    scope: user
+    name: PCI Assets

alsdkdefs/apis/assets_query/responses.yaml

@@ -148,3 +148,26 @@ AssetDetailsConflict:
           value:
             error_type: conflict
             message: Multiple assets match
+AssetGroupsBadRequest:
+  description: 'Asset Groups `Bad Request`'
+  content:
+    application/json:
+      schema:
+        type: object
+        properties:
+          error_type:
+            type: string
+          message:
+            type: string
+        required:
+          - error_type
+          - message
+      examples:
+        InvalidOperation:
+          value:
+            error_type: bad_request
+            message: invalid operation
+        ExistingReference:
+          value:
+            error_type: bad_request
+            message: Asset Group is still reference in these groups

alsdkdefs/apis/assets_query/schemas.yaml

@@ -16,12 +16,25 @@ AssetName:
 Filters:
   type: array
   description: Filters
+GroupName:
+  type: string
+  description: |-
+    The unique name for the `asset-group` asset, such as `my-group`. This will be the same
+    as the asset `key`.
 ItemId:
   type: string
   description: Item ID
 RemediationId:
   type: string
   description: Remediation ID
+Scope:
+  type: string
+  description: |-
+    The declaring software's authority or area of function. For example, the scan subsystem
+    declaring vulnerabilities passes scope `"scan"`, and the UI declaring a credential for
+    an asset passes scope `"config"`. `cloud_explorer`, responsible for discovering
+    deployments (environments), passes `"aws"`. The scope must match the regex pattern
+    `[0-9A-Za-z-]`.
 State:
   type: string
   description: The remediation-item state.
@@ -705,8 +718,23 @@ AssetTypesSchemaResponse:
         - type: object
     count:
       type: number
-
 AssetTypeSchemaResponse:
   title: Asset Type Schema Response
   type: object
-
+DeleteAssetGroupRequestBody:
+  title: Delete Asset Group Request Body
+  type: object
+  properties:
+    operation:
+      type: string
+      description: This must be `delete_asset_group`.
+      enum:
+        - delete_asset_group
+    name:
+      $ref: '#/GroupName'
+    scope:
+      $ref: '#/Scope'
+  required:
+    - operation
+    - name
+    - scope