microservice_code_translation/openapi.yaml at main · shark-microservices/microservice_code_translation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
openapi: 3.0.3
info:
  version: 1.0.0
  title: Code/Name translation Example
  description: Get translations for a given field and code/name.
tags:
- name: code_translation
paths:
  /translation:
    get:
      operationId: app.get_info
      tags:
      - code_translation
      description: Return a json of code/name translation. The given value can be either "code", "sv" or "en", they will all return the same dictionary.
      parameters:
        - $ref: '#/components/parameters/attribute'
        - $ref: '#/components/parameters/value'
      responses:
        200:
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CodeTranslation'
        404:
          description: Not found
components:
  schemas:
    CodeTranslation:
      type: object
      properties:
        index:
          type: integer
          format: int64
          example: 666
        code:
          type: string
          example: BLK
        field:
          type: string
          example: PROJ
        sv:
          type: string
          example: REG Blekinge SRK
        en:
          type: string
          example: Coordinated recipient monitoring of Blekingekusten
  parameters:
    attribute:
      in: query
      name: attribute
      schema:
        type: string
        example: PROJ
    value:
      in: query
      name: value
      schema:
        type: string
        example: BLK