Add get-package-stats spec for /epm/packages/{pkgName}/stats endpoint

elastic · Jul 22, 2021 · 7d98448 · 7d98448
1 parent a974371
commit 7d98448
Show file tree

Hide file tree

Showing 5 changed files with 120 additions and 0 deletions.
diff --git a/x-pack/plugins/fleet/common/openapi/bundled.json b/x-pack/plugins/fleet/common/openapi/bundled.json
@@ -1643,6 +1643,48 @@
           }
         ]
       }
+    },
+    "/epm/packages/{pkgName}/stats": {
+      "get": {
+        "summary": "Get stats for a package",
+        "tags": [],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "response": {
+                      "$ref": "#/components/schemas/package_usage_stats"
+                    }
+                  },
+                  "required": [
+                    "response"
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "operationId": "get-package-stats",
+        "security": [
+          {
+            "basicAuth": []
+          }
+        ]
+      },
+      "parameters": [
+        {
+          "schema": {
+            "type": "string"
+          },
+          "name": "pkgName",
+          "in": "path",
+          "required": true
+        }
+      ]
     }
   },
   "components": {
@@ -2389,6 +2431,18 @@
             "$ref": "#/components/schemas/new_package_policy"
           }
         ]
+      },
+      "package_usage_stats": {
+        "title": "Package usage stats",
+        "type": "object",
+        "properties": {
+          "agent_policy_count": {
+            "type": "integer"
+          }
+        },
+        "required": [
+          "agent_policy_count"
+        ]
       }
     }
   },

diff --git a/x-pack/plugins/fleet/common/openapi/bundled.yaml b/x-pack/plugins/fleet/common/openapi/bundled.yaml
@@ -996,6 +996,31 @@ paths:
                   - sucess
       parameters:
         - $ref: '#/components/parameters/kbn_xsrf'
+  '/epm/packages/{pkgName}/stats':
+    get:
+      summary: Get stats for a package
+      tags: []
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  response:
+                    $ref: '#/components/schemas/package_usage_stats'
+                required:
+                  - response
+      operationId: get-package-stats
+      security:
+        - basicAuth: []
+    parameters:
+      - schema:
+          type: string
+        name: pkgName
+        in: path
+        required: true
 components:
   securitySchemes:
     basicAuth:
@@ -1502,5 +1527,13 @@ components:
             version:
               type: string
         - $ref: '#/components/schemas/new_package_policy'
+    package_usage_stats:
+      title: Package usage stats
+      type: object
+      properties:
+        agent_policy_count:
+          type: integer
+      required:
+        - agent_policy_count
 security:
   - basicAuth: []
diff --git a/x-pack/plugins/fleet/common/openapi/components/schemas/package_usage_stats.yaml b/x-pack/plugins/fleet/common/openapi/components/schemas/package_usage_stats.yaml
@@ -0,0 +1,7 @@
+title: Package usage stats
+type: object
+properties:
+  agent_policy_count:
+    type: integer
+required:
+  - agent_policy_count
diff --git a/x-pack/plugins/fleet/common/openapi/entrypoint.yaml b/x-pack/plugins/fleet/common/openapi/entrypoint.yaml
@@ -62,6 +62,8 @@ paths:
     $ref: paths/package_policies@delete.yaml
   '/package_policies/{packagePolicyId}':
     $ref: 'paths/package_policies@{package_policy_id}.yaml'
+  '/epm/packages/{pkgName}/stats':
+    $ref: 'paths/epm@packages@{pkg_name}@stats.yaml'
 components:
   securitySchemes:
     basicAuth:

diff --git a/x-pack/plugins/fleet/common/openapi/paths/epm@packages@{pkg_name}@stats.yaml b/x-pack/plugins/fleet/common/openapi/paths/epm@packages@{pkg_name}@stats.yaml
@@ -0,0 +1,24 @@
+get:
+  summary: Get stats for a package
+  tags: []
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              response:
+                $ref: ../components/schemas/package_usage_stats.yaml
+            required:
+              - response
+  operationId: get-package-stats
+  security:
+    - basicAuth: []
+parameters:
+  - schema:
+      type: string
+    name: pkgName
+    in: path
+    required: true