Definitions Update assets_query

Author: cibot

alsdkdefs/apis/assets_query/assets_query.v1.yaml

@@ -428,6 +428,8 @@ paths:
       - $ref: 'parameters.yaml#/ParamTopoChain'
       - $ref: 'parameters.yaml#/ParamScopeBoolean'
       - $ref: 'parameters.yaml#/ParamIncludeAlertlogicSecurity'
+      - $ref: 'parameters.yaml#/ParamContinue'
+      - $ref: 'parameters.yaml#/ParamPageSize'
     get:
       operationId: query_assets
       summary: Query Assets for Account
@@ -470,6 +472,16 @@ paths:
           source: |-
             curl "https://api.cloudinsight.alertlogic.com/assets_query/v1/12345678/assets?asset_types=h:host&h.private_ip_addresses=:cidr_match:192.168.0.0/16" \
                  -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
+        - lang: Shell
+          label: Get all assets for an account ID with pagination
+          source: |-
+            curl "https://api.cloudinsight.alertlogic.com/assets_query/v1/12345678/assets?page_size=10" \
+                 -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
+        - lang: Shell
+          label: Get all assets for an account ID with pagination (continue)
+          source: |-
+            curl "https://api.cloudinsight.alertlogic.com/assets_query/v1/12345678/assets?continue=EEBBD0DF-B927-411B-B771-247D4C96F9AC" \
+                 -H "x-aims-auth-token: $TOKEN" -H "accept: application/json"
       responses:
         "200":
           description: OK
@@ -496,6 +508,10 @@ paths:
                   $ref: 'examples.yaml#/QueryAssetsAssetTypesHostCIDRMatchExample'
                 topo_chain=false:
                   $ref: 'examples.yaml#/QueryAssetsTopoChainFalseExample'
+                asset_types=any & page_size=5:
+                  $ref: 'examples.yaml#/QueryAssetsAssetTypesAnyWithPagination'
+                asset_types=any & continue=EEBBD0DF-B927-411B-B771-247D4C96F9AC:
+                  $ref: 'examples.yaml#/QueryAssetsAssetTypesAnyWithPaginationContinue'
         "400":
           $ref: 'responses.yaml#/QueryAssetsBadRequestError'
         "401":

alsdkdefs/apis/assets_query/examples.yaml

@@ -314,6 +314,58 @@ QueryAssetsTopoChainFalseExample:
           key: /aws/us-east-1/subnet/subnet-01020304
           account_id: "12345678"
     rows: 7
+QueryAssetsAssetTypesAnyWithPagination:
+  value:
+    assets:
+      - - deployment_id: 1C0EFEC8-7DBE-480D-A025-ECC13DE30AD5
+          type: host
+          key: /aws/us-east-1/host/i-1234abcd1234abcd
+          account_id: "12345678"
+      - - deployment_id: 9E4B8AAB-5E07-4B46-8E07-AA16D3CA1D03
+          type: subnet
+          key: /aws/us-east-1/subnet/subnet-abcd1234
+          account_id: "12345678"
+      - - deployment_id: CD7C26C3-FAA1-4AD1-86CB-9628ED1B3327
+          type: sg
+          key: /aws/us-east-1/sg/sg-1234abcd
+          account_id: "12345678"
+      - - deployment_id: 1C0EFEC8-7DBE-480D-A025-ECC13DE30AD5
+          type: image
+          key: /aws/us-east-1/image/ami-abcdef01
+          account_id: "12345678"
+      - - deployment_id: CD7C26C3-FAA1-4AD1-86CB-9628ED1B3327
+          type: subnet
+          key: /aws/us-east-1/subnet/subnet-01020304
+          account_id: "12345678"
+    rows: 5
+    continue: EEBBD0DF-B927-411B-B771-247D4C96F9AC
+    total_assets: 14
+QueryAssetsAssetTypesAnyWithPaginationContinue:
+  value:
+    assets:
+      - - deployment_id: 1C0EFEC8-7DBE-480D-A025-ECC13DE30AD5
+          type: host
+          key: /aws/us-east-1/host/i-1234abcd1234abcd
+          account_id: "12345678"
+      - - deployment_id: 9E4B8AAB-5E07-4B46-8E07-AA16D3CA1D03
+          type: subnet
+          key: /aws/us-east-1/subnet/subnet-abcd1234
+          account_id: "12345678"
+      - - deployment_id: CD7C26C3-FAA1-4AD1-86CB-9628ED1B3327
+          type: sg
+          key: /aws/us-east-1/sg/sg-1234abcd
+          account_id: "12345678"
+      - - deployment_id: 1C0EFEC8-7DBE-480D-A025-ECC13DE30AD5
+          type: image
+          key: /aws/us-east-1/image/ami-abcdef01
+          account_id: "12345678"
+      - - deployment_id: CD7C26C3-FAA1-4AD1-86CB-9628ED1B3327
+          type: subnet
+          key: /aws/us-east-1/subnet/subnet-01020304
+          account_id: "12345678"
+    rows: 5
+    continue: C446F70F-3E5F-465D-B743-69C28D06EF90
+    total_assets: 14
 FindAssetAgentByUuidExample:
   value:
     type: agent

alsdkdefs/apis/assets_query/parameters.yaml

@@ -559,5 +559,5 @@ ParamPageSize:
   in: query
   name: page_size
   description: |-
-    The number of results to be returned, default is 50. page_size is only valid
+    The number of results to be returned, maximum is 10000. `page_size` is only valid
     on initial calls to GET assets and will have no effect on subsequent calls.

alsdkdefs/apis/assets_query/schemas.yaml

@@ -232,6 +232,16 @@ QueryAssetsResponse:
     rows:
       type: integer
       title: the number of rows in the query response
+    continue:
+      type: string
+      title: |-
+        A UUID to be used for subsequent GET assets calls to get the next set of results. 
+        Only present when there are more rows to paginate through.
+    total_assets:
+      type: integer
+      title: |-
+        The total number of rows in the assets list. 
+        Only present when there are more rows to paginate through.
   required:
     - assets
     - rows