@grafana/openapi 13.2.0-28908703397 → 13.2.0

package/dist/apis/provisioning.grafana.app-v0alpha1.json

@@ -732,6 +732,74 @@
         }
       ]
     },
+    "/connections/{name}/authorize": {
+      "post": {
+        "tags": ["Connection"],
+        "description": "Complete the OAuth authorization of this connection by exchanging an authorization code",
+        "operationId": "createConnectionAuthorize",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "description": "ConnectionAuthorizeRequest completes the OAuth authorization of a connection by exchanging an authorization code for tokens. It is the request and response body of the connection authorize subresource.",
+                "type": "object",
+                "required": ["spec"],
+                "properties": {
+                  "apiVersion": {
+                    "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+                    "type": "string"
+                  },
+                  "kind": {
+                    "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+                    "type": "string"
+                  },
+                  "metadata": {
+                    "default": {}
+                  },
+                  "spec": {
+                    "default": {}
+                  },
+                  "status": {
+                    "default": {}
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConnectionAuthorizeRequest"
+                }
+              }
+            }
+          }
+        },
+        "x-kubernetes-action": "connect",
+        "x-kubernetes-group-version-kind": {
+          "group": "provisioning.grafana.app",
+          "version": "v0alpha1",
+          "kind": "ConnectionAuthorizeRequest"
+        }
+      },
+      "parameters": [
+        {
+          "name": "name",
+          "in": "path",
+          "description": "name of the ConnectionAuthorizeRequest",
+          "required": true,
+          "schema": {
+            "type": "string",
+            "uniqueItems": true
+          }
+        }
+      ]
+    },
     "/connections/{name}/repositories": {
       "get": {
         "tags": ["Connection"],
@@ -3703,10 +3771,10 @@
       },
       "BitbucketConnectionConfig": {
         "type": "object",
-        "required": ["clientID"],
+        "required": ["workspace"],
         "properties": {
-          "clientID": {
-            "description": "App client ID",
+          "workspace": {
+            "description": "The workspace the OAuth consumer belongs to",
             "type": "string",
             "default": ""
           }
@@ -3721,6 +3789,10 @@
             "type": "string",
             "default": ""
           },
+          "email": {
+            "description": "Email is the Atlassian account email used to authenticate the Bitbucket REST API. Required to enable webhooks.",
+            "type": "string"
+          },
           "path": {
             "description": "Path is the subdirectory for the Grafana data. If specified, Grafana will ignore anything that is outside this directory in the repository. This is usually something like `grafana/`. Trailing and leading slash are not required. They are always added when needed. The path is relative to the root of the repository, regardless of the leading slash.\n\nWhen specifying something like `grafana-`, we will not look for `grafana-*`; we will only look for files under the directory `/grafana-/`. That means `/grafana-example.json` would not be found.",
             "type": "string"
@@ -3751,6 +3823,14 @@
       "CommitOptions": {
         "type": "object",
         "properties": {
+          "authorEmail": {
+            "description": "Email used as the commit author instead of the user who triggered the commit. Only valid when signingMethod is unset.",
+            "type": "string"
+          },
+          "authorName": {
+            "description": "Name used as the commit author instead of the user who triggered the commit. Only valid when signingMethod is unset.",
+            "type": "string"
+          },
           "enforceTemplate": {
             "description": "When true, the Comment field in Save drawers is pre-filled from SingleResourceMessageTemplate and rendered read-only.",
             "type": "boolean"
@@ -3759,6 +3839,10 @@
             "description": "Email used as the commit signer. Must match the signing key's identity and a verified email on the account where the matching public key is registered. When empty, defaults to \"noreply@grafana.com\".",
             "type": "string"
           },
+          "signerIsAuthor": {
+            "description": "When true, commits are authored by the signer identity (signerName/signerEmail).",
+            "type": "boolean"
+          },
           "signerName": {
             "description": "Name used as the commit signer. Required for the signing key's identity to match the commit, which providers need to mark commits as Verified. When empty, defaults to \"Grafana\".",
             "type": "string"
@@ -3831,6 +3915,78 @@
           }
         ]
       },
+      "ConnectionAuthorizeRequest": {
+        "description": "ConnectionAuthorizeRequest completes the OAuth authorization of a connection by exchanging an authorization code for tokens. It is the request and response body of the connection authorize subresource.",
+        "type": "object",
+        "required": ["spec"],
+        "properties": {
+          "apiVersion": {
+            "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+            "type": "string"
+          },
+          "kind": {
+            "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+            "type": "string"
+          },
+          "metadata": {
+            "default": {},
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ObjectMeta"
+              }
+            ]
+          },
+          "spec": {
+            "default": {},
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ConnectionAuthorizeRequestSpec"
+              }
+            ]
+          },
+          "status": {
+            "default": {},
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ConnectionAuthorizeRequestStatus"
+              }
+            ]
+          }
+        },
+        "x-kubernetes-group-version-kind": [
+          {
+            "group": "provisioning.grafana.app",
+            "kind": "ConnectionAuthorizeRequest",
+            "version": "v0alpha1"
+          }
+        ]
+      },
+      "ConnectionAuthorizeRequestSpec": {
+        "type": "object",
+        "required": ["code"],
+        "properties": {
+          "code": {
+            "description": "The authorization code returned by the provider",
+            "type": "string",
+            "default": ""
+          },
+          "redirectURI": {
+            "description": "The redirect URI used in the authorization request",
+            "type": "string"
+          }
+        }
+      },
+      "ConnectionAuthorizeRequestStatus": {
+        "type": "object",
+        "required": ["authorized"],
+        "properties": {
+          "authorized": {
+            "description": "Whether the connection has been authorized",
+            "type": "boolean",
+            "default": false
+          }
+        }
+      },
       "ConnectionInfo": {
         "type": "object",
         "required": ["name"],
@@ -3882,6 +4038,17 @@
           }
         ]
       },
+      "ConnectionOAuthConfig": {
+        "type": "object",
+        "required": ["clientID"],
+        "properties": {
+          "clientID": {
+            "description": "The OAuth app client ID",
+            "type": "string",
+            "default": ""
+          }
+        }
+      },
       "ConnectionSecure": {
         "type": "object",
         "properties": {
@@ -3946,11 +4113,11 @@
               }
             ]
           },
-          "gitlab": {
-            "description": "Gitlab connection configuration Only applicable when provider is \"gitlab\"",
+          "oauth": {
+            "description": "OAuth app configuration shared by all OAuth app providers",
             "allOf": [
               {
-                "$ref": "#/components/schemas/GitlabConnectionConfig"
+                "$ref": "#/components/schemas/ConnectionOAuthConfig"
               }
             ]
           },
@@ -4027,6 +4194,15 @@
             "type": "integer",
             "format": "int64",
             "default": 0
+          },
+          "token": {
+            "description": "Token holds metadata about the last generated connection token, used to avoid regenerating a token whose secret was written recently but is not yet readable.",
+            "default": {},
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TokenStatus"
+              }
+            ]
           }
         }
       },
@@ -4300,10 +4476,6 @@
             "type": "string",
             "default": ""
           },
-          "generateDashboardPreviews": {
-            "description": "Whether we should show dashboard previews for pull requests.",
-            "type": "boolean"
-          },
           "path": {
             "description": "Path is the subdirectory for the Grafana data inside the repository.",
             "type": "string"
@@ -4383,17 +4555,6 @@
           }
         }
       },
-      "GitlabConnectionConfig": {
-        "type": "object",
-        "required": ["clientID"],
-        "properties": {
-          "clientID": {
-            "description": "App client ID",
-            "type": "string",
-            "default": ""
-          }
-        }
-      },
       "HealthStatus": {
         "type": "object",
         "required": ["healthy"],
@@ -4683,6 +4844,11 @@
             "type": "integer",
             "format": "int64"
           },
+          "totalChanges": {
+            "description": "TotalChanges is the action-aware count of resources changed for this group/kind, set by the progress recorder as results are recorded. Used for the job-duration histogram's resources_changed bucket.",
+            "type": "integer",
+            "format": "int64"
+          },
           "update": {
             "type": "integer",
             "format": "int64"
@@ -4710,7 +4876,7 @@
         "required": ["action"],
         "properties": {
           "action": {
-            "description": "Possible enum values:\n - `\"delete\"` deletes files in the remote repository\n - `\"deleteResources\"` deletes all resources managed by a repository that no longer exists or is stuck in Terminating state. This action has inverted validation: it is only allowed when the repository does not exist or has a DeletionTimestamp set.\n - `\"fixFolderMetadata\"` is a placeholder job that will eventually regenerate folder metadata files. Currently a no-op to unblock frontend development.\n - `\"migrate\"` acts like JobActionExport, then JobActionPull. It also tries to preserve the history.\n - `\"move\"` moves files in the remote repository\n - `\"pr\"` adds additional useful information to a PR, such as comments with preview links and rendered images.\n - `\"pull\"` replicates the remote branch in the local copy of the repository.\n - `\"push\"` replicates the local copy of the repository in the remote branch.\n - `\"releaseResources\"` removes ownership annotations from all resources managed by a repository that no longer exists or is stuck in Terminating state. Resources remain in Grafana but become unmanaged. This action has inverted validation: it is only allowed when the repository does not exist or has a DeletionTimestamp set.",
+            "description": "Possible enum values:\n - `\"delete\"` deletes files in the remote repository\n - `\"deleteResources\"` deletes all resources managed by a repository that no longer exists or is stuck in Terminating state. This action has inverted validation: it is only allowed when the repository does not exist or has a DeletionTimestamp set.\n - `\"fixFolderMetadata\"` is a placeholder job that will eventually regenerate folder metadata files. Currently a no-op to unblock frontend development.\n - `\"migrate\"` acts like JobActionExport, then JobActionPull. It also tries to preserve the history.\n - `\"move\"` moves files in the remote repository\n - `\"pr\"` adds additional useful information to a PR, such as comments with preview links and rendered images.\n - `\"pull\"` replicates the remote branch in the local copy of the repository.\n - `\"push\"` replicates the local copy of the repository in the remote branch.\n - `\"releaseResources\"` removes ownership annotations from all resources managed by a repository that no longer exists or is stuck in Terminating state. Resources remain in Grafana but become unmanaged. This action has inverted validation: it is only allowed when the repository does not exist or has a DeletionTimestamp set.\n - `\"test\"` is a synthetic job that does no real work: it simply sleeps for a configurable duration and then completes successfully. It exists only to generate controlled load on the job queue and controllers for performance testing, and is gated behind the provisioning.performance feature flag.",
             "type": "string",
             "default": "",
             "enum": [
@@ -4722,7 +4888,8 @@
               "pr",
               "pull",
               "push",
-              "releaseResources"
+              "releaseResources",
+              "test"
             ]
           },
           "delete": {
@@ -4788,6 +4955,14 @@
           "repository": {
             "description": "The the repository reference (for now also in labels) This value is required, but will be popuplated from the job making the request",
             "type": "string"
+          },
+          "test": {
+            "description": "Required when the action is `test`",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TestJobOptions"
+              }
+            ]
           }
         }
       },
@@ -4814,6 +4989,11 @@
             "type": "number",
             "format": "double"
           },
+          "progressUpdates": {
+            "description": "ProgressUpdates is the number of times the job's status has been written while it was processed. It is carried over to the historic job so the total number of progress updates a job went through remains observable after completion.",
+            "type": "integer",
+            "format": "int64"
+          },
           "started": {
             "type": "integer",
             "format": "int64"
@@ -4883,6 +5063,10 @@
       "MigrateJobOptions": {
         "type": "object",
         "properties": {
+          "branch": {
+            "description": "Target branch for the migration (git only). When set to a branch other than the repository's configured branch, the migration writes the exported resources to that branch (a pull request workflow) and removes the migrated resources from the instance instead of taking ownership of them — they return as managed resources once the branch is merged and a regular sync runs on the configured branch. When empty (or equal to the configured branch), the migration writes directly to the configured branch and takes ownership of the exported resources.",
+            "type": "string"
+          },
           "generateNewFolderIDs": {
             "description": "GenerateNewFolderIDs writes a freshly generated identifier into each exported folder's metadata (_folder.json) instead of preserving the existing folder UID. The subsequent pull creates new folders rather than taking over the originals. Has no effect when folder metadata is not written.",
             "type": "boolean"
@@ -4902,6 +5086,10 @@
                 }
               ]
             }
+          },
+          "skipResourceDeletion": {
+            "description": "SkipResourceDeletion keeps the migrated resources on the instance instead of removing them. By default a migration deletes the resources it moved (the whole namespace for an instance target, or the exported resources for a branch migration); when true, no deletion happens and the resources are left in place.",
+            "type": "boolean"
           }
         }
       },
@@ -4967,6 +5155,10 @@
             "description": "When true, the PR title field in Save drawers is read-only.",
             "type": "boolean"
           },
+          "generateDashboardPreviews": {
+            "description": "Whether we should show dashboard previews for pull requests. By default, this is false (i.e. we will not create previews).",
+            "type": "boolean"
+          },
           "titleTemplate": {
             "description": "Template for pull request titles. Supports the same variables as BranchOptions.NameTemplate ({{random}} is available but rarely useful here). When empty, the first line of the commit message is used.",
             "type": "string"
@@ -6017,6 +6209,25 @@
           }
         }
       },
+      "TestJobOptions": {
+        "description": "TestJobOptions configures a synthetic performance-testing job. The job does no real work; it sleeps for Duration and then completes. It is only usable when the provisioning.performance feature flag is enabled.",
+        "type": "object",
+        "properties": {
+          "duration": {
+            "description": "Duration is how long the job should sleep before completing, expressed as a Go duration string (for example \"10s\" or \"2m\"). It must be positive and is capped by the server to keep a single job's runtime predictable.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/Duration"
+              }
+            ]
+          },
+          "progressUpdates": {
+            "description": "ProgressUpdates controls how many progress notifications the job emits while running. A value of 0 uses the server default.",
+            "type": "integer",
+            "format": "int32"
+          }
+        }
+      },
       "TestResults": {
         "description": "TestResults is the result of a test connection operation Deprecated: this will go way when we deprecate the test endpoint We should use fieldErrors from status instead.",
         "type": "object",
@@ -6149,6 +6360,9 @@
           },
           "url": {
             "type": "string"
+          },
+          "uuid": {
+            "type": "string"
           }
         }
       },
@@ -6380,6 +6594,10 @@
           }
         }
       },
+      "Duration": {
+        "description": "Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.",
+        "type": "string"
+      },
       "FieldsV1": {
         "description": "FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.\n\nEach key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of  a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.\n\nThe exact format is defined in sigs.k8s.io/structured-merge-diff",
         "type": "object"