From dd26e7ffbe2d3b495f2710be697223f0d5c8542d Mon Sep 17 00:00:00 2001 From: RogerLamTd Date: Tue, 19 Mar 2024 16:48:13 -0700 Subject: [PATCH] add swagger script, update --- packages/blobstorage/docs/docs.go | 2 +- packages/blobstorage/docs/swagger.json | 2 +- packages/blobstorage/docs/swagger.yaml | 2 +- packages/blobstorage/scripts/swagger.sh | 3 +++ 4 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 packages/blobstorage/scripts/swagger.sh diff --git a/packages/blobstorage/docs/docs.go b/packages/blobstorage/docs/docs.go index b466ddcd64..3e482f062c 100644 --- a/packages/blobstorage/docs/docs.go +++ b/packages/blobstorage/docs/docs.go @@ -31,7 +31,7 @@ const docTemplate = `{ "produces": [ "application/json" ], - "summary": "Get blob and KZG commitment", + "summary": "Get blob(s) and KZG commitment(s)", "operationId": "get-blob", "parameters": [ { diff --git a/packages/blobstorage/docs/swagger.json b/packages/blobstorage/docs/swagger.json index 096123e4ec..7a837a7c8a 100644 --- a/packages/blobstorage/docs/swagger.json +++ b/packages/blobstorage/docs/swagger.json @@ -19,7 +19,7 @@ "get": { "consumes": ["application/json"], "produces": ["application/json"], - "summary": "Get blob and KZG commitment", + "summary": "Get blob(s) and KZG commitment(s)", "operationId": "get-blob", "parameters": [ { diff --git a/packages/blobstorage/docs/swagger.yaml b/packages/blobstorage/docs/swagger.yaml index d905b03d6e..8608afd282 100644 --- a/packages/blobstorage/docs/swagger.yaml +++ b/packages/blobstorage/docs/swagger.yaml @@ -43,5 +43,5 @@ paths: description: OK schema: $ref: "#/definitions/http.getBlobResponse" - summary: Get blob and KZG commitment + summary: Get blob(s) and KZG commitment(s) swagger: "2.0" diff --git a/packages/blobstorage/scripts/swagger.sh b/packages/blobstorage/scripts/swagger.sh new file mode 100644 index 0000000000..2ba0cac2c3 --- /dev/null +++ b/packages/blobstorage/scripts/swagger.sh @@ -0,0 +1,3 @@ +#/bin/sh + +swag init -g server.go -d pkg/http --parseDependency \ No newline at end of file