docs: General API info

dionysia-dev · Apr 8, 2024 · 74b6685 · 74b6685
1 parent 3fbe861
commit 74b6685
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/docs/docs.go b/docs/docs.go
@@ -237,12 +237,12 @@ const docTemplate = `{
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "",
+	Version:          "1.0",
 	Host:             "",
-	BasePath:         "",
+	BasePath:         "/api/v1",
 	Schemes:          []string{},
-	Title:            "",
-	Description:      "",
+	Title:            "Streaming Platform API",
+	Description:      "Manage your streaming workflow",
 	InfoInstanceName: "swagger",
 	SwaggerTemplate:  docTemplate,
 	LeftDelim:        "{{",

diff --git a/docs/swagger.json b/docs/swagger.json
@@ -1,8 +1,12 @@
 {
     "swagger": "2.0",
     "info": {
-        "contact": {}
+        "description": "Manage your streaming workflow",
+        "title": "Streaming Platform API",
+        "contact": {},
+        "version": "1.0"
     },
+    "basePath": "/api/v1",
     "paths": {
         "/inputs": {
             "post": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -1,3 +1,4 @@
+basePath: /api/v1
 definitions:
   api.Error:
     properties:
@@ -40,6 +41,9 @@ definitions:
     type: object
 info:
   contact: {}
+  description: Manage your streaming workflow
+  title: Streaming Platform API
+  version: "1.0"
 paths:
   /inputs:
     post:

diff --git a/internal/api/api.go b/internal/api/api.go
@@ -18,6 +18,11 @@ import (
 	"go.uber.org/zap"
 )
 
+// @title           Streaming Platform API
+// @version         1.0
+// @description     Manage your streaming workflow
+// @BasePath  /api/v1
+
 func New(dbq *db.Queries, _ *zap.SugaredLogger, nh service.NotificationHandler) *gin.Engine {
 	inputController := NewInputController(service.NewInputHandler(dbq))
 	notificationController := NewNotificationController(nh)