diff --git a/static/openapi/vector/geocoding-openapi.yaml b/static/openapi/vector/geocoding-openapi.yaml index 0d8e5ca21..660cb48f7 100644 --- a/static/openapi/vector/geocoding-openapi.yaml +++ b/static/openapi/vector/geocoding-openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - version: 0.2.0 + version: 0.2.2 title: Geocoding description: >- MapColonies Vector Geocoding api provides custom geodata search engine @@ -433,6 +433,9 @@ paths: geocoding: type: object properties: + version: + type: string + example: '1.5.3' query: type: object properties: @@ -440,13 +443,18 @@ paths: type: number lon: type: number + target_grid: + type: string + example: control response: type: object properties: max_score: type: number + example: 1 results_count: type: number + example: 1 match_latency_ms: type: number bbox: @@ -458,8 +466,39 @@ paths: properties: type: object properties: - name: - type: string + score: + type: number + example: 1 + matches: + type: array + items: + type: object + required: + - source + - layer + - source_id + properties: + layer: + type: string + example: 'MGRS' + source: + type: string + example: 'npm/mgrs' + source_id: + type: array + items: + type: string + names: + type: object + properties: + default: + type: array + items: + type: string + display: + type: string + additionalProperty1: + type: object additionalProperty1: type: object '400': @@ -592,13 +631,13 @@ components: type: object required: - TYPE - - tile_name + - TILE_NAME properties: TYPE: type: string - tile_name: + TILE_NAME: type: string - sub_tile_id: + SUB_TILE_ID: type: string SUB_TILE_NUMBER: type: array @@ -618,6 +657,9 @@ components: geocoding: type: object properties: + version: + type: string + example: '1.5.3' query: type: object properties: @@ -629,8 +671,10 @@ components: properties: max_score: type: number + example: 1 results_count: type: number + example: 1 match_latency_ms: type: number bbox: @@ -639,11 +683,37 @@ components: oneOf: - $ref: '#/components/schemas/Point' - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/MultiPolygon' properties: type: object properties: + matches: + type: array + items: + type: object + properties: + layer: + type: string + example: 'MGRS' + source: + type: string + example: 'npm/mgrs' + source_id: + type: array + items: + type: string + names: + type: object + properties: + default: + type: array + items: + type: string + display: + type: string score: type: number + example: 1 tilesSchema: allOf: - $ref: '#/components/schemas/genericGeocodingResponse' @@ -687,19 +757,19 @@ components: type: object required: - TYPE - - object_command_name - - entity_heb - - sub_tile_id + - OBJECT_COMMAND_NAME + - ENTITY_HEB + - SUB_TILE_ID properties: TYPE: type: string - object_command_name: + OBJECT_COMMAND_NAME: type: string - entity_heb: + ENTITY_HEB: type: string - tile_name: + TILE_NAME: type: string - sub_tile_id: + SUB_TILE_ID: type: string routesSchema: allOf: @@ -729,14 +799,14 @@ components: type: object required: - TYPE - - object_command_name - - entity_heb + - OBJECT_COMMAND_NAME + - ENTITY_HEB properties: TYPE: type: string - object_command_name: + OBJECT_COMMAND_NAME: type: string - entity_heb: + ENTITY_HEB: type: string SECTION: type: string @@ -825,8 +895,6 @@ components: maximum: 100 matches: type: array - minItems: 1 - maxItems: 100 items: type: object required: @@ -1002,6 +1070,7 @@ components: type: number minLength: 4 maxLength: 6 + nullable: true WGS84Circle: type: object properties: