blitzwing/mozhi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

guess i have to add docs to the repo itself

Browse source
This commit is contained in:
Arya Kiran 2023-08-27 21:53:49 +05:30
parent 8e85a7f259
commit e23e61adfd
No known key found for this signature in database
GPG key ID: 842D12BDA50DF120
4 changed files with 449 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

188
docs/docs.go Normal file
View file

@ -0,0 +1,188 @@
// 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": {
"description": "When engine is set to all, it will return an array of utils.LangOut.",
"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)
}