feat (SRS-06) : update docs swagger

PickHD · May 8, 2023 · 68ec32d · 68ec32d
1 parent 63ebd14
commit 68ec32d
Show file tree

Hide file tree

Showing 3 changed files with 130 additions and 0 deletions.
diff --git a/shortener/docs/docs.go b/shortener/docs/docs.go
diff --git a/shortener/docs/swagger.json b/shortener/docs/swagger.json
@@ -45,6 +45,55 @@
                     }
                 }
             }
+        },
+        "/{short_url}": {
+            "get": {
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "Shortener"
+                ],
+                "summary": "Click Shorteners URL",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "short urls",
+                        "name": "short_url",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/helper.BaseResponse"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/helper.BaseResponse"
+                        }
+                    },
+                    "404": {
+                        "description": "Not Found",
+                        "schema": {
+                            "$ref": "#/definitions/helper.BaseResponse"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/helper.BaseResponse"
+                        }
+                    }
+                }
+            }
         }
     },
     "definitions": {

diff --git a/shortener/docs/swagger.yaml b/shortener/docs/swagger.yaml
@@ -29,6 +29,38 @@ info:
   title: Singkatin Revamp API
   version: "1.0"
 paths:
+  /{short_url}:
+    get:
+      consumes:
+      - application/json
+      parameters:
+      - description: short urls
+        in: path
+        name: short_url
+        required: true
+        type: string
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/helper.BaseResponse'
+        "400":
+          description: Bad Request
+          schema:
+            $ref: '#/definitions/helper.BaseResponse'
+        "404":
+          description: Not Found
+          schema:
+            $ref: '#/definitions/helper.BaseResponse'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/helper.BaseResponse'
+      summary: Click Shorteners URL
+      tags:
+      - Shortener
   /health-check:
     get:
       consumes: