grafana

Files

T

Marco de Abreu c47ab101d1 Dashboards: Add Dashboard Schema validation (2) (#103844 )

* Activate schema validation and align underlying systems

* update to save as v0 if not the right schema version

* Resolve merge conflicts

* Move RequireApiErrorStatus to tests package

* Add mutation tests

* Fix lint

* Only do min version check if dashboard is v1

* Fix lint and disable provisioning test

* Revert provisioning changes

* Revert more tests and add schema test

* Reran gen

* SQL Dashboard save

* Adjust APIVERSION

* Fixed mutation test

* Add logging on downgrade

---------

Co-authored-by: Marco de Abreu <18629099+marcoabreu@users.noreply.github.com>
Co-authored-by: Stephanie Hingtgen <stephanie.hingtgen@grafana.com>

2025-04-11 23:05:41 +02:00

advisor.grafana.app-v0alpha1.json

Auto-generate cli for advisor.grafana.app (#103465 )

2025-04-08 16:38:19 +02:00

dashboard.grafana.app-v0alpha1.json

Dashboards: Only expose LibraryPanels and search on v0 (not v1+v2) (#103335 )

2025-04-03 20:24:12 +03:00

dashboard.grafana.app-v1alpha1.json

Dashboards: Only expose LibraryPanels and search on v0 (not v1+v2) (#103335 )

2025-04-03 20:24:12 +03:00

dashboard.grafana.app-v2alpha1.json

Dashboards: Add Dashboard Schema validation (2) (#103844 )

2025-04-11 23:05:41 +02:00

folder.grafana.app-v0alpha1.json

K8s/Swagger: Avoid */* media type (#101658 )

2025-03-06 10:13:31 +03:00

folder.grafana.app-v1.json

K8s: Folders: Add v1 api (#103842 )

2025-04-11 13:09:52 +01:00

iam.grafana.app-v0alpha1.json

K8s/Swagger: Avoid */* media type (#101658 )

2025-03-06 10:13:31 +03:00

investigations.grafana.app-v0alpha1.json

Investigations: add fieldConfig and queries (#103276 )

2025-04-02 15:42:32 +02:00

provisioning.grafana.app-v0alpha1.json

Provisioning: return field paths in test error messages (#103850 )

2025-04-11 14:26:42 +01:00

README.md

Query Library: Update API client (#99382 )

2025-01-29 18:05:40 +02:00

README.md

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.

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:

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:
```
'../public/app/features/dashboards/api/endpoints.gen.ts': {
  schemaFile: '../data/openapi/dashboard.grafana.app-v0alpha1.json',
},
```
Generate or update the OpenAPI spec files by running:
```
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.
Run:
```
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:

yarn process-specs