Skip to content

Fix: malformed openapi #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NivGreenstein merged 3 commits into from
Oct 19, 2024
Merged

Fix: malformed openapi #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
213ce15
fix(openapi): created geo_context_mode schema and reference it correctly
NivGreenstein Oct 19, 2024
f5ff371
fix(openapi): changed double quotes to single quotes
NivGreenstein Oct 19, 2024
a2d9da1
fix: added missing configuration property
NivGreenstein Oct 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/default.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
}
},
"application": {
"site": "local",
"services": {
"tokenTypesUrl": "http://NLP_ANALYSES"
},
Expand Down
1 change: 1 addition & 0 deletions config/test.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
}
},
"application": {
"site": "test",
"services": {
"tokenTypesUrl": "http://localhost:5001/NLP_ANALYSES"
},
Expand Down
167 changes: 84 additions & 83 deletions openapi3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,32 +112,32 @@ paths:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/genericGeocodingResponse"
- type: "object"
- '$ref': '#/components/schemas/genericGeocodingResponse'
- type: 'object'
required:
- "type"
- "features"
- 'type'
- 'features'
properties:
type:
type: "string"
type: 'string'
enum:
- "FeatureCollection"
- 'FeatureCollection'
features:
type: "array"
type: 'array'
items:
type: "object"
type: 'object'
properties:
geometry:
oneOf:
- $ref: "#/components/schemas/Point"
- $ref: "#/components/schemas/Polygon"
- $ref: '#/components/schemas/Point'
- $ref: '#/components/schemas/Polygon'
properties:
type: "object"
type: 'object'
properties:
placetype:
type: "string"
type: 'string'
sub_placetype:
type: "string"
type: 'string'
400:
'$ref': '#/components/responses/BadRequest'
401:
Expand Down Expand Up @@ -423,21 +423,21 @@ paths:
type: object
properties:
type:
type: "string"
type: 'string'
enum:
- "Feature"
- 'Feature'
geocoding:
type: "object"
type: 'object'
properties:
query:
type: "object"
type: 'object'
properties:
lat:
type: number
lon:
type: number
response:
type: "object"
type: 'object'
properties:
max_score:
type: number
Expand All @@ -446,11 +446,11 @@ paths:
match_latency_ms:
type: number
bbox:
$ref: "#/components/schemas/BoundingBox"
$ref: '#/components/schemas/BoundingBox'
geometry:
oneOf:
- $ref: "#/components/schemas/Point"
- $ref: "#/components/schemas/Polygon"
- $ref: '#/components/schemas/Point'
- $ref: '#/components/schemas/Polygon'
properties:
type: object
properties:
Expand Down Expand Up @@ -538,9 +538,7 @@ components:
in: 'query'
description: 'Choose whether geo_context query parameter will be a filter or a bias value'
schema:
type: string
enum: ['filter', 'bias']

$ref: '#/components/schemas/geo_context_mode'
schemas:
errorSchema:
type: 'object'
Expand Down Expand Up @@ -600,20 +598,20 @@ components:
type: 'object'
properties:
type:
type: "string"
type: 'string'
enum:
- "Feature"
- 'Feature'
geocoding:
type: "object"
type: 'object'
properties:
query:
type: "object"
type: 'object'
properties:
tile:
type: string
example: "18SUJ2339007393"
example: '18SUJ2339007393'
response:
type: "object"
type: 'object'
properties:
max_score:
type: number
Expand All @@ -623,110 +621,110 @@ components:
type: number

bbox:
$ref: "#/components/schemas/BoundingBox"
$ref: '#/components/schemas/BoundingBox'
geometry:
oneOf:
- $ref: "#/components/schemas/Point"
- $ref: "#/components/schemas/Polygon"
- $ref: '#/components/schemas/Point'
- $ref: '#/components/schemas/Polygon'
properties:
type: object
properties:
score:
type: number
tilesSchema:
allOf:
- $ref: "#/components/schemas/genericGeocodingResponse"
- type: "object"
description: "GeoJson feature collection representing a tile (Polygon)"
- $ref: '#/components/schemas/genericGeocodingResponse'
- type: 'object'
description: 'GeoJson feature collection representing a tile (Polygon)'
required:
- "type"
- "features"
- 'type'
- 'features'
properties:
type:
type: "string"
type: 'string'
enum:
- "FeatureCollection"
- 'FeatureCollection'
features:
type: "array"
type: 'array'
items:
$ref: "#/components/schemas/tileSchema"
$ref: '#/components/schemas/tileSchema'
itemsSchema:
allOf:
- $ref: "#/components/schemas/genericGeocodingResponse"
- type: "object"
description: "GeoJson feature collection representing an item"
- $ref: '#/components/schemas/genericGeocodingResponse'
- type: 'object'
description: 'GeoJson feature collection representing an item'
required:
- "type"
- "features"
- 'type'
- 'features'
properties:
type:
type: "string"
type: 'string'
enum:
- "FeatureCollection"
- 'FeatureCollection'
features:
type: "array"
type: 'array'
items:
type: "object"
type: 'object'
properties:
geometry:
oneOf:
- $ref: "#/components/schemas/Point"
- $ref: "#/components/schemas/Polygon"
- $ref: '#/components/schemas/Point'
- $ref: '#/components/schemas/Polygon'
properties:
type: "object"
type: 'object'
required:
- "TYPE"
- "object_command_name"
- "entity_heb"
- "sub_tile_id"
- 'TYPE'
- 'object_command_name'
- 'entity_heb'
- 'sub_tile_id'
properties:
TYPE:
type: "string"
type: 'string'
object_command_name:
type: "string"
type: 'string'
entity_heb:
type: "string"
type: 'string'
tile_name:
type: "string"
type: 'string'
sub_tile_id:
type: "string"
type: 'string'
routesSchema:
allOf:
- $ref: "#/components/schemas/genericGeocodingResponse"
- type: "object"
description: "GeoJson feature collection representing a route (MultiLineString, LineString)"
- $ref: '#/components/schemas/genericGeocodingResponse'
- type: 'object'
description: 'GeoJson feature collection representing a route (MultiLineString, LineString)'
required:
- "type"
- "features"
- 'type'
- 'features'
properties:
type:
type: "string"
type: 'string'
enum:
- "FeatureCollection"
- 'FeatureCollection'
features:
type: "array"
type: 'array'
items:
type: "object"
type: 'object'
properties:
geometry:
oneOf:
- $ref: "#/components/schemas/LineString"
- $ref: "#/components/schemas/MultiLineString"
- $ref: '#/components/schemas/LineString'
- $ref: '#/components/schemas/MultiLineString'
properties:
type: "object"
type: 'object'
required:
- "TYPE"
- "object_command_name"
- "entity_heb"
- 'TYPE'
- 'object_command_name'
- 'entity_heb'
properties:
TYPE:
type: "string"
type: 'string'
object_command_name:
type: "string"
type: 'string'
entity_heb:
type: "string"
type: 'string'
SECTION:
type: "string"
type: 'string'
genericGeocodingResponse: # we need discriminator for Control and Location
type: 'object'
description: 'GeoJson feature collection representing an item'
Expand Down Expand Up @@ -764,7 +762,7 @@ components:
geo_context:
$ref: '#/components/schemas/geo_context'
geo_context_mode:
$ref: '#/components/parameters/geo_context_mode'
$ref: '#/components/schemas/geo_context_mode'
disable_fuzziness:
$ref: '#/components/schemas/disable_fuzziness'
response:
Expand Down Expand Up @@ -1019,6 +1017,9 @@ components:
$ref: '#/components/schemas/BoundingBox'
- $ref: '#/components/schemas/WGS84Circle'
- $ref: '#/components/schemas/UTMCircle'
geo_context_mode:
type: string
enum: ['filter', 'bias']
disable_fuzziness:
type: boolean
default: false
Expand Down