Geocoding-Enrichment/openapi3.yaml at master · MapColonies/Geocoding-Enrichment · 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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
openapi: 3.0.1
info:
  title: Geocoding Enrichment
  description: Enriches the data that comes back from a geocoding response
  version: 1.6.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
paths:
  /process:
    post:
      operationId: process
      tags:
        - process
      summary: Process a response
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - requestId
                - chosenResultId
                - responseTime
                - geocodingResponse
              properties:
                requestId:
                  type: string
                chosenResultId:
                  oneOf:
                    - type: number
                      nullable: true
                responseTime:
                  type: string
                  format: date-time
                geocodingResponse:
                  $ref: '#/components/schemas/geocodingResponse'
      responses:
        '200':
          description: processed
          content:
            application/json:
              schema:
                type: object
                required:
                  - user
                  - query
                  - result
                  - system
                  - site
                  - duration
                properties:
                  user:
                    type: object
                    required:
                      - name
                    properties:
                      name:
                        type: string
                  query:
                    type: object
                    required:
                      - text
                      - language
                    properties:
                      text:
                        type: string
                      language:
                        type: string
                  result:
                    type: object
                    required:
                      - rank
                      - score
                      - source
                      - layer
                      - name
                    properties:
                      rank:
                        type: integer
                      score:
                        type: number
                      source:
                        type: string
                      layer:
                        type: string
                      name:
                        type: string
                  system:
                    type: string
                  site:
                    type: string
                  duration:
                    type: number
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    geocodingResponse:
      type: object
      required:
        - apiKey
        - site
        - response
        - respondedAt
      properties:
        userId:
          type: string
        apiKey:
          type: string
        site:
          type: string
        respondedAt:
          type: string
          format: date-time
        geocodingResponse:
          type: object
          required:
            - type
            - features
            - geocoding
          properties:
            type:
              type: string
              enum:
                - FeatureCollection
            features:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - Feature
                  properties:
                    type: object
                    properties:
                      type:
                        type: string
                      source:
                        type: string
                      layer:
                        type: string
                      name:
                        type: object
                        properties:
                          default:
                            type: string
                      _score:
                        type: integer
            geocoding:
              type: object
              required:
                - query
                - response
              properties:
                version:
                  type: string
                  pattern: ^\d{3}\.\d{3}\.\d{3}$
                  example: 1.5.3
                query:
                  type: object
                  properties:
                    text:
                      type: string
                    limit:
                      type: integer
                    geo_context:
                      type: string
                    disable_fuzziness:
                      type: boolean
    errorSchema:
      type: object
      required:
        - message
      properties:
        message:
          type: string
        status:
          type: number
  responses:
    BadRequest:
      description: Invalid Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorSchema'
    InternalError:
      description: Invalid Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/errorSchema'