Definitions Update assets_query

Author: cibot

alsdkdefs/apis/assets_query/assets_query.v1.yaml

@@ -2196,6 +2196,66 @@ paths:
           $ref: 'responses.yaml#/UnavailableError'
       security:
         - x-aims-auth-token: []
+  /assets_query/v1/asset_types:
+    get:
+      summary: Get Asset Types Schema
+      tags:
+        - Queries
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: schemas.yaml#/AssetTypesSchemaResponse
+              examples:
+                Exposures Summary for Deployment Example:
+                  $ref: examples.yaml#/AssetTypesSchemaResponseExample
+      operationId: asset_types_schemas
+      parameters:
+        - schema:
+            type: string
+          in: query
+          name: filter
+          description: 'Filters that asset types must match to be included eg. `groupable`, `taggable`, `vulnerable`, etc...'
+        - schema:
+            type: string
+          in: query
+          name: fields
+          description: 'A csv string of the fields that should be returned for an asset type. Note: if the asset type does not contain that field it will not be in the return value.'
+        - schema:
+            type: string
+            enum:
+              - list
+              - topology
+          in: query
+          name: format
+          description: 'Returns the asset types as a list of schema objects (list) or as a list of topological schemas'
+      description: Fetches the `"schema"` for asset types. The schema describes the structure for asset types.
+    parameters: [ ]
+  '/assets_query/v1/asset_types/{asset_type}':
+    get:
+      summary: Get Asset Type Schema
+      tags:
+        - Queries
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: schemas.yaml#/AssetTypeSchemaResponse
+              examples:
+                Exposures Summary for Deployment Example:
+                  $ref: examples.yaml#/AssetTypeSchemaResponseExample
+      operationId: asset_type_schema
+      description: 'fetch the schema of an asset type'
+    parameters:
+      - schema:
+          type: string
+        name: asset_type
+        in: path
+        required: true
 components:
   securitySchemes:
     x-aims-auth-token:

alsdkdefs/apis/assets_query/examples.yaml

@@ -4381,3 +4381,168 @@ ListAssetGroupsExample:
       criticality: 1
       created_on: 1600724524178
     count: 2
+AssetTypesSchemaResponseExample:
+  value:
+    count: 38
+    asset_types:
+      - groupable: true
+        asset_type: acl
+        aliases: [ ]
+      - groupable: false
+        asset_type: acl-entry
+        aliases: [ ]
+      - groupable: false
+        asset_type: application
+        aliases: [ ]
+      - groupable: false
+        asset_type: auto-scaling-group
+        aliases:
+          - vm-scale-set
+      - groupable: false
+        asset_type: cgw
+        aliases: [ ]
+      - groupable: true
+        asset_type: cloud-trail
+        aliases: [ ]
+      - groupable: false
+        asset_type: container
+        aliases: [ ]
+      - groupable: true
+        asset_type: db-instance
+        aliases: [ ]
+      - groupable: false
+        asset_type: db-subnet-group
+        aliases: [ ]
+      - groupable: true
+        asset_type: dns-zone
+        aliases: [ ]
+      - groupable: false
+        asset_type: group
+        aliases: [ ]
+      - groupable: true
+        asset_type: host
+        aliases:
+          - vm
+      - groupable: true
+        asset_type: igw
+        aliases: [ ]
+      - groupable: true
+        asset_type: image
+        aliases: [ ]
+      - groupable: true
+        asset_type: instance-profile
+        aliases: [ ]
+      - groupable: true
+        asset_type: key-vault-key
+        aliases: [ ]
+      - groupable: true
+        asset_type: kms-key
+        aliases: [ ]
+      - groupable: false
+        asset_type: launch-config
+        aliases: [ ]
+      - groupable: false
+        asset_type: listener
+        aliases: [ ]
+      - groupable: true
+        asset_type: load-balancer
+        aliases: [ ]
+      - groupable: false
+        asset_type: network-interface
+        aliases: [ ]
+      - groupable: true
+        asset_type: nsg
+        aliases: [ ]
+      - groupable: false
+        asset_type: policy
+        aliases: [ ]
+      - groupable: true
+        asset_type: redshift-cluster
+        aliases: [ ]
+      - groupable: false
+        asset_type: remediation
+        aliases: [ ]
+      - groupable: false
+        asset_type: remediation-item
+        aliases: [ ]
+      - groupable: true
+        asset_type: role
+        aliases: [ ]
+      - groupable: true
+        asset_type: route
+        aliases: [ ]
+      - groupable: true
+        asset_type: s3-bucket
+        aliases: [ ]
+      - groupable: true
+        asset_type: sg
+        aliases: [ ]
+      - groupable: true
+        asset_type: subnet
+        aliases: [ ]
+      - groupable: true
+        asset_type: user
+        aliases: [ ]
+      - groupable: false
+        asset_type: vgw
+        aliases: [ ]
+      - groupable: true
+        asset_type: volume
+        aliases:
+          - disk
+      - groupable: true
+        asset_type: vpc
+        aliases:
+          - vnet
+          - network
+      - groupable: false
+        asset_type: vpnconn
+        aliases: [ ]
+      - groupable: false
+        asset_type: vulnerability
+        aliases: [ ]
+      - groupable: false
+        asset_type: zone
+        aliases: [ ]
+
+AssetTypeSchemaResponseExample:
+  value:
+    aliases: [ ]
+    always_create: false
+    always_in_scope: false
+    asset_type: acl
+    custom_properties: [ ]
+    groupable: true
+    name_property:
+      - network_acl_id
+    notify_delta_properties: [ ]
+    promoted_properties:
+      scope_aws_:
+        network_acl_id: string
+        acl_name: string
+    relationships:
+      vulnerability:
+        - HAS_VULNERABILITY
+      vpc:
+        - CONTAINS
+      tag:
+        - HAS_TAG
+      region:
+        - IN_REGION
+      assessment-spec:
+        - HAS_ASSESSMENT_SPEC
+      acl-entry:
+        - HAS_ACL_ENTRY
+    scope_container: vpc
+    taggable: true
+    topological_ancestors:
+      - deployment
+      - region
+      - vpc
+    topological_children: [ ]
+    topological_parent: vpc
+    topological_successor_paths: [ ]
+    topological_successors: { }
+    topological_successors_list: [ ]
+    unscoped_properties: [ ]
+    vulnerable: true

alsdkdefs/apis/assets_query/schemas.yaml

@@ -665,3 +665,21 @@ ListAssetGroupsResponse:
     count:
       type: integer
       description: The count of `groups` in the response.
+AssetTypesSchemaResponse:
+  title: Asset Types Schema Response
+  type: object
+  properties:
+    assetTypes:
+      title: A list of schemas or a single schema
+      oneOf:
+        - type: array
+          items:
+            type: object
+        - type: object
+    count:
+      type: number
+
+AssetTypeSchemaResponse:
+  title: Asset Type Schema Response
+  type: object
+