opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 04:12:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/pkg/tests/apis/openapi_snapshots/README.md
Alex Khomenko 9f4e8ee206 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>
2025-01-29 18:05:40 +02:00

1.6 KiB
Raw Blame History

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:

  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:

    '../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:

    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:

    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