feedback-api/openapi3.yaml at master · MapColonies/feedback-api · 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
openapi: 3.0.1
info:
  title: feedback api
  description: Api to eventually do BI on the data from responses from Geocoding.
  version: 0.2.1
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
paths:
  /feedback:
    post:
      operationId: createFeedback
      tags:
        - feedback
      summary: creates a new record of a chosen result from Geocoding
      parameters:
        - $ref: '#/components/parameters/token'
        - $ref: '#/components/parameters/xApiKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/feedback'
      responses:
        '204':
          description: Feedback has been sent successfully
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BadRequest:
      description: Invalid Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    Unauthorized:
      description: Please provide a valid token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    NotFound:
      description: Resource Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    Forbidden:
      description: Token is not valid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
    InternalError:
      description: Invalid Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error'
  parameters:
    xApiKey:
      name: x-api-key
      in: header
      description: JWT authentication token provided by our team
      schema:
        type: string
    token:
      name: token
      in: query
      description: JWT authentication token provided by our team
      schema:
        type: string
  schemas:
    error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    feedback:
      type: object
      required:
        - request_id
        - chosen_result_id
        - user_id
      properties:
        request_id:
          type: string
        chosen_result_id:
          type: number
          format: int64
        user_id:
          type: string