docker-korektor/api.yaml at master · futuretek-solutions-ltd/docker-korektor · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
openapi: 3.0.3
info:
  title: Korektor Czech Check API
  version: "1.0.0"
  description: |
    Czech spellcheck and correction API using Korektor.
    Returns corrected text and LT-like matches (diff-based).

servers:
  - url: http://localhost:8010

paths:
  /health:
    get:
      summary: Health check
      responses:
        "200":
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    example: true

  /check:
    post:
      summary: Check and suggest corrections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CheckRequest"
      responses:
        "200":
          description: Correction result
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CheckResponse"
        "400":
          description: Invalid request
        "500":
          description: Korektor execution error
        "504":
          description: Korektor timeout

components:
  schemas:
    CheckRequest:
      type: object
      required:
        - text
      properties:
        text:
          type: string
          example: "Tohle je spatne napsana veta."

    CheckResponse:
      type: object
      properties:
        text:
          type: string
          example: "Tohle je spatne napsana veta."
        corrected_text:
          type: string
          example: "Tohle je špatně napsaná veta."
        matches:
          type: array
          items:
            $ref: "#/components/schemas/Match"

    Match:
      type: object
      properties:
        message:
          type: string
          example: 'Replace "spatne" with "spatně".'
        offset:
          type: integer
          example: 8
        length:
          type: integer
          example: 6
        original:
          type: string
          example: "spatne"
        replacement:
          type: string
          example: "spatně"
        issue_type:
          type: string
          enum: [misspelling, punctuation, spacing, unknown]
          example: misspelling