Definitions Update assets_query

Author: cibot

alsdkdefs/apis/assets_query/assets_query.v1.yaml

@@ -367,6 +367,43 @@ paths:
           $ref: 'responses.yaml#/NotFound'
         "503":
           $ref: 'responses.yaml#/UnavailableError'
+  /assets_query/v1/{account_id}/asset_groups:
+    parameters:
+      - $ref: 'parameters.yaml#/UrlParamAccountId'
+    get:
+      operationId: list_asset_groups
+      summary: List Asset Groups (Preview)
+      description: |-
+        **Disclaimer: This endpoint is currently under development. The request parameters, response format
+        or the endpoint itself may be changed or removed at any time without notice.**
+        
+        List asset groups for given account.
+      tags:
+        - Queries
+      x-codeSamples:
+        - lang: Shell
+          label: List Asset Groups
+          source: |-
+            curl "https://api.cloudinsight.alertlogic.com/assets_query/v1/19000001/asset_groups" \
+                 -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: 'schemas.yaml#/ListAssetGroupsResponse'
+              examples:
+                Topology Preview Example:
+                  $ref: 'examples.yaml#/ListAssetGroupsExample'
+        "401":
+          $ref: 'responses.yaml#/Unauthorized'
+        "403":
+          $ref: 'responses.yaml#/Forbidden'
+        "503":
+          $ref: 'responses.yaml#/UnavailableError'
+      security:
+        - x-aims-auth-token: []
   /assets_query/v1/{account_id}/deployments/{deployment_id}/assets:
     parameters:
       - $ref: 'parameters.yaml#/UrlParamAccountId'

alsdkdefs/apis/assets_query/examples.yaml

@@ -3162,15 +3162,15 @@ QueryTopologyOverviewExample:
           standard: 1
         vpc: 1
       assets:
-        - - region/aws/us-east-1
-          - "/aws/us-east-1/vpc/vpc-1"
+        - - region:/aws/us-east-1
+          - vpc:/aws/us-east-1/vpc/vpc-1
           - subnet:/aws/us-east-1/subnet/subnet-1a-web
           - host:/aws/us-east-1/host/web-1a-1
-        - - region/aws/us-east-1
-          - "/aws/us-east-1/vpc/vpc-1"
+        - - region:/aws/us-east-1
+          - vpc:/aws/us-east-1/vpc/vpc-1
           - subnet:/aws/us-east-1/subnet/subnet-2
           - host:/aws/us-east-1/host/alertlogic-ids-1
-        - - region/aws/us-west-2
+        - - region:/aws/us-west-2
           - 
           - 
           - 
@@ -3179,7 +3179,8 @@ QueryTopologyOverviewExample:
           alertlogic_agent: false
           alertlogic_appliance: true
           created_on: 1427317669928
-          key: "/aws/us-east-1/host/web-1a-1"
+          groups: ["PCI assets"]
+          key: "/aws/us-east-1/host/alertlogic-ids-1"
           state: running
           threat_level: 2
           threatiness: 2
@@ -3201,6 +3202,7 @@ QueryTopologyOverviewExample:
           type: image
         region/aws/us-east-1:
           created_on: 1427317669194
+          groups: ["PCI assets"]
           key: "/aws/us-east-1"
           threat_level: 3
           threatiness: 22
@@ -3220,12 +3222,14 @@ QueryTopologyOverviewExample:
         subnet:/aws/us-east-1/subnet/subnet-2:
           alertlogic_security: true
           created_on: 1427317669627
+          groups: ["PCI assets"]
           key: "/aws/us-east-1/subnet/subnet-2"
           threat_level: 1
           threatiness: 4
           type: subnet
         vpc:/aws/us-east-1/vpc/vpc-1:
           created_on: 1427317669270
+          groups: ["PCI assets"]
           key: "/aws/us-east-1/vpc/vpc-1"
           threat_level: 3
           threatiness: 22
@@ -4114,3 +4118,28 @@ QueryRemediationItemsMultipleDeploymentsGroupByAuditIdExample:
         info: 0
         low: 0
         medium: 0
+ListAssetGroupsExample:
+  value:
+    groups:
+    - type: asset-group
+      scopes:
+      - include:
+        - deployment.name:US Production
+        asset_types:
+        - host
+      key: Production assets
+      description: Production assets
+      criticality: 1
+      created_on: 1600724524156
+    - type: asset-group
+      scopes:
+      - include:
+        - deployment:any
+        - host.private_ip_addresses::cidr_match:192.168.0.0/16
+        asset_types:
+        - host
+      key: cidr-assets
+      description: Hosts in 192.168.0.0/16
+      criticality: 1
+      created_on: 1600724524178
+    count: 2

alsdkdefs/apis/assets_query/schemas.yaml

@@ -630,3 +630,16 @@ ConcludeRemediationsRequestBody:
       $ref: '#/VulnerabilityIds'
   required:
     - operation
+ListAssetGroupsResponse:
+  title: List Asset Groups response
+  type: object
+  properties:
+    groups:
+      type: array
+      description: An array group objects. Each element in the array is an asset group.
+      items:
+        type: object
+        description: Group object.
+    count:
+      type: integer
+      description: The count of `groups` in the response.