WebService/apiSpec.yaml at v2 · TextyML/WebService · 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
98
99
100
101
102
103
104
swagger: '2.0'
info:
  version: "1.0"
  title: {{title}}
consumes:
  - application/json
produces:
  - application/json
paths:
  /get_feature:
    post:
      summary: Sende Rohdaten zum analysieren. Der User erhält als Antwort ein Ticket.
      parameters:
        - name: request
          in: body
          description: Feature Request
          required: true
          schema:
            $ref: '#/definitions/FeatureRequest'
      responses:
        200:
          description: Liefere alle analysierten Merkmale zurück
          schema:
            $ref: '#/definitions/TicketResponse'
        500:
          description: Server Error
          schema:
            $ref: '#/definitions/Error'

  /get_feature/{ticket_id}:
    get:
      summary: Nutze das Ticket um die Antwort abzuholen
      parameters:
        - $ref: '#/parameters/ticket_id'
      responses:
        200:
          description : Successfull request
          schema:
            type: array
            items:
              type: array
              items:
                $ref: '#/definitions/FeatureResponse'

        404:
          description: Ticket not found
          schema:
            $ref: '#/definitions/Error'

        500:
          description: Server Error
          schema:
            $ref: '#/definitions/Error'

# Added by API Auto Mocking Plugin
basePath: /v1/
schemes:
 - https

parameters:
  ticket_id:
    name: ticket_id
    description: Ticket's Unique identifier
    in: path
    type: string
    required: true
    pattern: "^[a-zA-Z0-9-]+$"

definitions:
  FeatureRequest:
    type: array
    items:
      type: string
      description: Der Text zum analysieren

  FeatureResponse:
    type: object
    properties:
      name:
        type: string
        description: Name des Merkmals
      value:
        type: number
        description: Wert des Merksmals

  TicketResponse:
    type: object
    properties:
      ticketID:
        type: number
        description: Ticketnummer
      url:
        type: string
        description: Direkter Link zur Statusabfrage

  Error:
    type: object
    properties:
      name:
        type: string
        description: Name des Fehlers
      description:
        type: string
        description: Beschreibung des Fehlers