From 8e85a7f259279b7fe493bb936f9869629d184854 Mon Sep 17 00:00:00 2001 From: Arya Kiran Date: Sun, 27 Aug 2023 21:43:29 +0530 Subject: [PATCH] update dockerfile, ignore docs --- .gitignore | 5 +- Dockerfile | 2 + docs/docs.go | 187 ---------------------------------------------- docs/swagger.json | 157 -------------------------------------- docs/swagger.yaml | 102 ------------------------- 5 files changed, 6 insertions(+), 447 deletions(-) delete mode 100644 docs/docs.go delete mode 100644 docs/swagger.json delete mode 100644 docs/swagger.yaml diff --git a/.gitignore b/.gitignore index 11761ae..5492257 100644 --- a/.gitignore +++ b/.gitignore @@ -18,9 +18,12 @@ # Dependency directories (remove the comment below to include it) # vendor/ -# Simplytranslate binary (on linux and mac) +# Mozhi binary (on linux and mac) /mozhi +# Auto-generated Documentation +/docs + # Go workspace file go.work diff --git a/Dockerfile b/Dockerfile index 45e07e2..467881c 100644 --- a/Dockerfile +++ b/Dockerfile @@ -7,6 +7,8 @@ RUN apk --no-cache add git ca-certificates COPY . . RUN go mod download +RUN go install github.com/swaggo/swag/cmd/swag@latest +RUN swag init RUN GOOS=linux GOARCH=$TARGETARCH go build -o /src/mozhi FROM alpine:3.16 as bin diff --git a/docs/docs.go b/docs/docs.go deleted file mode 100644 index 3ae5849..0000000 --- a/docs/docs.go +++ /dev/null @@ -1,187 +0,0 @@ -// Code generated by swaggo/swag. DO NOT EDIT. - -package docs - -import "github.com/swaggo/swag" - -const docTemplate = `{ - "schemes": {{ marshal .Schemes }}, - "swagger": "2.0", - "info": { - "description": "{{escape .Description}}", - "title": "{{.Title}}", - "contact": {}, - "version": "{{.Version}}" - }, - "host": "{{.Host}}", - "basePath": "{{.BasePath}}", - "paths": { - "/api/source_languages": { - "get": { - "summary": "Show list of available source languages for engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.List" - } - } - } - } - }, - "/api/target_languages": { - "get": { - "summary": "Show list of available target languages for engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.List" - } - } - } - } - }, - "/api/translate": { - "get": { - "summary": "Translate text", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Source language", - "name": "from", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Target language", - "name": "to", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Text being translated", - "name": "text", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.LangOut" - } - } - } - } - }, - "/api/tts": { - "get": { - "summary": "Get Text-To-Speech for specified language using specified engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Language being TTS'd", - "name": "lang", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Text being TTS'd", - "name": "text", - "in": "query", - "required": true - } - ], - "responses": {} - } - } - }, - "definitions": { - "utils.LangOut": { - "type": "object", - "properties": { - "detected": { - "type": "string" - }, - "engine": { - "type": "string" - }, - "source_language": { - "type": "string" - }, - "target_language": { - "type": "string" - }, - "translated-text": { - "type": "string" - } - } - }, - "utils.List": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } -}` - -// SwaggerInfo holds exported Swagger Info so clients can modify it -var SwaggerInfo = &swag.Spec{ - Version: "", - Host: "", - BasePath: "", - Schemes: []string{}, - Title: "", - Description: "", - InfoInstanceName: "swagger", - SwaggerTemplate: docTemplate, - LeftDelim: "{{", - RightDelim: "}}", -} - -func init() { - swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) -} diff --git a/docs/swagger.json b/docs/swagger.json deleted file mode 100644 index ef89e62..0000000 --- a/docs/swagger.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "contact": {} - }, - "paths": { - "/api/source_languages": { - "get": { - "summary": "Show list of available source languages for engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.List" - } - } - } - } - }, - "/api/target_languages": { - "get": { - "summary": "Show list of available target languages for engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.List" - } - } - } - } - }, - "/api/translate": { - "get": { - "summary": "Translate text", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Source language", - "name": "from", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Target language", - "name": "to", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Text being translated", - "name": "text", - "in": "query", - "required": true - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/utils.LangOut" - } - } - } - } - }, - "/api/tts": { - "get": { - "summary": "Get Text-To-Speech for specified language using specified engine", - "parameters": [ - { - "type": "string", - "description": "Engine name", - "name": "engine", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Language being TTS'd", - "name": "lang", - "in": "query", - "required": true - }, - { - "type": "string", - "description": "Text being TTS'd", - "name": "text", - "in": "query", - "required": true - } - ], - "responses": {} - } - } - }, - "definitions": { - "utils.LangOut": { - "type": "object", - "properties": { - "detected": { - "type": "string" - }, - "engine": { - "type": "string" - }, - "source_language": { - "type": "string" - }, - "target_language": { - "type": "string" - }, - "translated-text": { - "type": "string" - } - } - }, - "utils.List": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - } - } - } - } -} \ No newline at end of file diff --git a/docs/swagger.yaml b/docs/swagger.yaml deleted file mode 100644 index 2df4ee9..0000000 --- a/docs/swagger.yaml +++ /dev/null @@ -1,102 +0,0 @@ -definitions: - utils.LangOut: - properties: - detected: - type: string - engine: - type: string - source_language: - type: string - target_language: - type: string - translated-text: - type: string - type: object - utils.List: - properties: - id: - type: string - name: - type: string - type: object -info: - contact: {} -paths: - /api/source_languages: - get: - parameters: - - description: Engine name - in: query - name: engine - required: true - type: string - responses: - "200": - description: OK - schema: - $ref: '#/definitions/utils.List' - summary: Show list of available source languages for engine - /api/target_languages: - get: - parameters: - - description: Engine name - in: query - name: engine - required: true - type: string - responses: - "200": - description: OK - schema: - $ref: '#/definitions/utils.List' - summary: Show list of available target languages for engine - /api/translate: - get: - parameters: - - description: Engine name - in: query - name: engine - required: true - type: string - - description: Source language - in: query - name: from - required: true - type: string - - description: Target language - in: query - name: to - required: true - type: string - - description: Text being translated - in: query - name: text - required: true - type: string - responses: - "200": - description: OK - schema: - $ref: '#/definitions/utils.LangOut' - summary: Translate text - /api/tts: - get: - parameters: - - description: Engine name - in: query - name: engine - required: true - type: string - - description: Language being TTS'd - in: query - name: lang - required: true - type: string - - description: Text being TTS'd - in: query - name: text - required: true - type: string - responses: {} - summary: Get Text-To-Speech for specified language using specified engine -swagger: "2.0"