@kyverno/backstage-plugin-policy-reporter-backend 2.5.0 → 2.7.0

package/dist/schema/openapi/generated/router.cjs.js

@@ -193,7 +193,17 @@ const spec = {
             }
           },
           "400": {
-            description: "Bad request - invalid entityRef or missing annotation",
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
             content: {
               "application/json": {
                 schema: {
@@ -211,15 +221,119 @@ const spec = {
                 }
               }
             }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
           }
         }
       }
     },
-    "/v1/namespaces": {
+    "/v1/namespaced-resources/sources": {
       get: {
-        summary: "Get namespaces",
-        description: "Retrieves a list of namespaces from the policies",
-        operationId: "getNamespaces",
+        summary: "Get sources",
+        description: "List of all Sources with namespace scoped results",
+        operationId: "getSources",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of sources",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/kinds": {
+      get: {
+        summary: "Get kinds",
+        description: "List of all Kubernetes resource kinds with namespace scoped results",
+        operationId: "getKinds",
         parameters: [
           {
             name: "environment",
@@ -245,9 +359,106 @@ const spec = {
             explode: true
           },
           {
-            name: "categories",
+            name: "namespaces",
             in: "query",
-            description: "Filter by a list of categories",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of kinds",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/categories": {
+      get: {
+        summary: "Get categories",
+        description: "List of all Categories with namespace scoped results",
+        operationId: "getCategories",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
             schema: {
               type: "array",
               items: {
@@ -258,9 +469,9 @@ const spec = {
             explode: true
           },
           {
-            name: "policies",
+            name: "namespaces",
             in: "query",
-            description: "Filter by a list of policies",
+            description: "Filter by a list of namespaces",
             schema: {
               type: "array",
               items: {
@@ -273,7 +484,7 @@ const spec = {
         ],
         responses: {
           "200": {
-            description: "List of namespaces",
+            description: "List of categories",
             content: {
               "application/json": {
                 schema: {
@@ -286,7 +497,17 @@ const spec = {
             }
           },
           "400": {
-            description: "Bad request - invalid entityRef or missing annotation",
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
             content: {
               "application/json": {
                 schema: {
@@ -304,6 +525,882 @@ const spec = {
                 }
               }
             }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaces": {
+      get: {
+        summary: "Get namespaces",
+        description: "Retrieves a list of namespaces from the policies",
+        operationId: "getNamespaces",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "categories",
+            in: "query",
+            description: "Filter by a list of categories",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "policies",
+            in: "query",
+            description: "Filter by a list of policies",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of namespaces",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/namespaced-resources/policies": {
+      get: {
+        summary: "Get policies with namespaced policy results",
+        description: "List of all Policies with namespace scoped results",
+        operationId: "getPolicies",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "namespaces",
+            in: "query",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "categories",
+            in: "query",
+            description: "Filter by a list of categories",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of policies",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error - failed to fetch policies",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/cluster-resources/sources": {
+      get: {
+        summary: "Get cluster sources",
+        description: "List of all Sources with cluster scoped results",
+        operationId: "getClusterSources",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of sources",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/cluster-resources/kinds": {
+      get: {
+        summary: "Get cluster kinds",
+        description: "List of all Kubernetes resource kinds with cluster scoped results",
+        operationId: "getClusterKinds",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "namespaces",
+            in: "query",
+            description: "Filter by a list of namespaces",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of kinds",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/cluster-resources/categories": {
+      get: {
+        summary: "Get cluster categories",
+        description: "List of all Categories with cluster scoped results",
+        operationId: "getClusterCategories",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of categories",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/cluster-resources/policies": {
+      get: {
+        summary: "Get cluster policies",
+        description: "List of all Policies with cluster scoped results",
+        operationId: "getClusterPolicies",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "categories",
+            in: "query",
+            description: "Filter by a list of categories",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          }
+        ],
+        responses: {
+          "200": {
+            description: "List of policies",
+            content: {
+              "application/json": {
+                schema: {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error - failed to fetch policies",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/v1/cluster-resources/results": {
+      get: {
+        summary: "Get cluster policy results",
+        description: "Retrieves policy results for a specific environment with optional filtering and pagination",
+        operationId: "getClusterResults",
+        parameters: [
+          {
+            name: "environment",
+            in: "query",
+            required: true,
+            description: "The environment entity reference (URL encoded)",
+            schema: {
+              type: "string",
+              example: "default/component/my-service"
+            }
+          },
+          {
+            name: "sources",
+            in: "query",
+            description: "Filter by a list of sources",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "kinds",
+            in: "query",
+            description: "Filter by a list of Kubernetes resource kinds",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "categories",
+            in: "query",
+            description: "Filter by a list of categories",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "policies",
+            in: "query",
+            description: "Filter by a list of policies",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "status",
+            in: "query",
+            description: "Filter by policy result status",
+            schema: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Status"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "severities",
+            in: "query",
+            description: "Filter by severity levels",
+            schema: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Severity"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "search",
+            in: "query",
+            description: "Search string to filter results",
+            schema: {
+              type: "string"
+            }
+          },
+          {
+            name: "labels",
+            in: "query",
+            description: "Filter by label-value pairs",
+            schema: {
+              type: "array",
+              items: {
+                type: "string"
+              }
+            },
+            style: "form",
+            explode: true
+          },
+          {
+            name: "page",
+            in: "query",
+            description: "Requested list page number",
+            schema: {
+              type: "integer",
+              minimum: 1,
+              default: 1
+            }
+          },
+          {
+            name: "offset",
+            in: "query",
+            description: "Number of results per page",
+            schema: {
+              type: "integer",
+              minimum: 1,
+              maximum: 100,
+              default: 20
+            }
+          },
+          {
+            name: "direction",
+            in: "query",
+            description: "Sort direction for results",
+            schema: {
+              $ref: "#/components/schemas/Direction"
+            }
+          }
+        ],
+        responses: {
+          "200": {
+            description: "Policy results retrieved successfully",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/ResultList"
+                }
+              }
+            }
+          },
+          "400": {
+            description: "Bad request - environment entity missing required annotations",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "404": {
+            description: "Not Found - environment entity not found in the catalog",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "500": {
+            description: "Internal server error - failed to fetch policies",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "502": {
+            description: "Bad Gateway",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
+          },
+          "503": {
+            description: "Service Unavailable",
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/RequestError"
+                }
+              }
+            }
           }
         }
       }