add swagger script, update

taikoxyz · Mar 19, 2024 · dd26e7f · dd26e7f
1 parent 3415685
commit dd26e7f
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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
@@ -0,0 +1,3 @@
+#/bin/sh
+
+swag init -g server.go -d pkg/http --parseDependency