IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-01-27 00:37:04 -06:00
Code Issues Packages Projects Releases Wiki Activity

Chore: Update OpenAPI generation README to include bingo instructions (#79104)

Browse Source 
* Chore: Update OpenAPI generation README to include bingo instructions

* chore: remove extra whitespace
This commit is contained in:
Kat Yang 2024-01-02 06:48:10 -05:00 committed by GitHub
parent 60fa462a2d
commit 29113a6369
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
pkg/api/README.md
View File

@ -73,10 +73,13 @@ type UpdateServiceAccountResponse struct {
Developers can re-create the OpenAPI v2 and v3 specifications using the following command:
```bash
make swagger-clean && make openapi3-gen
```
They can observe its output into the `public/api-merged.json` and `public/openapi3.json` files.
Finally, they can browser and try out both the OpenAPI v2 and v3 via the Swagger UI editor (served by the grafana server) by navigating to `/swagger`.
If there are any issues generating the specifications (e.g., diff containing unrelated changes to your PR or unusually large diff), please run the following two commands to ensure your Swagger version is up to date, then re-run the make commands.
- `go install github.com/bwplotka/bingo@latest`
- `bingo get swagger`