chore: update api docs

SpecterOps · Feb 12, 2024 · daac6fe · daac6fe
1 parent d730521
commit daac6fe
Show file tree

Hide file tree

Showing 2 changed files with 103 additions and 0 deletions.
diff --git a/cmd/api/src/docs/json/definitions/v2.json b/cmd/api/src/docs/json/definitions/v2.json
@@ -76,6 +76,24 @@
       }
     }
   },
+  "v2.ListAssetGroupMembersCountResponse": {
+        "properties": {
+            "data": {
+                "type": "object",
+                "properties": {
+                    "total_count": {
+                        "type": "integer"
+                    },
+                    "counts": {
+                        "type": "object",
+                        "items": {
+                            "type": "integer"
+                        }
+                    }
+                }
+            }
+        }
+    },
   "v2.CreateAssetGroupSelectorResponse": {
     "properties": {
       "data": {

diff --git a/cmd/api/src/docs/json/paths/v2/asset-isolation.json b/cmd/api/src/docs/json/paths/v2/asset-isolation.json
@@ -603,5 +603,90 @@
                 }
             }
         }
+    },
+    "/api/v2/asset-groups/{asset_group_id}/members/count": {
+        "parameters": [
+            {
+                "type": "integer",
+                "description": "Asset group ID",
+                "name": "asset_group_id",
+                "in": "path",
+                "required": true
+            }
+        ],
+        "get": {
+            "description": "List counts of members of an asset isolation group by primary kind",
+            "consumes": [
+                "application/json"
+            ],
+            "tags": [
+                "Asset Isolation",
+                "Community",
+                "Enterprise"
+            ],
+            "summary": "List counts of members of an asset isolation group by primary kind",
+            "parameters": [
+                {
+                    "$ref": "#/definitions/parameters.PreferHeader"
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "object_id",
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "environment_id",
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "domainsid",
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "environment_kind",
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "name",
+                    "in": "query",
+                    "required": false
+                },
+                {
+                    "type": "string",
+                    "description": "Filter results by column value. Valid filter predicates are eq, neq",
+                    "name": "custom_member",
+                    "in": "query",
+                    "required": false
+                }
+            ],
+            "responses": {
+                "200": {
+                    "description": "OK",
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/definitions/v2.ListAssetGroupMembersCountResponse"
+                            }
+                        }
+                    }
+                },
+                "Error": {
+                    "$ref": "#/components/responses/defaultError"
+                }
+            }
+        }
     }
     }