From 29113a63698d301624ed158cabe4d23b8bff0937 Mon Sep 17 00:00:00 2001
From: Kat Yang <69819079+yangkb09@users.noreply.github.com>
Date: Tue, 2 Jan 2024 06:48:10 -0500
Subject: [PATCH] Chore: Update OpenAPI generation README to include bingo
 instructions (#79104)

* Chore: Update OpenAPI generation README to include bingo instructions

* chore: remove extra whitespace
---
 pkg/api/README.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/pkg/api/README.md b/pkg/api/README.md
index 8a6dd8c23cd..1449c6077b6 100644
--- a/pkg/api/README.md
+++ b/pkg/api/README.md
@@ -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`
\ No newline at end of file