Tobias Skarhed
d1064da4cd
* Scopes API client * Initial RTK query commit * Copy API client from generated enterprise folder * Mock ScopesApiClient for integration tests * Update e2e tests * Handle group expansion for dashboard navigation * Extract integration test mocks * Move mock to only be for integration tests * Update path for enterprise sync script * Re-export mockData * Disregard caching for search * Leave name parameters empty * Disable subscriptions for client requests * Add functionality to reset cache between mocked requests * Use grafana-test-utils for scopes integration tests * Rollback mock setup * Remove store form window object * Remove cache helper * Restore scopenode search functionality * Improve request erro handling * Clean up subscription in case subscription: false lies * Fix logging security risk * Rewrite tests to cover RTK query usage and improve error catching * Update USE_LIVE_DATA to be consistent * Remove unused timout parameter * Fix error handling * Make dashboard-navigation test pass
Grafana API Clients
@grafana/api-clients is currently in BETA.
This package hosts reusable clients for Grafana APIs. The implementation is currently in BETA and not yet published.
Generating RTK Query API Clients
This guide explains how to generate API clients for Grafana APIs using this package.
1. Generate an OpenAPI snapshot
First, check if the group and the version are already present in openapi_test.go. If so, move on to the next step. If you need to add a new block, you can check for the right group and version in the backend API call that you want to replicate in the frontend.
{
Group: "dashboard.grafana.app",
Version: "v0alpha1",
}
Afterwards, you need to run the TestIntegrationOpenAPIs test with go test ./pkg/tests/apis -run TestIntegrationOpenAPIs. Note that it will fail the first time you run it. On the second run, it will generate the corresponding OpenAPI spec, which you can find in openapi_snapshots.
Note: You don't need to follow these two steps if the
groupyou're working with is already in theopenapi_test.gofile.
2. Run the API generator script
Run yarn generate:api-client and follow the prompts. See API Client Generator for details.
Updating generated clients
To update the existing clients, for example, when the OpenAPI spec has changed, run yarn generate-apis. This will regenerate all the clients based on the current OpenAPI snapshots.