feat(docs): add Swagger YAML documentation
							parent
							
								
									1357f495b7
								
							
						
					
					
						commit
						1adb4cc547
					
				|  | @ -0,0 +1,113 @@ | |||
| openapi: 3.0.0 | ||||
| info: | ||||
|   title: Natural Language API | ||||
|   contact: {} | ||||
|   version: '1.0' | ||||
| servers: | ||||
| - url: http://localhost:6001/api/v1/nl/ | ||||
|   variables: {} | ||||
| paths: | ||||
|   /sentiment: | ||||
|     post: | ||||
|       tags: | ||||
|       - API ROUTES | ||||
|       summary: Get sentiment | ||||
|       operationId: Getsentiment | ||||
|       parameters: [] | ||||
|       requestBody: | ||||
|         description: 'The text that will be analyzed' | ||||
|         content: | ||||
|           application/json: | ||||
|             schema: | ||||
|               allOf:  | ||||
|               - example: | ||||
|                   text: Vcs vao fica enrolando ate quando pra entregar isso! | ||||
|             example: | ||||
|               text: Vcs vao fica enrolando ate quando pra entregar isso! | ||||
|         required: true | ||||
|       responses: | ||||
|         '200': | ||||
|           description: '' | ||||
|           headers: {} | ||||
|       deprecated: false | ||||
|       security: | ||||
|       - bearer: [] | ||||
|   /text-to-speech: | ||||
|     get: | ||||
|       tags: | ||||
|       - API ROUTES | ||||
|       summary: Text to speech | ||||
|       operationId: Texttospeech | ||||
|       parameters: | ||||
|       - name: text | ||||
|         in: query | ||||
|         description: 'The text that will be converted to audio' | ||||
|         required: true | ||||
|         style: form | ||||
|         explode: true | ||||
|         schema: | ||||
|           type: string | ||||
|           example: Vela branca na enxurrada la vou eu de léo em léo, se o navio é pequeno do tamanho de um chapeu, não importa a volta ao mundo, é viagem de brinquedo em um barquinho de papel. | ||||
|       - name: voice_name | ||||
|         in: query | ||||
|         description: 'The name of the voice. Ex: pt-BR-Wavenet-C' | ||||
|         required: false | ||||
|         style: form | ||||
|         explode: true | ||||
|         schema: | ||||
|           type: string | ||||
|           example:  | ||||
|       - name: voice_gender | ||||
|         in: query | ||||
|         description: 'The name of the voice. Ex: FEMALE' | ||||
|         required: false | ||||
|         style: form | ||||
|         explode: true | ||||
|         schema: | ||||
|           type: string | ||||
|           example:  | ||||
|       - name: languageCode | ||||
|         in: query | ||||
|         description: 'Ex pt-BR' | ||||
|         required: false | ||||
|         style: form | ||||
|         explode: true | ||||
|         schema: | ||||
|           type: string | ||||
|           example:  | ||||
|       responses: | ||||
|         '200': | ||||
|           description: '' | ||||
|           headers: {} | ||||
|       deprecated: false | ||||
|       security: | ||||
|       - bearer: [] | ||||
|   /voice-config: | ||||
|     get: | ||||
|       tags: | ||||
|       - API ROUTES | ||||
|       summary: Get voice config | ||||
|       operationId: Getvoiceconfig | ||||
|       parameters: | ||||
|       - name: languageCode | ||||
|         in: query | ||||
|         description: 'Ex pt-BR' | ||||
|         required: false | ||||
|         style: form | ||||
|         explode: true | ||||
|         schema: | ||||
|           type: string | ||||
|           example: pt-Br | ||||
|       responses: | ||||
|         '200': | ||||
|           description: '' | ||||
|           headers: {} | ||||
|       deprecated: false | ||||
|       security: | ||||
|       - bearer: [] | ||||
| components:  | ||||
|   securitySchemes: | ||||
|     bearer: | ||||
|       type: http | ||||
|       scheme: bearer | ||||
| security: []  | ||||
		Loading…
	
		Reference in New Issue