Query Library: Update API client (#99382)

* Add process script

* Working version

* Use new types

* Use new types

* Update client

* Tweaks

* Process multiple specs

* Remove 'any' types

* Use BASE_URL

* Update CODEOWNERS

* Fix filename

* add openapi

* update CODEOWNDER

* use JSONeq

* Use existing specs

* Filter ForAllNamespaces

* Add instructions

* Switch to tsx

* Use openapi-types

* Update src path

* Expand docs

* Update docs

* Rename script

* codeowners

* More docs

* Move openapi-types to dev deps

* Update error message

* Update doc

* Fix typo

---------

Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
This commit is contained in:
Alex Khomenko
2025-01-29 18:05:40 +02:00
committed by GitHub
parent 0613ed1f11
commit 9f4e8ee206
15 changed files with 260 additions and 111 deletions

1
.github/CODEOWNERS vendored
View File

@@ -617,6 +617,7 @@ playwright.config.ts @grafana/plugins-platform-frontend
/scripts/cleanup-husky.sh @grafana/frontend-ops
/scripts/verify-repo-update/ @grafana/grafana-developer-enablement-squad
/scripts/generate-rtk-apis.ts @grafana/grafana-frontend-platform
/scripts/process-specs.ts @grafana/grafana-frontend-platform
/scripts/generate-alerting-rtk-apis.ts @grafana/alerting-frontend
/scripts/levitate-parse-json-report.js @grafana/plugins-platform-frontend
/scripts/levitate-show-affected-plugins.js @grafana/plugins-platform-frontend

View File

@@ -64,7 +64,8 @@
"plugin:build:commit": "nx run-many -t build:commit --projects='tag:scope:plugin'",
"plugin:build:dev": "nx run-many -t dev --projects='tag:scope:plugin' --maxParallel=100",
"generate-icons": "nx run grafana-icons:generate",
"generate-apis": "rtk-query-codegen-openapi ./scripts/generate-rtk-apis.ts"
"process-specs": "npx tsx scripts/process-specs.ts",
"generate-apis": "yarn process-specs && rtk-query-codegen-openapi ./scripts/generate-rtk-apis.ts"
},
"grafana": {
"whatsNewUrl": "https://grafana.com/docs/grafana/next/whatsnew/whats-new-in-v11-4/",
@@ -215,6 +216,7 @@
"ngtemplate-loader": "2.1.0",
"node-notifier": "10.0.1",
"nx": "19.8.2",
"openapi-types": "^12.1.3",
"postcss": "8.5.1",
"postcss-loader": "8.1.1",
"postcss-reporter": "7.1.0",

View File

@@ -1,3 +1,32 @@
This folder contains a rendered OpenAPI for each group/version
This folder contains a rendered OpenAPI file for each group/version. The “real” OpenAPI is generated by the running server, but the files here are used to build static frontend clients.
The "real" openapi is generated by the running server, but this is used to build static frontend clients
## Generating RTK API Clients
The RTK API clients are generated from processed OpenAPI files using the `scripts/process-specs.ts` script. The source files are in `pkg/tests/apis/openapi_snapshots`, and the processed files are stored in the `data/openapi` directory. Spec processing happens as part of `yarn generate-apis` task, but can also be triggered separately (see below).
To generate or update the RTK API clients:
1. _If generating or updating an RTK client for the first time_, update `scripts/generate-rtk-apis.js` so `schemaFile` points to the processed spec files, for example:
```typescript
'../public/app/features/dashboards/api/endpoints.gen.ts': {
schemaFile: '../data/openapi/dashboard.grafana.app-v0alpha1.json',
},
```
2. Generate or update the OpenAPI spec files by running:
```bash
go test pkg/tests/apis/openapi_test.go
```
_If generating an RTK client for a new API_, also add a new group/version of the API to the `groups` slice. If the API is behind a feature toggle, add the toggle to `EnableFeatureToggles` in `pkg/tests/apis/openapi_test.go`.
3. Run:
```bash
yarn generate-apis
```
This command generates (or updates) the spec files in the `data/openapi` directory and generates the RTK API clients.
If you want to process the OpenAPI files without generating the RTK API clients (for example, if you have a separate `generate-rtk-apis` file), run:
```bash
yarn process-specs
```

View File

@@ -63,7 +63,7 @@ func TestIntegrationOpenAPIs(t *testing.T) {
dir := "openapi_snapshots"
for _, gv := range []schema.GroupVersion{{
var groups = []schema.GroupVersion{{
Group: "dashboard.grafana.app",
Version: "v0alpha1",
}, {
@@ -72,7 +72,8 @@ func TestIntegrationOpenAPIs(t *testing.T) {
}, {
Group: "peakq.grafana.app",
Version: "v0alpha1",
}} {
}}
for _, gv := range groups {
VerifyOpenAPISnapshots(t, dir, gv, h)
}
}

View File

@@ -13,7 +13,6 @@ import { useCreateQueryTemplateMutation, useUpdateQueryTemplateMutation } from '
import { AddQueryTemplateCommand, EditQueryTemplateCommand } from 'app/features/query-library/types';
import { convertAddQueryTemplateCommandToDataQuerySpec } from '../../query-library/api/mappers';
import { getK8sNamespace } from '../../query-library/api/query';
import { useDatasource } from '../QueryLibrary/utils/useDatasource';
import { QueryTemplateRow } from './QueryTemplatesTable/types';
@@ -64,9 +63,7 @@ export const QueryTemplateForm = ({ onCancel, onSave, queryToAdd, templateData }
const handleAddQueryTemplate = async (addQueryTemplateCommand: AddQueryTemplateCommand) => {
return addQueryTemplate({
namespace: getK8sNamespace(),
comGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate:
convertAddQueryTemplateCommandToDataQuerySpec(addQueryTemplateCommand),
queryTemplate: convertAddQueryTemplateCommandToDataQuerySpec(addQueryTemplateCommand),
})
.unwrap()
.then(() => {
@@ -89,9 +86,8 @@ export const QueryTemplateForm = ({ onCancel, onSave, queryToAdd, templateData }
const handleEditQueryTemplate = async (editQueryTemplateCommand: EditQueryTemplateCommand) => {
return editQueryTemplate({
namespace: getK8sNamespace(),
name: editQueryTemplateCommand.uid,
ioK8SApimachineryPkgApisMetaV1Patch: {
patch: {
spec: editQueryTemplateCommand.partialSpec,
},
})

View File

@@ -13,7 +13,6 @@ import { QueryTemplate } from 'app/features/query-library/types';
import { getDatasourceSrv } from '../../plugins/datasource_srv';
import { convertDataQueryResponseToQueryTemplates } from '../../query-library/api/mappers';
import { getK8sNamespace } from '../../query-library/api/query';
import { QueryLibraryProps } from './QueryLibrary';
import { queryLibraryTrackFilterDatasource } from './QueryLibraryAnalyticsEvents';
@@ -25,13 +24,7 @@ import { searchQueryLibrary } from './utils/search';
interface QueryTemplatesListProps extends QueryLibraryProps {}
export function QueryTemplatesList(props: QueryTemplatesListProps) {
const {
data: rawData,
isLoading,
error,
} = useListQueryTemplateQuery({
namespace: getK8sNamespace(),
});
const { data: rawData, isLoading, error } = useListQueryTemplateQuery({});
const data = useMemo(() => (rawData ? convertDataQueryResponseToQueryTemplates(rawData) : undefined), [rawData]);
const [isModalOpen, setIsModalOpen] = useState(false);
const [searchQuery, setSearchQuery] = useState('');

View File

@@ -9,7 +9,6 @@ import { useDeleteQueryTemplateMutation } from 'app/features/query-library';
import { dispatch } from 'app/store/store';
import { ShowConfirmModalEvent } from 'app/types/events';
import { getK8sNamespace } from '../../../query-library/api/query';
import ExploreRunQueryButton from '../../ExploreRunQueryButton';
import { useQueriesDrawerContext } from '../../QueriesDrawer/QueriesDrawerContext';
import {
@@ -38,8 +37,7 @@ function ActionsCell({ queryTemplate, rootDatasourceUid, queryUid }: ActionsCell
const performDelete = (queryUid: string) => {
deleteQueryTemplate({
name: queryUid,
namespace: getK8sNamespace(),
ioK8SApimachineryPkgApisMetaV1DeleteOptions: {},
deleteOptions: {},
});
dispatch(notifyApp(createSuccessNotification(t('explore.query-library.query-deleted', 'Query deleted'))));
queryLibaryTrackDeleteQuery();

View File

@@ -17,7 +17,6 @@ import { RichHistoryQuery } from 'app/types/explore';
import { supportedFeatures } from '../../../core/history/richHistoryStorageProvider';
import { useListQueryTemplateQuery } from '../../query-library';
import { getK8sNamespace } from '../../query-library/api/query';
import { Tabs, useQueriesDrawerContext } from '../QueriesDrawer/QueriesDrawerContext';
import { i18n } from '../QueriesDrawer/utils';
import { QueryLibrary } from '../QueryLibrary/QueryLibrary';
@@ -99,9 +98,7 @@ export function RichHistory(props: RichHistoryProps) {
.map((eDs) => listOfDatasources.find((ds) => ds.uid === eDs.datasource?.uid)?.name)
.filter((name): name is string => !!name);
const { data } = useListQueryTemplateQuery({
namespace: getK8sNamespace(),
});
const { data } = useListQueryTemplateQuery({});
const queryTemplatesCount = data?.items?.length ?? 0;
const QueryLibraryTab: TabConfig = {

View File

@@ -5,7 +5,6 @@ import { Button, Modal } from '@grafana/ui';
import { t } from 'app/core/internationalization';
import { isQueryLibraryEnabled, useListQueryTemplateQuery } from 'app/features/query-library';
import { getK8sNamespace } from '../../query-library/api/query';
import {
queryLibraryTrackAddFromQueryHistory,
queryLibraryTrackAddFromQueryHistoryAddModalShown,
@@ -17,9 +16,7 @@ type Props = {
};
export const RichHistoryAddToLibrary = ({ query }: Props) => {
const { refetch } = useListQueryTemplateQuery({
namespace: getK8sNamespace(),
});
const { refetch } = useListQueryTemplateQuery({});
const [isOpen, setIsOpen] = useState(false);
const [hasBeenSaved, setHasBeenSaved] = useState(false);

View File

@@ -8,7 +8,7 @@ const injectedRtkApi = api
endpoints: (build) => ({
listQueryTemplate: build.query<ListQueryTemplateApiResponse, ListQueryTemplateApiArg>({
query: (queryArg) => ({
url: `/apis/peakq.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/querytemplates`,
url: `/querytemplates`,
params: {
pretty: queryArg.pretty,
allowWatchBookmarks: queryArg.allowWatchBookmarks,
@@ -27,9 +27,9 @@ const injectedRtkApi = api
}),
createQueryTemplate: build.mutation<CreateQueryTemplateApiResponse, CreateQueryTemplateApiArg>({
query: (queryArg) => ({
url: `/apis/peakq.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/querytemplates`,
url: `/querytemplates`,
method: 'POST',
body: queryArg.comGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate,
body: queryArg.queryTemplate,
params: {
pretty: queryArg.pretty,
dryRun: queryArg.dryRun,
@@ -41,9 +41,9 @@ const injectedRtkApi = api
}),
deleteQueryTemplate: build.mutation<DeleteQueryTemplateApiResponse, DeleteQueryTemplateApiArg>({
query: (queryArg) => ({
url: `/apis/peakq.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/querytemplates/${queryArg.name}`,
url: `/querytemplates/${queryArg.name}`,
method: 'DELETE',
body: queryArg.ioK8SApimachineryPkgApisMetaV1DeleteOptions,
body: queryArg.deleteOptions,
params: {
pretty: queryArg.pretty,
dryRun: queryArg.dryRun,
@@ -57,9 +57,9 @@ const injectedRtkApi = api
}),
updateQueryTemplate: build.mutation<UpdateQueryTemplateApiResponse, UpdateQueryTemplateApiArg>({
query: (queryArg) => ({
url: `/apis/peakq.grafana.app/v0alpha1/namespaces/${queryArg['namespace']}/querytemplates/${queryArg.name}`,
url: `/querytemplates/${queryArg.name}`,
method: 'PATCH',
body: queryArg.ioK8SApimachineryPkgApisMetaV1Patch,
body: queryArg.patch,
params: {
pretty: queryArg.pretty,
dryRun: queryArg.dryRun,
@@ -74,11 +74,8 @@ const injectedRtkApi = api
overrideExisting: false,
});
export { injectedRtkApi as generatedQueryLibraryApi };
export type ListQueryTemplateApiResponse =
/** status 200 OK */ ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplateList;
export type ListQueryTemplateApiResponse = /** status 200 OK */ QueryTemplateList;
export type ListQueryTemplateApiArg = {
/** object name and auth scope, such as for teams and projects */
namespace: string;
/** 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). */
pretty?: string;
/** 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. */
@@ -123,12 +120,10 @@ export type ListQueryTemplateApiArg = {
watch?: boolean;
};
export type CreateQueryTemplateApiResponse = /** status 200 OK */
| ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate
| /** status 201 Created */ ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate
| /** status 202 Accepted */ ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate;
| QueryTemplate
| /** status 201 Created */ QueryTemplate
| /** status 202 Accepted */ QueryTemplate;
export type CreateQueryTemplateApiArg = {
/** object name and auth scope, such as for teams and projects */
namespace: string;
/** 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). */
pretty?: string;
/** 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 */
@@ -137,16 +132,12 @@ export type CreateQueryTemplateApiArg = {
fieldManager?: string;
/** 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. */
fieldValidation?: string;
comGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate: ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate;
queryTemplate: QueryTemplate;
};
export type DeleteQueryTemplateApiResponse = /** status 200 OK */
| IoK8SApimachineryPkgApisMetaV1Status
| /** status 202 Accepted */ IoK8SApimachineryPkgApisMetaV1Status;
export type DeleteQueryTemplateApiResponse = /** status 200 OK */ Status | /** status 202 Accepted */ Status;
export type DeleteQueryTemplateApiArg = {
/** name of the QueryTemplate */
name: string;
/** object name and auth scope, such as for teams and projects */
namespace: string;
/** 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). */
pretty?: string;
/** 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 */
@@ -159,16 +150,14 @@ export type DeleteQueryTemplateApiArg = {
orphanDependents?: boolean;
/** 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. */
propagationPolicy?: string;
ioK8SApimachineryPkgApisMetaV1DeleteOptions: IoK8SApimachineryPkgApisMetaV1DeleteOptions;
deleteOptions: DeleteOptions;
};
export type UpdateQueryTemplateApiResponse = /** status 200 OK */
| ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate
| /** status 201 Created */ ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate;
| QueryTemplate
| /** status 201 Created */ QueryTemplate;
export type UpdateQueryTemplateApiArg = {
/** name of the QueryTemplate */
name: string;
/** object name and auth scope, such as for teams and projects */
namespace: string;
/** 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). */
pretty?: string;
/** 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 */
@@ -179,17 +168,17 @@ export type UpdateQueryTemplateApiArg = {
fieldValidation?: string;
/** 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. */
force?: boolean;
ioK8SApimachineryPkgApisMetaV1Patch: IoK8SApimachineryPkgApisMetaV1Patch;
patch: Patch;
};
export type IoK8SApimachineryPkgApisMetaV1Time = string;
export type IoK8SApimachineryPkgApisMetaV1FieldsV1 = object;
export type IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry = {
export type Time = string;
export type FieldsV1 = object;
export type ManagedFieldsEntry = {
/** 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. */
apiVersion?: string;
/** FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1" */
fieldsType?: string;
/** FieldsV1 holds the first JSON version format as described in the "FieldsV1" type. */
fieldsV1?: IoK8SApimachineryPkgApisMetaV1FieldsV1;
fieldsV1?: FieldsV1;
/** Manager is an identifier of the workflow managing these fields. */
manager?: string;
/** Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. */
@@ -197,9 +186,9 @@ export type IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry = {
/** 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. */
subresource?: string;
/** 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. */
time?: IoK8SApimachineryPkgApisMetaV1Time;
time?: Time;
};
export type IoK8SApimachineryPkgApisMetaV1OwnerReference = {
export type OwnerReference = {
/** API version of the referent. */
apiVersion: string;
/** 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. */
@@ -213,7 +202,7 @@ export type IoK8SApimachineryPkgApisMetaV1OwnerReference = {
/** UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */
uid: string;
};
export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = {
export type ObjectMeta = {
/** 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 */
annotations?: {
[key: string]: string;
@@ -221,13 +210,13 @@ export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = {
/** 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.
Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata */
creationTimestamp?: IoK8SApimachineryPkgApisMetaV1Time;
creationTimestamp?: Time;
/** 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. */
deletionGracePeriodSeconds?: number;
/** 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.
Populated 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 */
deletionTimestamp?: IoK8SApimachineryPkgApisMetaV1Time;
deletionTimestamp?: Time;
/** 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. */
finalizers?: string[];
/** 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.
@@ -243,7 +232,7 @@ export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = {
[key: string]: string;
};
/** 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. */
managedFields?: IoK8SApimachineryPkgApisMetaV1ManagedFieldsEntry[];
managedFields?: ManagedFieldsEntry[];
/** 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 */
name?: string;
/** 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.
@@ -251,7 +240,7 @@ export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = {
Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces */
namespace?: string;
/** 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. */
ownerReferences?: IoK8SApimachineryPkgApisMetaV1OwnerReference[];
ownerReferences?: OwnerReference[];
/** 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.
Populated 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 */
@@ -263,7 +252,7 @@ export type IoK8SApimachineryPkgApisMetaV1ObjectMeta = {
Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids */
uid?: string;
};
export type ComGithubGrafanaGrafanaPluginSdkGoExperimentalApisDataV0Alpha1DataQuery = {
export type DataQuery = {
/** The datasource */
datasource?: {
/** The apiserver version */
@@ -336,13 +325,13 @@ export type ComGithubGrafanaGrafanaPluginSdkGoExperimentalApisDataV0Alpha1DataQu
};
[key: string]: any;
};
export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplatePosition = {
export type TemplatePosition = {
/** End is the byte offset of the end of the variable. */
end: number;
/** Start is the byte offset within TargetKey's property of the variable. It is the start location for replacements). */
start: number;
};
export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateVariableReplacement = {
export type TemplateVariableReplacement = {
/** How values should be interpolated
Possible enum values:
@@ -356,48 +345,48 @@ export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateVariableReplaceme
/** Path is the location of the property within a target. The format for this is not figured out yet (Maybe JSONPath?). Idea: ["string", int, "string"] where int indicates array offset */
path: string;
/** Positions is a list of where to perform the interpolation within targets during render. The first string is the Idx of the target as a string, since openAPI does not support ints as map keys */
position?: ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplatePosition;
position?: TemplatePosition;
};
export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateTarget = {
export type TemplateTarget = {
/** DataType is the returned Dataplane type from the query. */
dataType?: string;
/** Query target */
properties: ComGithubGrafanaGrafanaPluginSdkGoExperimentalApisDataV0Alpha1DataQuery;
properties: DataQuery;
/** Variables that will be replaced in the query */
variables: {
[key: string]: ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateVariableReplacement[];
[key: string]: TemplateVariableReplacement[];
};
};
export type ComGithubGrafanaGrafanaPkgApimachineryApisCommonV0Alpha1Unstructured = {
export type Unstructured = {
[key: string]: any;
};
export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateTemplateVariable = {
export type TemplateTemplateVariable = {
/** DefaultValue is the value to be used when there is no selected value during render. */
defaultValues?: string[];
/** Key is the name of the variable. */
key: string;
/** ValueListDefinition is the object definition used by the FE to get a list of possible values to select for render. */
valueListDefinition?: ComGithubGrafanaGrafanaPkgApimachineryApisCommonV0Alpha1Unstructured;
valueListDefinition?: Unstructured;
};
export type ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateQueryTemplate = {
export type TemplateQueryTemplate = {
/** Longer description for why it is interesting */
description?: string;
/** Output variables */
targets: ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateTarget[];
targets: TemplateTarget[];
/** A display name */
title?: string;
/** The variables that can be used to render */
vars?: ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateTemplateVariable[];
vars?: TemplateTemplateVariable[];
};
export type ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate = {
export type QueryTemplate = {
/** 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 */
apiVersion?: string;
/** 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 */
kind?: string;
metadata?: IoK8SApimachineryPkgApisMetaV1ObjectMeta;
spec?: ComGithubGrafanaGrafanaPkgApisQueryV0Alpha1TemplateQueryTemplate;
metadata?: ObjectMeta;
spec?: TemplateQueryTemplate;
};
export type IoK8SApimachineryPkgApisMetaV1ListMeta = {
export type ListMeta = {
/** 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. */
continue?: string;
/** 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. */
@@ -407,15 +396,15 @@ export type IoK8SApimachineryPkgApisMetaV1ListMeta = {
/** Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. */
selfLink?: string;
};
export type ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplateList = {
export type QueryTemplateList = {
/** 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 */
apiVersion?: string;
items?: ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate[];
items?: QueryTemplate[];
/** 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 */
kind?: string;
metadata?: IoK8SApimachineryPkgApisMetaV1ListMeta;
metadata?: ListMeta;
};
export type IoK8SApimachineryPkgApisMetaV1StatusCause = {
export type StatusCause = {
/** 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.
Examples:
@@ -427,9 +416,9 @@ export type IoK8SApimachineryPkgApisMetaV1StatusCause = {
/** A machine-readable description of the cause of the error. If this value is empty there is no information available. */
reason?: string;
};
export type IoK8SApimachineryPkgApisMetaV1StatusDetails = {
export type StatusDetails = {
/** The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes. */
causes?: IoK8SApimachineryPkgApisMetaV1StatusCause[];
causes?: StatusCause[];
/** The group attribute of the resource associated with the status StatusReason. */
group?: string;
/** 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 */
@@ -441,31 +430,31 @@ export type IoK8SApimachineryPkgApisMetaV1StatusDetails = {
/** 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 */
uid?: string;
};
export type IoK8SApimachineryPkgApisMetaV1Status = {
export type Status = {
/** 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 */
apiVersion?: string;
/** Suggested HTTP return code for this status, 0 if not set. */
code?: number;
/** 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. */
details?: IoK8SApimachineryPkgApisMetaV1StatusDetails;
details?: StatusDetails;
/** 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 */
kind?: string;
/** A human-readable description of the status of this operation. */
message?: string;
/** Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds */
metadata?: IoK8SApimachineryPkgApisMetaV1ListMeta;
metadata?: ListMeta;
/** 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. */
reason?: string;
/** 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 */
status?: string;
};
export type IoK8SApimachineryPkgApisMetaV1Preconditions = {
export type Preconditions = {
/** Specifies the target ResourceVersion */
resourceVersion?: string;
/** Specifies the target UID. */
uid?: string;
};
export type IoK8SApimachineryPkgApisMetaV1DeleteOptions = {
export type DeleteOptions = {
/** 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 */
apiVersion?: string;
/** 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 */
@@ -479,8 +468,8 @@ export type IoK8SApimachineryPkgApisMetaV1DeleteOptions = {
/** 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. */
orphanDependents?: boolean;
/** Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. */
preconditions?: IoK8SApimachineryPkgApisMetaV1Preconditions;
preconditions?: Preconditions;
/** 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. */
propagationPolicy?: string;
};
export type IoK8SApimachineryPkgApisMetaV1Patch = object;
export type Patch = object;

View File

@@ -2,10 +2,7 @@ import { v4 as uuidv4 } from 'uuid';
import { AddQueryTemplateCommand, QueryTemplate } from '../types';
import {
ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate,
ListQueryTemplateApiResponse,
} from './endpoints.gen';
import { ListQueryTemplateApiResponse, QueryTemplate as QT } from './endpoints.gen';
import { API_VERSION, QueryTemplateKinds } from './query';
import { CREATED_BY_KEY } from './types';
@@ -30,9 +27,7 @@ export const convertDataQueryResponseToQueryTemplates = (result: ListQueryTempla
});
};
export const convertAddQueryTemplateCommandToDataQuerySpec = (
addQueryTemplateCommand: AddQueryTemplateCommand
): ComGithubGrafanaGrafanaPkgApisPeakqV0Alpha1QueryTemplate => {
export const convertAddQueryTemplateCommandToDataQuerySpec = (addQueryTemplateCommand: AddQueryTemplateCommand): QT => {
const { title, targets } = addQueryTemplateCommand;
return {
apiVersion: API_VERSION,

View File

@@ -23,7 +23,7 @@ export const getK8sNamespace = () => config.namespace;
*
* @alpha
*/
export const BASE_URL = `/apis/${API_VERSION}/namespaces/${getK8sNamespace()}/querytemplates`;
export const BASE_URL = `/apis/${API_VERSION}/namespaces/${getK8sNamespace()}`;
interface QueryLibraryBackendRequest extends BackendSrvRequest {
body?: BackendSrvRequest['data'];
@@ -32,7 +32,7 @@ interface QueryLibraryBackendRequest extends BackendSrvRequest {
export const baseQuery: BaseQueryFn<QueryLibraryBackendRequest, unknown, Error> = async (requestOptions) => {
try {
const responseObservable = getBackendSrv().fetch({
url: `${requestOptions.url ?? ''}`,
url: `${BASE_URL}/${requestOptions.url ?? ''}`,
showErrorAlert: true,
method: requestOptions.method || 'GET',
data: requestOptions.body,

View File

@@ -1,12 +1,12 @@
/**
* To generate query library k8s APIs, run:
* `npx rtk-query-codegen-openapi ./public/app/features/query-library/api/scripts/generate-rtk-apis.ts` from the root of the repo
* `yarn process-specs && npx rtk-query-codegen-openapi ./public/app/features/query-library/api/scripts/generate-rtk-apis.ts` from the root of the repo
*/
import { ConfigFile } from '@rtk-query/codegen-openapi';
import { accessSync } from 'fs';
const schemaFile = '../../../../../../data/query-library/openapi.json';
const schemaFile = '../../../../../../data/openapi/peakq.grafana.app-v0alpha1.json';
try {
// Check we have the OpenAPI before generating query library RTK APIs,
@@ -15,7 +15,7 @@ try {
} catch (e) {
console.error('\nCould not find OpenAPI definition.\n');
console.error(
'Please visit /openapi/v3/apis/peakq.grafana.app/v0alpha1 and save the OpenAPI definition to data/query-library/openapi.json\n'
'Please run go test pkg/tests/apis/openapi_test.go to generate the OpenAPI definition, then try running this script again.\n'
);
throw e;
}

143
scripts/process-specs.ts Normal file
View File

@@ -0,0 +1,143 @@
import fs from 'fs';
import { OpenAPIV3 } from 'openapi-types';
import path from 'path';
/**
* Process an OpenAPI spec to remove k8s metadata from names and paths:
* - Remove paths containing "/watch/" as they're deprecated.
* - Remove 'ForAllNamespaces' endpoints
* - Remove the prefix: "/apis/<group>/<version>/namespaces/{namespace}" from paths.
* - Filter out `namespace` from path parameters.
* - Update all $ref fields to remove k8s metadata from schema names.
* - Simplify schema names in "components.schemas".
*/
function processOpenAPISpec(spec: OpenAPIV3.Document) {
// Create a deep copy of the spec to avoid mutating the original
const newSpec = JSON.parse(JSON.stringify(spec));
// Process 'paths' property
const newPaths: Record<string, unknown> = {};
for (const [path, pathItem] of Object.entries<OpenAPIV3.PathItemObject>(newSpec.paths)) {
// Remove 'watch' paths as they're deprecated / remove empty path items
if (path.includes('/watch/') || !pathItem) {
continue;
}
// Remove the specified part from the path key
const newPathKey = path.replace(/^\/apis\/[^\/]+\/[^\/]+\/namespaces\/\{namespace}/, '');
// Process each method in the path (e.g., get, post)
const newPathItem: Record<string, unknown> = {};
for (const method of Object.keys(pathItem)) {
// Filter out the 'namespace' param
if (method === 'parameters' && Array.isArray(pathItem.parameters)) {
pathItem.parameters = pathItem.parameters?.filter((param) => 'name' in param && param.name !== 'namespace');
}
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
const operation = pathItem[method as keyof OpenAPIV3.PathItemObject];
if (
typeof operation === 'object' &&
operation !== null &&
'operationId' in operation &&
operation.operationId?.includes('ForAllNamespaces')
) {
continue;
}
updateRefs(operation);
newPathItem[method] = operation;
}
newPaths[newPathKey] = newPathItem;
}
newSpec.paths = newPaths;
// Process 'components.schemas', i.e., type definitions
const newSchemas: Record<string, unknown> = {};
for (const schemaKey of Object.keys(newSpec.components.schemas)) {
const newKey = simplifySchemaName(schemaKey);
const schemaObject = newSpec.components.schemas[schemaKey];
updateRefs(schemaObject);
newSchemas[newKey] = schemaObject;
}
newSpec.components.schemas = newSchemas;
return newSpec;
}
/**
* Recursively update all $ref fields to remove k8s metadata from names
*/
function updateRefs(obj: unknown) {
if (Array.isArray(obj)) {
for (const item of obj) {
updateRefs(item);
}
} else if (typeof obj === 'object' && obj !== null) {
if ('$ref' in obj && typeof obj.$ref === 'string') {
const refParts = obj.$ref.split('/');
const lastRefPart = refParts[refParts.length - 1];
const newRefName = simplifySchemaName(lastRefPart);
obj.$ref = `#/components/schemas/${newRefName}`;
}
for (const key in obj) {
if (key !== '$ref') {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
updateRefs(obj[key as keyof typeof obj]);
}
}
}
}
/**
* Simplify a schema name by removing the version prefix if present.
* For example, 'io.k8s.apimachinery.pkg.apis.meta.v1.Time' becomes 'Time'.
*/
function simplifySchemaName(schemaName: string) {
const parts = schemaName.split('.');
// Regex to match version segments like 'v1', 'v1beta1', 'v0alpha1', etc.
const versionRegex = /^v\d+[a-zA-Z0-9]*$/;
const versionIndex = parts.findIndex((part) => versionRegex.test(part));
if (versionIndex !== -1 && versionIndex + 1 < parts.length) {
return parts.slice(versionIndex + 1).join('.');
} else {
return schemaName;
}
}
const sourceDir = path.resolve(__dirname, '../pkg/tests/apis/openapi_snapshots');
const outputDir = path.resolve(__dirname, '../data/openapi');
// Create the output directory if it doesn't exist
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir, { recursive: true });
}
const files = fs.readdirSync(sourceDir).filter((file: string) => file.endsWith('.json'));
for (const file of files) {
const inputPath = path.join(sourceDir, file);
const outputPath = path.join(outputDir, file);
console.log(`Processing file "${file}"...`);
const fileContent = fs.readFileSync(inputPath, 'utf-8');
let inputSpec;
try {
inputSpec = JSON.parse(fileContent);
} catch (err) {
console.error(`Invalid JSON file "${file}". Skipping this file.`);
continue;
}
const outputSpec = processOpenAPISpec(inputSpec);
fs.writeFileSync(outputPath, JSON.stringify(outputSpec, null, 2), 'utf-8');
console.log(`Processing completed for file "${file}".`);
}

View File

@@ -18013,6 +18013,7 @@ __metadata:
nx: "npm:19.8.2"
ol: "npm:7.4.0"
ol-ext: "npm:4.0.26"
openapi-types: "npm:^12.1.3"
pluralize: "npm:^8.0.0"
postcss: "npm:8.5.1"
postcss-loader: "npm:8.1.1"
@@ -23503,6 +23504,13 @@ __metadata:
languageName: node
linkType: hard
"openapi-types@npm:^12.1.3":
version: 12.1.3
resolution: "openapi-types@npm:12.1.3"
checksum: 10/9d1d7ed848622b63d0a4c3f881689161b99427133054e46b8e3241e137f1c78bb0031c5d80b420ee79ac2e91d2e727ffd6fc13c553d1b0488ddc8ad389dcbef8
languageName: node
linkType: hard
"opener@npm:^1.5.1, opener@npm:^1.5.2":
version: 1.5.2
resolution: "opener@npm:1.5.2"