mozhi/docs/swagger.yaml

181 lines
4.1 KiB
YAML
Raw Normal View History

definitions:
2024-04-14 18:41:18 +05:30
libmozhi.ImgOut:
properties:
sourceB64:
type: string
sourceLang:
type: string
sourceTextParsed:
type: string
targetLang:
type: string
translatedImgB64:
type: string
translatedTextParsed:
type: string
type: object
libmozhi.LangOut:
properties:
detected:
type: string
engine:
type: string
source_language:
type: string
2024-04-14 18:41:18 +05:30
source_transliteration:
type: string
target_language:
type: string
2024-04-14 18:41:18 +05:30
target_transliteration:
type: string
translated-text:
type: string
2023-11-12 11:48:52 +05:30
word_choices:
items:
$ref: '#/definitions/libmozhi.WordChoices'
type: array
type: object
libmozhi.List:
properties:
id:
type: string
name:
type: string
type: object
2023-11-12 11:48:52 +05:30
libmozhi.WordChoices:
properties:
examples_source:
items:
type: string
type: array
examples_target:
items:
type: string
type: array
word:
type: string
type: object
info:
contact: {}
paths:
/api/engines:
get:
description: Lists available Engines.
responses:
"200":
description: OK
schema:
additionalProperties:
type: string
type: object
summary: List engines
2024-04-14 18:41:18 +05:30
/api/image:
post:
description: When engine is set to all, it will return an array of libmozhi.LangOut.
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: PNG image in base64 format
in: query
name: image
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/libmozhi.ImgOut'
summary: Translate an image
/api/source_languages:
get:
parameters:
- description: Engine name
in: query
name: engine
required: true
type: string
responses:
"200":
description: OK
schema:
$ref: '#/definitions/libmozhi.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/libmozhi.List'
summary: Show list of available target languages for engine
/api/translate:
get:
description: When engine is set to all, it will return an array of libmozhi.LangOut.
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/libmozhi.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"