// Do not return anything unless you have special circumstances! This is a list of resources that are allowed to be accessed in v0alpha1, with AllResourcesAllowed allowing all in the group.
// This is to prevent accidental exposure of experimental APIs. While developing, use the feature flag `grafanaAPIServerWithExperimentalAPIs`.
// And then, when you're ready to expose this to the end user, go to v1beta1 instead.
"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.",
"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).",
"description":"Datasource UID (NOTE: name in k8s)",
"type":"string"
}
},
"additionalProperties":false
},
"hide":{
"description":"true if query is disabled (ie should not be returned to the dashboard)\nNOTE: this does not always imply that the query should not be executed since\nthe results from a hidden query may be used as the input to other queries (SSE etc)",
"type":"boolean"
},
"intervalMs":{
"description":"Interval is the suggested duration between time points in a time series query.\nNOTE: the values for intervalMs is not saved in the query model. It is typically calculated\nfrom the interval required to fill a pixels in the visualization",
"type":"number"
},
"maxDataPoints":{
"description":"MaxDataPoints is the maximum number of data points that should be returned from a time series query.\nNOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated\nfrom the number of pixels visible in a visualization",
"type":"integer"
},
"queryType":{
"description":"QueryType is an optional identifier for the type of query.\nIt can be used to distinguish different types of queries.",
"type":"string"
},
"refId":{
"description":"RefID is the unique identifier of the query, set by the frontend call.",
"type":"string"
},
"resultAssertions":{
"description":"Optionally define expected query result behavior",
"type":"object",
"required":[
"typeVersion"
],
"properties":{
"maxFrames":{
"description":"Maximum frame count",
"type":"integer"
},
"type":{
"description":"Type asserts that the frame matches a known type structure.\n\n\nPossible enum values:\n - `\"\"` \n - `\"timeseries-wide\"` \n - `\"timeseries-long\"` \n - `\"timeseries-many\"` \n - `\"timeseries-multi\"` \n - `\"directory-listing\"` \n - `\"table\"` \n - `\"numeric-wide\"` \n - `\"numeric-multi\"` \n - `\"numeric-long\"` \n - `\"log-lines\"` ",
"type":"string",
"enum":[
"",
"timeseries-wide",
"timeseries-long",
"timeseries-many",
"timeseries-multi",
"directory-listing",
"table",
"numeric-wide",
"numeric-multi",
"numeric-long",
"log-lines"
],
"x-enum-description":{}
},
"typeVersion":{
"description":"TypeVersion is the version of the Type property. Versions greater than 0.0 correspond to the dataplane\ncontract documentation https://grafana.github.io/dataplane/contract/.",
"type":"array",
"maxItems":2,
"minItems":2,
"items":{
"type":"integer"
}
}
},
"additionalProperties":false
},
"timeRange":{
"description":"TimeRange represents the query range\nNOTE: unlike generic /ds/query, we can now send explicit time values in each query\nNOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly",
"type":"object",
"required":[
"from",
"to"
],
"properties":{
"from":{
"description":"From is the start time of the query.",
"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":{
"description":"Standard object's metadata More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata",
"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",
"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",
Stephanie Hingtgen
1 month ago
committed by