mirror of https://github.com/grafana/grafana
prometheushacktoberfestmetricsmonitoringalertinggrafanagoinfluxdbmysqlpostgresanalyticsdata-visualizationdashboardbusiness-intelligenceelasticsearch
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4498 lines
190 KiB
4498 lines
190 KiB
{
|
|
"openapi": "3.0.0",
|
|
"info": {
|
|
"description": "Provisioning",
|
|
"title": "provisioning.grafana.app/v0alpha1"
|
|
},
|
|
"paths": {
|
|
"/apis/provisioning.grafana.app/v0alpha1/": {
|
|
"get": {
|
|
"tags": [
|
|
"API Discovery"
|
|
],
|
|
"description": "Describe the available kubernetes resources",
|
|
"operationId": "getAPIResources",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/jobs": {
|
|
"get": {
|
|
"tags": [
|
|
"Job"
|
|
],
|
|
"description": "list or watch objects of kind Job",
|
|
"operationId": "listJob",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList"
|
|
}
|
|
},
|
|
"application/json;stream=watch": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf;stream=watch": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "list",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Job"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "allowWatchBookmarks",
|
|
"in": "query",
|
|
"description": "allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "continue",
|
|
"in": "query",
|
|
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "labelSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "pretty",
|
|
"in": "query",
|
|
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersion",
|
|
"in": "query",
|
|
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersionMatch",
|
|
"in": "query",
|
|
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "sendInitialEvents",
|
|
"in": "query",
|
|
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "timeoutSeconds",
|
|
"in": "query",
|
|
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "watch",
|
|
"in": "query",
|
|
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/jobs/{name}": {
|
|
"get": {
|
|
"tags": [
|
|
"Job"
|
|
],
|
|
"description": "read the specified Job",
|
|
"operationId": "getJob",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "get",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Job"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Job",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "pretty",
|
|
"in": "query",
|
|
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "list or watch objects of kind Repository",
|
|
"operationId": "listRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "allowWatchBookmarks",
|
|
"in": "query",
|
|
"description": "allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "continue",
|
|
"in": "query",
|
|
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "labelSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersion",
|
|
"in": "query",
|
|
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersionMatch",
|
|
"in": "query",
|
|
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "sendInitialEvents",
|
|
"in": "query",
|
|
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "timeoutSeconds",
|
|
"in": "query",
|
|
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "watch",
|
|
"in": "query",
|
|
"description": "Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList"
|
|
}
|
|
},
|
|
"application/json;stream=watch": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf;stream=watch": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "list",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "create a Repository",
|
|
"operationId": "createRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldManager",
|
|
"in": "query",
|
|
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldValidation",
|
|
"in": "query",
|
|
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Accepted",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "post",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "delete collection of Repository",
|
|
"operationId": "deletecollectionRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "continue",
|
|
"in": "query",
|
|
"description": "The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their fields. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "gracePeriodSeconds",
|
|
"in": "query",
|
|
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "ignoreStoreReadErrorWithClusterBreakingPotential",
|
|
"in": "query",
|
|
"description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "labelSelector",
|
|
"in": "query",
|
|
"description": "A selector to restrict the list of returned objects by their labels. Defaults to everything.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "orphanDependents",
|
|
"in": "query",
|
|
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "propagationPolicy",
|
|
"in": "query",
|
|
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersion",
|
|
"in": "query",
|
|
"description": "resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "resourceVersionMatch",
|
|
"in": "query",
|
|
"description": "resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "sendInitialEvents",
|
|
"in": "query",
|
|
"description": "`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "timeoutSeconds",
|
|
"in": "query",
|
|
"description": "Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "deletecollection",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "pretty",
|
|
"in": "query",
|
|
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "read the specified Repository",
|
|
"operationId": "getRepository",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "get",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "replace the specified Repository",
|
|
"operationId": "replaceRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldManager",
|
|
"in": "query",
|
|
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldValidation",
|
|
"in": "query",
|
|
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "put",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "delete a Repository",
|
|
"operationId": "deleteRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "gracePeriodSeconds",
|
|
"in": "query",
|
|
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
|
|
"schema": {
|
|
"type": "integer",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "ignoreStoreReadErrorWithClusterBreakingPotential",
|
|
"in": "query",
|
|
"description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "orphanDependents",
|
|
"in": "query",
|
|
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "propagationPolicy",
|
|
"in": "query",
|
|
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"202": {
|
|
"description": "Accepted",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Status"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "delete",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "partially update the specified Repository",
|
|
"operationId": "updateRepository",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldManager",
|
|
"in": "query",
|
|
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldValidation",
|
|
"in": "query",
|
|
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "force",
|
|
"in": "query",
|
|
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/apply-patch+yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/json-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/merge-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/strategic-merge-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "patch",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Repository",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "pretty",
|
|
"in": "query",
|
|
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/export": {
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Export from grafana into the remote repository",
|
|
"operationId": "createRepositoryExport",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"identifier"
|
|
],
|
|
"properties": {
|
|
"branch": {
|
|
"description": "Target branch for export (only git)",
|
|
"type": "string"
|
|
},
|
|
"folder": {
|
|
"description": "The source folder (or empty) to export",
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"description": "Include the identifier in the exported metadata",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"prefix": {
|
|
"description": "Prefix in target file system",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"example": {
|
|
"folder": "grafan-folder-ref",
|
|
"branch": "target-branch",
|
|
"prefix": "prefix/in/repo/tree",
|
|
"identifier": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Job"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Job",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/files/": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"summary": "File listing",
|
|
"description": "Get the files and content hash",
|
|
"operationId": "getRepositoryFiles",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"description": "Information we can get just from the file listing",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {}
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceWrapper"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the ResourceWrapper",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/files/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Read value from upstream repository",
|
|
"operationId": "getRepositoryFilesWithPath",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceWrapper"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceWrapper"
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "connect PUT requests to files of Repository",
|
|
"operationId": "replaceRepositoryFilesWithPath",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "message",
|
|
"in": "query",
|
|
"description": "optional message sent with any changes",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"examples": {
|
|
"dashboard": {
|
|
"value": {
|
|
"spec": {
|
|
"hello": "dashboard"
|
|
}
|
|
}
|
|
},
|
|
"playlist": {
|
|
"value": {
|
|
"spec": {
|
|
"hello": "playlist"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"application/x-yaml": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"examples": {
|
|
"dashboard": {
|
|
"value": "apiVersion: dashboards.grafana.app/v0alpha1\nkind: Dashboard\nspec:\n title: Sample dashboard\n"
|
|
},
|
|
"playlist": {
|
|
"value": "apiVersion: playlist.grafana.app/v0alpha1\nkind: Playlist\nspec:\n title: Playlist from provisioning\n interval: 5m\n items:\n - type: dashboard_by_tag\n value: panel-tests\n"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceWrapper"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceWrapper"
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "connect POST requests to files of Repository",
|
|
"operationId": "createRepositoryFilesWithPath",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "message",
|
|
"in": "query",
|
|
"description": "optional message sent with any changes",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"examples": {
|
|
"dashboard": {
|
|
"value": {
|
|
"spec": {
|
|
"hello": "dashboard"
|
|
}
|
|
}
|
|
},
|
|
"playlist": {
|
|
"value": {
|
|
"spec": {
|
|
"hello": "playlist"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"application/x-yaml": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"examples": {
|
|
"dashboard": {
|
|
"value": "apiVersion: dashboards.grafana.app/v0alpha1\nkind: Dashboard\nspec:\n title: Sample dashboard\n"
|
|
},
|
|
"playlist": {
|
|
"value": "apiVersion: playlist.grafana.app/v0alpha1\nkind: Playlist\nspec:\n title: Playlist from provisioning\n interval: 5m\n items:\n - type: dashboard_by_tag\n value: panel-tests\n"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceWrapper"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceWrapper"
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "connect DELETE requests to files of Repository",
|
|
"operationId": "deleteRepositoryFilesWithPath",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "message",
|
|
"in": "query",
|
|
"description": "optional message sent with any changes",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceWrapper"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceWrapper"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the ResourceWrapper",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"description": "path to the resource",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/history": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Get the history of the repository",
|
|
"operationId": "getRepositoryHistory",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "HistoryList"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the HistoryList",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/history/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Get the history of a path",
|
|
"operationId": "getRepositoryHistoryWithPath",
|
|
"parameters": [
|
|
{
|
|
"name": "ref",
|
|
"in": "query",
|
|
"description": "branch or commit hash",
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"examples": {
|
|
"": {
|
|
"summary": "The default"
|
|
},
|
|
"branch": {
|
|
"summary": "Select branch",
|
|
"value": "my-branch"
|
|
},
|
|
"commit": {
|
|
"summary": "Commit hash (or prefix)",
|
|
"value": "7f7cc2153"
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "HistoryList"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the HistoryList",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"description": "path to the resource",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/migrate": {
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Export from grafana into the remote repository",
|
|
"operationId": "createRepositoryMigrate",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"identifier"
|
|
],
|
|
"properties": {
|
|
"history": {
|
|
"description": "Preserve history (if possible)",
|
|
"type": "boolean"
|
|
},
|
|
"identifier": {
|
|
"description": "Include the identifier in the exported metadata",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"prefix": {
|
|
"description": "Target file prefix",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"example": {
|
|
"prefix": "prefix/in/repo/tree",
|
|
"history": true,
|
|
"identifier": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Job"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Job",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/render/{path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "get a rendered preview image",
|
|
"operationId": "getRepositoryRenderWithPath",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"image/png": {}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Repository",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "path",
|
|
"description": "path to the resource",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/resources": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "connect GET requests to resources of Repository",
|
|
"operationId": "getRepositoryResources",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceList"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "ResourceList"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the ResourceList",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/status": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "read status of the specified Repository",
|
|
"operationId": "getRepositoryStatus",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "get",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "replace status of the specified Repository",
|
|
"operationId": "replaceRepositoryStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldManager",
|
|
"in": "query",
|
|
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldValidation",
|
|
"in": "query",
|
|
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "put",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "partially update status of the specified Repository",
|
|
"operationId": "updateRepositoryStatus",
|
|
"parameters": [
|
|
{
|
|
"name": "dryRun",
|
|
"in": "query",
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldManager",
|
|
"in": "query",
|
|
"description": "fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "fieldValidation",
|
|
"in": "query",
|
|
"description": "fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "force",
|
|
"in": "query",
|
|
"description": "Force is going to \"force\" Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"content": {
|
|
"application/apply-patch+yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/json-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/merge-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
},
|
|
"application/strategic-merge-patch+json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Patch"
|
|
}
|
|
}
|
|
},
|
|
"required": true
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"201": {
|
|
"description": "Created",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/vnd.kubernetes.protobuf": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
},
|
|
"application/yaml": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "patch",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Repository"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Repository",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "pretty",
|
|
"in": "query",
|
|
"description": "If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/sync": {
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Sync from repository into Grafana",
|
|
"operationId": "createRepositorySync",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"incremental"
|
|
],
|
|
"properties": {
|
|
"incremental": {
|
|
"description": "Incremental synchronization for versioned repositories",
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
},
|
|
"example": {
|
|
"incremental": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "Job"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the Job",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/test": {
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Check if the configuration is valid",
|
|
"operationId": "createRepositoryTest",
|
|
"requestBody": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"description": "When this code is changed, make sure to update the code generation. As of writing, this can be done via the hack dir in the root of the repo: ./hack/update-codegen.sh provisioning If you've opened the generated files in this dir at some point in VSCode, you may also have to re-open them to clear errors.",
|
|
"type": "object",
|
|
"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": {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.TestResults"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "TestResults"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the TestResults",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/repositories/{name}/webhook": {
|
|
"get": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "connect GET requests to webhook of Repository",
|
|
"operationId": "getRepositoryWebhook",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.WebhookResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "WebhookResponse"
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Repository"
|
|
],
|
|
"description": "Currently only supports github webhooks",
|
|
"operationId": "createRepositoryWebhook",
|
|
"responses": {
|
|
"200": {
|
|
"description": "OK",
|
|
"content": {
|
|
"*/*": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.WebhookResponse"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kubernetes-action": "connect",
|
|
"x-kubernetes-group-version-kind": {
|
|
"group": "provisioning.grafana.app",
|
|
"version": "v0alpha1",
|
|
"kind": "WebhookResponse"
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "name",
|
|
"in": "path",
|
|
"description": "name of the WebhookResponse",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "object name and auth scope, such as for teams and projects",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"uniqueItems": true
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/settings": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning",
|
|
"Repository"
|
|
],
|
|
"description": "Get the frontend settings for this namespace",
|
|
"operationId": "getFrontendSettings",
|
|
"parameters": [
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "workspace",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "default"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryViewList"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/apis/provisioning.grafana.app/v0alpha1/namespaces/{namespace}/stats": {
|
|
"get": {
|
|
"tags": [
|
|
"Provisioning",
|
|
"Repository"
|
|
],
|
|
"description": "Get resource stats for this namespace",
|
|
"operationId": "getResourceStats",
|
|
"parameters": [
|
|
{
|
|
"name": "namespace",
|
|
"in": "path",
|
|
"description": "workspace",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "default"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceStats"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured": {
|
|
"type": "object",
|
|
"additionalProperties": true,
|
|
"x-kubernetes-preserve-unknown-fields": true
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Author": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"username"
|
|
],
|
|
"properties": {
|
|
"avatarURL": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"username": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ExportJobOptions": {
|
|
"type": "object",
|
|
"required": [
|
|
"identifier"
|
|
],
|
|
"properties": {
|
|
"branch": {
|
|
"description": "Target branch for export (only git)",
|
|
"type": "string"
|
|
},
|
|
"folder": {
|
|
"description": "The source folder (or empty) to export",
|
|
"type": "string"
|
|
},
|
|
"identifier": {
|
|
"description": "Include the identifier in the exported metadata",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"prefix": {
|
|
"description": "Prefix in target file system",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.FileItem": {
|
|
"type": "object",
|
|
"required": [
|
|
"path"
|
|
],
|
|
"properties": {
|
|
"author": {
|
|
"type": "string"
|
|
},
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"modified": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"size": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.FileList": {
|
|
"description": "Information we can get just from the file listing",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {}
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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": {}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.GitHubRepositoryConfig": {
|
|
"type": "object",
|
|
"required": [
|
|
"branch"
|
|
],
|
|
"properties": {
|
|
"branch": {
|
|
"description": "The branch to use in the repository.",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"encryptedToken": {
|
|
"description": "Token for accessing the repository, but encrypted. This is not possible to read back to a user decrypted.",
|
|
"type": "string",
|
|
"format": "byte",
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"token": {
|
|
"description": "Token for accessing the repository. If set, it will be encrypted into encryptedToken, then set to an empty string again.",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "The repository URL (e.g. `https://github.com/example/test`).",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.HealthStatus": {
|
|
"type": "object",
|
|
"required": [
|
|
"healthy"
|
|
],
|
|
"properties": {
|
|
"checked": {
|
|
"description": "When the health was checked last time",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"healthy": {
|
|
"description": "When not healthy, requests will not be executed",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"message": {
|
|
"description": "Summary messages (can be shown to users) Will only be populated when not healthy",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.HistoryItem": {
|
|
"type": "object",
|
|
"required": [
|
|
"ref",
|
|
"message",
|
|
"authors",
|
|
"createdAt"
|
|
],
|
|
"properties": {
|
|
"authors": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {}
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"createdAt": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"default": 0
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"ref": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.HistoryList": {
|
|
"description": "HistoryList is a list of versions of a resource",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {}
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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": {}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job": {
|
|
"description": "The repository name and type are stored as labels",
|
|
"type": "object",
|
|
"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/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
|
|
}
|
|
]
|
|
},
|
|
"spec": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobSpec"
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobStatus"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "Job",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "Job",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobList": {
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Job"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"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/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "JobList",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "JobList",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobResourceSummary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"create": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"delete": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"error": {
|
|
"description": "Create or update (export)",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"errors": {
|
|
"description": "Report errors for this resource type This may not be an exhaustive list and recommend looking at the logs for more info",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"noop": {
|
|
"description": "No action required (useful for sync)",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"total": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"update": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"write": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobSpec": {
|
|
"type": "object",
|
|
"required": [
|
|
"action",
|
|
"repository"
|
|
],
|
|
"properties": {
|
|
"action": {
|
|
"description": "Possible enum values:\n - `\"migrate\"` Migration task -- this will migrate an full instance from SQL \u003e Git\n - `\"pr\"` Process a pull request -- apply comments with preview images, links etc\n - `\"pull\"` Sync the remote branch with the grafana instance\n - `\"push\"` Export from grafana into the remote repository",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"migrate",
|
|
"pr",
|
|
"pull",
|
|
"push"
|
|
]
|
|
},
|
|
"migrate": {
|
|
"description": "Required when the action is `migrate`",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.MigrateJobOptions"
|
|
}
|
|
]
|
|
},
|
|
"pr": {
|
|
"description": "Pull request options",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.PullRequestJobOptions"
|
|
}
|
|
]
|
|
},
|
|
"pull": {
|
|
"description": "Required when the action is `pull`",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncJobOptions"
|
|
}
|
|
]
|
|
},
|
|
"push": {
|
|
"description": "Required when the action is `push`",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ExportJobOptions"
|
|
}
|
|
]
|
|
},
|
|
"repository": {
|
|
"description": "The the repository reference (for now also in labels)",
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobStatus": {
|
|
"description": "The job status",
|
|
"type": "object",
|
|
"properties": {
|
|
"errors": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"finished": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"progress": {
|
|
"description": "Optional value 0-100 that can be set while running",
|
|
"type": "number",
|
|
"format": "double"
|
|
},
|
|
"started": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"state": {
|
|
"description": "Possible enum values:\n - `\"error\"` Finished with errors\n - `\"pending\"` Job has been submitted, but not processed yet\n - `\"success\"` Finished with success\n - `\"working\"` The job is running",
|
|
"type": "string",
|
|
"enum": [
|
|
"error",
|
|
"pending",
|
|
"success",
|
|
"working"
|
|
]
|
|
},
|
|
"summary": {
|
|
"description": "Summary of processed actions",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobResourceSummary"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.LocalRepositoryConfig": {
|
|
"type": "object",
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ManagerStats": {
|
|
"type": "object",
|
|
"required": [
|
|
"stats"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"description": "Manager identity",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "Manager kind",
|
|
"type": "string"
|
|
},
|
|
"stats": {
|
|
"description": "stats",
|
|
"type": "array",
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceCount"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.MigrateJobOptions": {
|
|
"type": "object",
|
|
"required": [
|
|
"identifier"
|
|
],
|
|
"properties": {
|
|
"history": {
|
|
"description": "Preserve history (if possible)",
|
|
"type": "boolean"
|
|
},
|
|
"identifier": {
|
|
"description": "Include the identifier in the exported metadata",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"prefix": {
|
|
"description": "Target file prefix",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.PullRequestJobOptions": {
|
|
"type": "object",
|
|
"properties": {
|
|
"hash": {
|
|
"type": "string"
|
|
},
|
|
"pr": {
|
|
"description": "Pull request number (when appropriate)",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"ref": {
|
|
"description": "The branch of commit hash",
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"description": "URL to the originator (eg, PR URL)",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository": {
|
|
"description": "When this code is changed, make sure to update the code generation. As of writing, this can be done via the hack dir in the root of the repo: ./hack/update-codegen.sh provisioning If you've opened the generated files in this dir at some point in VSCode, you may also have to re-open them to clear errors.",
|
|
"type": "object",
|
|
"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/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta"
|
|
}
|
|
]
|
|
},
|
|
"spec": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositorySpec"
|
|
}
|
|
]
|
|
},
|
|
"status": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryStatus"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "Repository",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "Repository",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryList": {
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.Repository"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "RepositoryList",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "RepositoryList",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositorySpec": {
|
|
"type": "object",
|
|
"required": [
|
|
"title",
|
|
"workflows",
|
|
"sync",
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"description": {
|
|
"description": "Repository description",
|
|
"type": "string"
|
|
},
|
|
"github": {
|
|
"description": "The repository on GitHub. Mutually exclusive with local | github.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.GitHubRepositoryConfig"
|
|
}
|
|
]
|
|
},
|
|
"local": {
|
|
"description": "The repository on the local file system. Mutually exclusive with local | github.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.LocalRepositoryConfig"
|
|
}
|
|
]
|
|
},
|
|
"sync": {
|
|
"description": "Sync settings -- how values are pulled from the repository into grafana",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncOptions"
|
|
}
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "The repository display name (shown in the UI)",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"type": {
|
|
"description": "The repository type. When selected oneOf the values below should be non-nil\n\nPossible enum values:\n - `\"github\"`\n - `\"local\"`",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"github",
|
|
"local"
|
|
]
|
|
},
|
|
"workflows": {
|
|
"description": "UI driven Workflow that allow changes to the contends of the repository. The order is relevant for defining the precedence of the workflows. When empty, the repository does not support any edits (eg, readonly)",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"branch",
|
|
"write"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryStatus": {
|
|
"description": "The status of a Repository. This is expected never to be created by a kubectl call or similar, and is expected to rarely (if ever) be edited manually. As such, it is also a little less well structured than the spec, such as conditional-but-ever-present fields.",
|
|
"type": "object",
|
|
"required": [
|
|
"observedGeneration",
|
|
"health",
|
|
"sync",
|
|
"webhook"
|
|
],
|
|
"properties": {
|
|
"health": {
|
|
"description": "This will get updated with the current health status (and updated periodically)",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.HealthStatus"
|
|
}
|
|
]
|
|
},
|
|
"observedGeneration": {
|
|
"description": "The generation of the spec last time reconciliation ran",
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"default": 0
|
|
},
|
|
"stats": {
|
|
"description": "The object count when sync last ran",
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceCount"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"sync": {
|
|
"description": "Sync information with the last sync information",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncStatus"
|
|
}
|
|
]
|
|
},
|
|
"webhook": {
|
|
"description": "Webhook Information (if applicable)",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.WebhookStatus"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryView": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"title",
|
|
"readOnly",
|
|
"type",
|
|
"target"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"description": "The k8s name for this repository",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"readOnly": {
|
|
"description": "Edit options within the repository",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"target": {
|
|
"description": "When syncing, where values are saved\n\nPossible enum values:\n - `\"folder\"` Resources will be saved into a folder managed by this repository It will contain a copy of everything from the remote The folder k8s name will be the same as the repository k8s name\n - `\"instance\"` Resources are saved in the global context Only one repository may specify the `instance` target When this exists, the UI will promote writing to the instance repo rather than the grafana database (where possible)",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"folder",
|
|
"instance"
|
|
]
|
|
},
|
|
"title": {
|
|
"description": "Repository display",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"type": {
|
|
"description": "The repository type\n\nPossible enum values:\n - `\"github\"`\n - `\"local\"`",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"github",
|
|
"local"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryViewList": {
|
|
"description": "Summary shows a view of the configuration that is sanitized and is OK for logged in users to see",
|
|
"type": "object",
|
|
"required": [
|
|
"items"
|
|
],
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.RepositoryView"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-map-type": "atomic"
|
|
},
|
|
"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"
|
|
},
|
|
"legacyStorage": {
|
|
"description": "The backend is using legacy storage FIXME: Not sure where this should be exposed... but we need it somewhere The UI should force the onboarding workflow when this is true",
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceCount": {
|
|
"type": "object",
|
|
"required": [
|
|
"group",
|
|
"resource",
|
|
"count"
|
|
],
|
|
"properties": {
|
|
"count": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"default": 0
|
|
},
|
|
"group": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"resource": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceList": {
|
|
"description": "Information we can get just from the file listing",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceListItem"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "ResourceList",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "ResourceList",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceListItem": {
|
|
"type": "object",
|
|
"required": [
|
|
"path",
|
|
"group",
|
|
"resource",
|
|
"name",
|
|
"hash"
|
|
],
|
|
"properties": {
|
|
"folder": {
|
|
"type": "string"
|
|
},
|
|
"group": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"hash": {
|
|
"description": "the k8s identifier",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"path": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"resource": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"time": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"title": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceObjects": {
|
|
"type": "object",
|
|
"required": [
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"action": {
|
|
"description": "The action required/used for dryRun\n\nPossible enum values:\n - `\"create\"`\n - `\"delete\"`\n - `\"update\"`",
|
|
"type": "string",
|
|
"enum": [
|
|
"create",
|
|
"delete",
|
|
"update"
|
|
]
|
|
},
|
|
"dryRun": {
|
|
"description": "The value returned from a dryRun request",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured"
|
|
}
|
|
]
|
|
},
|
|
"existing": {
|
|
"description": "The same value, currently saved in the grafana database",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured"
|
|
}
|
|
]
|
|
},
|
|
"file": {
|
|
"description": "The resource from the repository with all modifications applied eg, the name, folder etc will all be applied to this object",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"description": "The identified type for this object",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceType"
|
|
}
|
|
]
|
|
},
|
|
"upsert": {
|
|
"description": "For write events, this will return the value that was added or updated",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceRepositoryInfo": {
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"title",
|
|
"namespace",
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"description": "The name (identifier)",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"namespace": {
|
|
"description": "The namespace this belongs to",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"title": {
|
|
"description": "The display name for this repository",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"type": {
|
|
"description": "The repository type\n\nPossible enum values:\n - `\"github\"`\n - `\"local\"`",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"github",
|
|
"local"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceStats": {
|
|
"description": "Information we can get just from the file listing",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"instance": {
|
|
"description": "Stats across all unified storage When legacy storage is still used, this will offer a shim",
|
|
"type": "array",
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceCount"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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"
|
|
},
|
|
"managed": {
|
|
"description": "Stats for each manager",
|
|
"type": "array",
|
|
"items": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ManagerStats"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"metadata": {
|
|
"default": {}
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"classic": {
|
|
"description": "For non-k8s native formats, what did this start as\n\nPossible enum values:\n - `\"access-control\"` Access control https://github.com/grafana/grafana/blob/v11.3.1/conf/provisioning/access-control/sample.yaml\n - `\"alerting\"` Alert configuration https://github.com/grafana/grafana/blob/v11.3.1/conf/provisioning/alerting/sample.yaml\n - `\"dashboard\"` Dashboard JSON\n - `\"datasources\"` Datasource definitions eg: https://github.com/grafana/grafana/blob/v11.3.1/conf/provisioning/datasources/sample.yaml",
|
|
"type": "string",
|
|
"enum": [
|
|
"access-control",
|
|
"alerting",
|
|
"dashboard",
|
|
"datasources"
|
|
]
|
|
},
|
|
"group": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"type": "string"
|
|
},
|
|
"resource": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceURLs": {
|
|
"type": "object",
|
|
"properties": {
|
|
"compareURL": {
|
|
"description": "Compare this version to the target branch",
|
|
"type": "string"
|
|
},
|
|
"newPullRequestURL": {
|
|
"description": "A URL that will create a new pull requeset for this branch",
|
|
"type": "string"
|
|
},
|
|
"repositoryURL": {
|
|
"description": "A URL pointing to the repository this lives in",
|
|
"type": "string"
|
|
},
|
|
"sourceURL": {
|
|
"description": "A URL pointing to the this file in the repository",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceWrapper": {
|
|
"description": "This is a container type for any resource type",
|
|
"type": "object",
|
|
"required": [
|
|
"repository",
|
|
"resource"
|
|
],
|
|
"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"
|
|
},
|
|
"errors": {
|
|
"description": "If errors exist, show them here",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"hash": {
|
|
"description": "The repo hash value",
|
|
"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"
|
|
},
|
|
"path": {
|
|
"description": "Path to the remote file",
|
|
"type": "string"
|
|
},
|
|
"ref": {
|
|
"description": "The request ref (or branch if exists)",
|
|
"type": "string"
|
|
},
|
|
"repository": {
|
|
"description": "Basic repository info",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceRepositoryInfo"
|
|
}
|
|
]
|
|
},
|
|
"resource": {
|
|
"description": "Different flavors of the same object",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceObjects"
|
|
}
|
|
]
|
|
},
|
|
"timestamp": {
|
|
"description": "The modified time in the remote file system",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
|
|
}
|
|
]
|
|
},
|
|
"urls": {
|
|
"description": "Typed links for this file (only supported by external systems, github etc)",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.ResourceURLs"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "ResourceWrapper",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "ResourceWrapper",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncJobOptions": {
|
|
"type": "object",
|
|
"required": [
|
|
"incremental"
|
|
],
|
|
"properties": {
|
|
"incremental": {
|
|
"description": "Incremental synchronization for versioned repositories",
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncOptions": {
|
|
"type": "object",
|
|
"required": [
|
|
"enabled",
|
|
"target"
|
|
],
|
|
"properties": {
|
|
"enabled": {
|
|
"description": "Enabled must be saved as true before any sync job will run",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"intervalSeconds": {
|
|
"description": "When non-zero, the sync will run periodically",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"target": {
|
|
"description": "Where values should be saved\n\nPossible enum values:\n - `\"folder\"` Resources will be saved into a folder managed by this repository It will contain a copy of everything from the remote The folder k8s name will be the same as the repository k8s name\n - `\"instance\"` Resources are saved in the global context Only one repository may specify the `instance` target When this exists, the UI will promote writing to the instance repo rather than the grafana database (where possible)",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"folder",
|
|
"instance"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.SyncStatus": {
|
|
"type": "object",
|
|
"required": [
|
|
"state",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"finished": {
|
|
"description": "When the sync job finished",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"incremental": {
|
|
"description": "Incremental synchronization for versioned repositories",
|
|
"type": "boolean"
|
|
},
|
|
"job": {
|
|
"description": "The ID for the job that ran this sync",
|
|
"type": "string"
|
|
},
|
|
"lastRef": {
|
|
"description": "The repository ref when the last successful sync ran",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "Summary messages (will be shown to users)",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"scheduled": {
|
|
"description": "When the next sync check is scheduled",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"started": {
|
|
"description": "When the sync job started",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"state": {
|
|
"description": "pending, running, success, error\n\nPossible enum values:\n - `\"error\"` Finished with errors\n - `\"pending\"` Job has been submitted, but not processed yet\n - `\"success\"` Finished with success\n - `\"working\"` The job is running",
|
|
"type": "string",
|
|
"default": "",
|
|
"enum": [
|
|
"error",
|
|
"pending",
|
|
"success",
|
|
"working"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.TestResults": {
|
|
"description": "HistoryList is a list of versions of a resource",
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"success"
|
|
],
|
|
"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"
|
|
},
|
|
"code": {
|
|
"description": "HTTP status code",
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 0
|
|
},
|
|
"details": {
|
|
"description": "Optional details",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apimachinery.apis.common.v0alpha1.Unstructured"
|
|
}
|
|
]
|
|
},
|
|
"errors": {
|
|
"description": "Error descriptions",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"success": {
|
|
"description": "Is the connection healthy",
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "TestResults",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "TestResults",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.WebhookResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"added": {
|
|
"description": "Optional message",
|
|
"type": "string"
|
|
},
|
|
"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"
|
|
},
|
|
"code": {
|
|
"description": "HTTP Status code 200 implies that the payload was understood but nothing is required 202 implies that an async job has been scheduled to handle the request",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"job": {
|
|
"description": "Jobs to be processed When the response is 202 (Accepted) the queued jobs will be returned",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.JobSpec"
|
|
}
|
|
]
|
|
},
|
|
"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"
|
|
}
|
|
},
|
|
"x-kubernetes-group-version-kind": [
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "WebhookResponse",
|
|
"version": "__internal"
|
|
},
|
|
{
|
|
"group": "provisioning.grafana.app",
|
|
"kind": "WebhookResponse",
|
|
"version": "v0alpha1"
|
|
}
|
|
]
|
|
},
|
|
"com.github.grafana.grafana.pkg.apis.provisioning.v0alpha1.WebhookStatus": {
|
|
"type": "object",
|
|
"properties": {
|
|
"encryptedSecret": {
|
|
"type": "string",
|
|
"format": "byte"
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"secret": {
|
|
"type": "string"
|
|
},
|
|
"subscribedEvents": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResource": {
|
|
"description": "APIResource specifies the name of a resource and whether it is namespaced.",
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"singularName",
|
|
"namespaced",
|
|
"kind",
|
|
"verbs"
|
|
],
|
|
"properties": {
|
|
"categories": {
|
|
"description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"group": {
|
|
"description": "group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"name": {
|
|
"description": "name is the plural name of the resource.",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"namespaced": {
|
|
"description": "namespaced indicates if a resource is namespaced or not.",
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"shortNames": {
|
|
"description": "shortNames is a list of suggested short names of the resource.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"singularName": {
|
|
"description": "singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"storageVersionHash": {
|
|
"description": "The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.",
|
|
"type": "string"
|
|
},
|
|
"verbs": {
|
|
"description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"version": {
|
|
"description": "version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\".",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.APIResourceList": {
|
|
"description": "APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.",
|
|
"type": "object",
|
|
"required": [
|
|
"groupVersion",
|
|
"resources"
|
|
],
|
|
"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"
|
|
},
|
|
"groupVersion": {
|
|
"description": "groupVersion is the group and version this APIResourceList is for.",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"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"
|
|
},
|
|
"resources": {
|
|
"description": "resources contains the name of the resources and if they are namespaced.",
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.APIResource"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions": {
|
|
"description": "DeleteOptions may be provided when deleting an API object.",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"dryRun": {
|
|
"description": "When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"gracePeriodSeconds": {
|
|
"description": "The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"ignoreStoreReadErrorWithClusterBreakingPotential": {
|
|
"description": "if set to true, it will trigger an unsafe deletion of the resource in case the normal deletion flow fails with a corrupt object error. A resource is considered corrupt if it can not be retrieved from the underlying storage successfully because of a) its data can not be transformed e.g. decryption failure, or b) it fails to decode into an object. NOTE: unsafe deletion ignores finalizer constraints, skips precondition checks, and removes the object from the storage. WARNING: This may potentially break the cluster if the workload associated with the resource being unsafe-deleted relies on normal deletion flow. Use only if you REALLY know what you are doing. The default value is false, and the user must opt in to enable it",
|
|
"type": "boolean"
|
|
},
|
|
"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"
|
|
},
|
|
"orphanDependents": {
|
|
"description": "Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.",
|
|
"type": "boolean"
|
|
},
|
|
"preconditions": {
|
|
"description": "Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions"
|
|
}
|
|
]
|
|
},
|
|
"propagationPolicy": {
|
|
"description": "Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.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:\u003cname\u003e', where \u003cname\u003e is the name of a field in a struct, or key in a map 'v:\u003cvalue\u003e', where \u003cvalue\u003e is the exact json formatted value of a list item 'i:\u003cindex\u003e', where \u003cindex\u003e is position of a item in a list 'k:\u003ckeys\u003e', where \u003ckeys\u003e 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"
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta": {
|
|
"description": "ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.",
|
|
"type": "object",
|
|
"properties": {
|
|
"continue": {
|
|
"description": "continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.",
|
|
"type": "string"
|
|
},
|
|
"remainingItemCount": {
|
|
"description": "remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"resourceVersion": {
|
|
"description": "String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
|
|
"type": "string"
|
|
},
|
|
"selfLink": {
|
|
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry": {
|
|
"description": "ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.",
|
|
"type": "object",
|
|
"properties": {
|
|
"apiVersion": {
|
|
"description": "APIVersion defines the version of this resource that this field set applies to. The format is \"group/version\" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.",
|
|
"type": "string"
|
|
},
|
|
"fieldsType": {
|
|
"description": "FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: \"FieldsV1\"",
|
|
"type": "string"
|
|
},
|
|
"fieldsV1": {
|
|
"description": "FieldsV1 holds the first JSON version format as described in the \"FieldsV1\" type.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1"
|
|
}
|
|
]
|
|
},
|
|
"manager": {
|
|
"description": "Manager is an identifier of the workflow managing these fields.",
|
|
"type": "string"
|
|
},
|
|
"operation": {
|
|
"description": "Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.",
|
|
"type": "string"
|
|
},
|
|
"subresource": {
|
|
"description": "Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.",
|
|
"type": "string"
|
|
},
|
|
"time": {
|
|
"description": "Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta": {
|
|
"description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.",
|
|
"type": "object",
|
|
"properties": {
|
|
"annotations": {
|
|
"description": "Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations",
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"creationTimestamp": {
|
|
"description": "CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.\n\nPopulated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
|
|
}
|
|
]
|
|
},
|
|
"deletionGracePeriodSeconds": {
|
|
"description": "Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"deletionTimestamp": {
|
|
"description": "DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.\n\nPopulated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.Time"
|
|
}
|
|
]
|
|
},
|
|
"finalizers": {
|
|
"description": "Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"x-kubernetes-list-type": "set",
|
|
"x-kubernetes-patch-strategy": "merge"
|
|
},
|
|
"generateName": {
|
|
"description": "GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will return a 409.\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency",
|
|
"type": "string"
|
|
},
|
|
"generation": {
|
|
"description": "A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.",
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"labels": {
|
|
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels",
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"managedFields": {
|
|
"description": "ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like \"ci-cd\". The set of fields is always in the version that the workflow used when modifying the object.",
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"name": {
|
|
"description": "Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
|
|
"type": "string"
|
|
},
|
|
"namespace": {
|
|
"description": "Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces",
|
|
"type": "string"
|
|
},
|
|
"ownerReferences": {
|
|
"description": "List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.",
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-map-keys": [
|
|
"uid"
|
|
],
|
|
"x-kubernetes-list-type": "map",
|
|
"x-kubernetes-patch-merge-key": "uid",
|
|
"x-kubernetes-patch-strategy": "merge"
|
|
},
|
|
"resourceVersion": {
|
|
"description": "An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency",
|
|
"type": "string"
|
|
},
|
|
"selfLink": {
|
|
"description": "Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.",
|
|
"type": "string"
|
|
},
|
|
"uid": {
|
|
"description": "UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference": {
|
|
"description": "OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.",
|
|
"type": "object",
|
|
"required": [
|
|
"apiVersion",
|
|
"kind",
|
|
"name",
|
|
"uid"
|
|
],
|
|
"properties": {
|
|
"apiVersion": {
|
|
"description": "API version of the referent.",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"blockOwnerDeletion": {
|
|
"description": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs \"delete\" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.",
|
|
"type": "boolean"
|
|
},
|
|
"controller": {
|
|
"description": "If true, this reference points to the managing controller.",
|
|
"type": "boolean"
|
|
},
|
|
"kind": {
|
|
"description": "Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"name": {
|
|
"description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names",
|
|
"type": "string",
|
|
"default": ""
|
|
},
|
|
"uid": {
|
|
"description": "UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
},
|
|
"x-kubernetes-map-type": "atomic"
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.Patch": {
|
|
"description": "Patch is provided to give a concrete name and type to the Kubernetes PATCH request body.",
|
|
"type": "object"
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.Preconditions": {
|
|
"description": "Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.",
|
|
"type": "object",
|
|
"properties": {
|
|
"resourceVersion": {
|
|
"description": "Specifies the target ResourceVersion",
|
|
"type": "string"
|
|
},
|
|
"uid": {
|
|
"description": "Specifies the target UID.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.Status": {
|
|
"description": "Status is a return value for calls that don't return other objects.",
|
|
"type": "object",
|
|
"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"
|
|
},
|
|
"code": {
|
|
"description": "Suggested HTTP return code for this status, 0 if not set.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"details": {
|
|
"description": "Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails"
|
|
}
|
|
],
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"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"
|
|
},
|
|
"message": {
|
|
"description": "A human-readable description of the status of this operation.",
|
|
"type": "string"
|
|
},
|
|
"metadata": {
|
|
"description": "Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta"
|
|
}
|
|
]
|
|
},
|
|
"reason": {
|
|
"description": "A machine-readable description of why this operation is in the \"Failure\" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.",
|
|
"type": "string"
|
|
},
|
|
"status": {
|
|
"description": "Status of the operation. One of: \"Success\" or \"Failure\". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause": {
|
|
"description": "StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.",
|
|
"type": "object",
|
|
"properties": {
|
|
"field": {
|
|
"description": "The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"",
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"description": "A human-readable description of the cause of the error. This field may be presented as-is to a reader.",
|
|
"type": "string"
|
|
},
|
|
"reason": {
|
|
"description": "A machine-readable description of the cause of the error. If this value is empty there is no information available.",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.StatusDetails": {
|
|
"description": "StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.",
|
|
"type": "object",
|
|
"properties": {
|
|
"causes": {
|
|
"description": "The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.",
|
|
"type": "array",
|
|
"items": {
|
|
"default": {},
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.apis.meta.v1.StatusCause"
|
|
}
|
|
]
|
|
},
|
|
"x-kubernetes-list-type": "atomic"
|
|
},
|
|
"group": {
|
|
"description": "The group attribute of the resource associated with the status StatusReason.",
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"description": "The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).",
|
|
"type": "string"
|
|
},
|
|
"retryAfterSeconds": {
|
|
"description": "If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"uid": {
|
|
"description": "UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.Time": {
|
|
"description": "Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.",
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent": {
|
|
"description": "Event represents a single event to a watched resource.",
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"object"
|
|
],
|
|
"properties": {
|
|
"object": {
|
|
"description": "Object is:\n * If Type is Added or Modified: the new state of the object.\n * If Type is Deleted: the state of the object immediately before deletion.\n * If Type is Error: *Status is recommended; other types may make sense\n depending on context.",
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/io.k8s.apimachinery.pkg.runtime.RawExtension"
|
|
}
|
|
]
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"io.k8s.apimachinery.pkg.runtime.RawExtension": {
|
|
"description": "RawExtension is used to hold extensions in external versions.\n\nTo use this, make a field which has RawExtension as its type in your external, versioned struct, and Object in your internal struct. You also need to register your various plugin types.\n\n// Internal package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.Object `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// External package:\n\n\ttype MyAPIObject struct {\n\t\truntime.TypeMeta `json:\",inline\"`\n\t\tMyPlugin runtime.RawExtension `json:\"myPlugin\"`\n\t}\n\n\ttype PluginA struct {\n\t\tAOption string `json:\"aOption\"`\n\t}\n\n// On the wire, the JSON will look something like this:\n\n\t{\n\t\t\"kind\":\"MyAPIObject\",\n\t\t\"apiVersion\":\"v1\",\n\t\t\"myPlugin\": {\n\t\t\t\"kind\":\"PluginA\",\n\t\t\t\"aOption\":\"foo\",\n\t\t},\n\t}\n\nSo what happens? Decode first uses json or yaml to unmarshal the serialized data into your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. The next step is to copy (using pkg/conversion) into the internal struct. The runtime package's DefaultScheme has conversion functions installed which will unpack the JSON stored in RawExtension, turning it into the correct object type, and storing it in the Object. (TODO: In the case where the object is of an unknown type, a runtime.Unknown object will be created and stored.)",
|
|
"type": "object"
|
|
}
|
|
}
|
|
}
|
|
} |