From 758751458436a04234abceaf94206b696795e777 Mon Sep 17 00:00:00 2001 From: Tom Kralidis Date: Thu, 3 Oct 2024 14:23:34 +0000 Subject: [PATCH] Updating OpenAPI build --- ...nvironmental-data-retrieval-1.bundled.json | 4735 +++++++++++++++++ 1 file changed, 4735 insertions(+) create mode 100644 ogcapi-environmental-data-retrieval-1.bundled.json diff --git a/ogcapi-environmental-data-retrieval-1.bundled.json b/ogcapi-environmental-data-retrieval-1.bundled.json new file mode 100644 index 00000000..0304f106 --- /dev/null +++ b/ogcapi-environmental-data-retrieval-1.bundled.json @@ -0,0 +1,4735 @@ +{ + "openapi": "3.0.3", + "info": { + "title": "OGC API - Environmental Data Retrieval Standard", + "description": "Example of OGC API - Environmental Data Retrieval Standard OpenAPI document", + "version": "1.1.0", + "license": { + "name": "OGC License", + "url": "https://www.ogc.org/legal" + } + }, + "servers": [ + { + "url": "https://example.org/edr", + "description": "Example OGC API - Environmental Data Retrieval server" + } + ], + "tags": [ + { + "name": "Capabilities", + "description": "Essential characteristics of the information available from the API." + }, + { + "name": "Collection metadata", + "description": "Description of the information available from the collections" + }, + { + "name": "Instance metadata", + "description": "Description of the information available from the instances of a collection" + }, + { + "name": "Collection data queries", + "description": "Data queries available." + }, + { + "name": "Instance data queries", + "description": "Data queries available on instances of the collection." + } + ], + "paths": { + "/": { + "get": { + "tags": [ + "Capabilities" + ], + "summary": "landing page of this API", + "description": "The landing page provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "operationId": "getLandingPage", + "parameters": [ + { + "name": "f", + "in": "query", + "description": "format to return the data response in", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "links to the API capabilities", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "title": { + "type": "string", + "example": "Meteorological data server" + }, + "description": { + "type": "string", + "example": "Access to Meteorological data via a Web API that conforms to the OGC API Environmental Data Retrieval specification." + }, + "links": { + "type": "array", + "items": { + "type": "object", + "required": [ + "href", + "rel" + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/locations/1234" + }, + "rel": { + "type": "string", + "example": "alternate" + }, + "type": { + "type": "string", + "example": "application/geo+json" + }, + "hreflang": { + "type": "string", + "example": "en" + }, + "title": { + "type": "string", + "example": "Monitoring site name" + }, + "length": { + "type": "integer" + }, + "templated": { + "description": "defines if the link href value is a template with values requiring replacement", + "type": "boolean" + } + } + }, + "example": [ + { + "href": "https://example.org/edr/api", + "hreflang": "en", + "rel": "service-desc", + "type": "application/vnd.oai.openapi+json;version=3.0", + "title": "" + }, + { + "href": "https://example.org/edr/conformance", + "hreflang": "en", + "rel": "data", + "type": "application/json", + "title": "" + }, + { + "href": "https://example.org/edr/collections", + "hreflang": "en", + "rel": "data", + "type": "application/json", + "title": "" + } + ] + }, + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Temperature", + "Wind", + "Point", + "Trajectory" + ] + }, + "provider": { + "type": "object", + "properties": { + "name": { + "description": "Name of organization providing the service", + "type": "string" + }, + "url": { + "description": "Link to service providers website", + "type": "string" + } + } + }, + "contact": { + "type": "object", + "properties": { + "email": { + "description": "Email address of service provider", + "type": "string" + }, + "phone": { + "description": "Phone number of service provider", + "type": "string" + }, + "fax": { + "description": "Fax number of service provider", + "type": "string" + }, + "hours": { + "type": "string" + }, + "instructions": { + "type": "string" + }, + "address": { + "type": "string" + }, + "postalCode": { + "type": "string" + }, + "city": { + "type": "string" + }, + "stateorprovince": { + "type": "string" + }, + "country": { + "type": "string" + } + } + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/conformance": { + "get": { + "tags": [ + "Capabilities" + ], + "summary": "Information about standards that this API conforms to", + "description": "List all requirements classes specified in a standard that the server conforms to", + "operationId": "getRequirementsClasses", + "parameters": [ + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "description": "URIs of all requirements classes supported by the server", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "conformsTo" + ], + "properties": { + "conformsTo": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/collections": { + "get": { + "tags": [ + "Capabilities" + ], + "summary": "List the avialable collections from the service", + "operationId": "listCollections", + "parameters": [ + { + "name": "bbox", + "in": "query", + "description": "Only features that have a geometry that intersects the bounding box are selected.\nThe bounding box is provided as four or six numbers, depending on whether the\ncoordinate reference system includes a vertical axis (height or depth):\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Minimum value, coordinate axis 3 (optional)\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n* Maximum value, coordinate axis 3 (optional)\nThe coordinate reference system of the values is WGS 84 longitude/latitude\n(http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate\nreference system is specified in the parameter `bbox-crs`.\nFor WGS 84 longitude/latitude the values are in most cases the sequence of\nminimum longitude, minimum latitude, maximum longitude and maximum latitude.\nHowever, in cases where the box spans the antimeridian the first value\n(west-most box edge) is larger than the third value (east-most box edge).\nIf the vertical axis is included, the third and the sixth number are the\nbottom and the top of the 3-dimensional bounding box.\nIf a feature has multiple spatial geometry properties, it is the decision of the\nserver whether only a single spatial geometry property is used to determine\nthe extent or all relevant geometries.", + "required": false, + "schema": { + "oneOf": [ + { + "items": { + "type": "number" + }, + "type": "array", + "minItems": 4, + "maxItems": 4 + }, + { + "items": { + "type": "number" + }, + "type": "array", + "minItems": 6, + "maxItems": 6 + } + ] + }, + "style": "form", + "explode": false + }, + { + "name": "datetime", + "in": "query", + "description": "Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.\nExamples:\n* A date-time: \"2018-02-12T23:20:50Z\" * A closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\" * Open intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\nOnly features that have a temporal property that intersects the value of `datetime` are selected.\nIf a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.", + "required": false, + "schema": { + "type": "string" + }, + "style": "form", + "explode": false + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "description": "Metadata about the Environmental data collections shared by this API", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "links", + "collections" + ], + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + }, + "example": [ + { + "href": "https://example.org/edr/collections", + "hreflang": "en", + "rel": "self", + "type": "application/yaml" + }, + { + "href": "https://example.org/edr/collections?f=html", + "hreflang": "en", + "rel": "alternate", + "type": "text/html" + }, + { + "href": "https://example.org/edr/collections?f=xml", + "hreflang": "en", + "rel": "alternate", + "type": "application/xml" + } + ] + }, + "collections": { + "type": "array", + "items": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/responses/200/content/application~1json/schema" + } + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "An error occured.", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "code": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/collections/{collectionId}": { + "get": { + "tags": [ + "Collection metadata" + ], + "summary": "List query types supported by the collection", + "description": "This will provide information about the query types that are supported by the chosen collection Use content negotiation to request HTML or JSON", + "operationId": "getQueries", + "parameters": [ + { + "name": "collectionId", + "in": "path", + "description": "Identifier (id) of a specific collection", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "description": "Metadata about the {collectionId} collection shared by this API", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "links", + "id", + "extent", + "data_queries", + "parameter_names", + "output_formats", + "crs" + ], + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + }, + "example": [ + { + "href": "https://example.org/service/description.html", + "hreflang": "en", + "rel": "service-doc", + "type": "text/html", + "title": "" + }, + { + "href": "https://example.org/service/licence.html", + "hreflang": "en", + "rel": "licence", + "type": "text/html", + "title": "" + }, + { + "href": "https://example.org/service/terms-and-conditions.html", + "hreflang": "en", + "rel": "restrictions", + "type": "text/html", + "title": "" + }, + { + "href": "https://example.org/edr/collections/the_collection_id/", + "hreflang": "en", + "rel": "collection", + "type": "collection", + "title": "Collection" + }, + { + "href": "https://example.org/edr/collections/the_collection_id/position", + "hreflang": "en", + "rel": "data", + "type": "position", + "title": "Position" + }, + { + "href": "https://example.org/edr/collections/the_collection_id/area", + "hreflang": "en", + "rel": "data", + "type": "area", + "title": "Area" + } + ] + }, + "id": { + "description": "id of the collection", + "type": "string", + "example": "Metar data" + }, + "title": { + "description": "title of the collection", + "type": "string", + "example": "Metar observations" + }, + "description": { + "description": "description of the collection", + "type": "string", + "example": "Last 24 hours Metar observations" + }, + "keywords": { + "description": "List of keywords which help to describe the collection", + "type": "array", + "items": { + "type": "string" + } + }, + "extent": { + "description": "The extent of the information in the collection. In the Core only spatial and temporal\nextents are specified. Extensions may add additional members to represent other\nextents, for example, thermal or pressure ranges.", + "type": "object", + "properties": { + "spatial": { + "description": "The spatial extent of the information in the collection.", + "type": "object", + "required": [ + "bbox", + "crs" + ], + "properties": { + "bbox": { + "description": "One or more bounding boxes that describe the spatial extent of the dataset.\nIn the Core only a single bounding box is supported. Extensions may support\nadditional areas. If multiple areas are provided, the union of the bounding\nboxes describes the spatial extent.", + "type": "array", + "minItems": 1, + "items": { + "description": "Each bounding box is provided as four or six numbers, depending on\nwhether the coordinate reference system includes a vertical axis\n(height or depth):\n\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Minimum value, coordinate axis 3 (optional)\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n* Maximum value, coordinate axis 3 (optional)\n\nThe coordinate reference system of the values is WGS 84 longitude/latitude\n(http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate\nreference system is specified in `crs`.\n\nFor WGS 84 longitude/latitude the values are in most cases the sequence of\nminimum longitude, minimum latitude, maximum longitude and maximum latitude.\nHowever, in cases where the box spans the antimeridian the first value\n(west-most box edge) is larger than the third value (east-most box edge).\n\nIf the vertical axis is included, the third and the sixth number are\nthe bottom and the top of the 3-dimensional bounding box.\n\nIf a feature has multiple spatial geometry properties, it is the decision of the\nserver whether only a single spatial geometry property is used to determine\nthe extent or all relevant geometries.", + "oneOf": [ + { + "items": { + "type": "number" + }, + "minItems": 4, + "maxItems": 4, + "type": "array" + }, + { + "items": { + "type": "number" + }, + "minItems": 6, + "maxItems": 6, + "type": "array" + } + ] + }, + "example": [ + -180, + -90, + 180, + 90 + ] + }, + "crs": { + "description": "Coordinate reference system of the coordinates in the spatial extent\n(property `bbox`). The default reference system is WGS 84 longitude/latitude.\nIn the Core this is the only supported coordinate reference system.\nExtensions may support additional coordinate reference systems ", + "type": "string", + "default": "GEOGCS[\"WGS 84\",DATUM[\"WGS_1984\",SPHEROID[\"WGS 84\",6378137,298.257223563,AUTHORITY[\"EPSG\",\"7030\"]],AUTHORITY[\"EPSG\",\"6326\"]],PRIMEM[\"Greenwich\",0,AUTHORITY[\"EPSG\",\"8901\"]],UNIT[\"degree\",0.01745329251994328,AUTHORITY[\"EPSG\",\"9122\"]],AUTHORITY[\"EPSG\",\"4326\"]]" + }, + "name": { + "description": "Name of the vertical coordinate reference system", + "type": "string" + } + } + }, + "temporal": { + "description": "The temporal extent of the information in the collection.", + "type": "object", + "required": [ + "interval", + "trs" + ], + "properties": { + "interval": { + "description": "RFC3339 compliant Date and Time", + "type": "array", + "minItems": 1, + "items": { + "description": "Begin and end times of the time interval. The timestamps are in the\ntemporal coordinate reference system specified in `trs`. By default\nthis is the Gregorian calendar.", + "type": "array", + "minItems": 2, + "maxItems": 2, + "items": { + "type": "string", + "nullable": true + }, + "example": [ + [ + "2020-11-12T12:15Z", + "2020-11-12T12:15Z" + ], + [ + "2020-11-12T12:15Z", + "2020-11-12T12:45Z" + ], + [ + "2022-01-14T09:00Z", + "2022-01-15T09:00Z" + ], + [ + "2022-01-14T09:00Z", + "2022-01-14T21:00Z" + ], + [ + "2022-01-14T09:00Z", + "2022-01-16T09:00Z" + ] + ] + } + }, + "values": { + "description": "Provides information about the time intervals available in the collection \nas ISO8601 compliant dates, either as a time range specified \nas start time / end time (e.g. 2017-11-14T09:00Z/2017-11-14T21:00Z) or\nas number of repetitions / start time / interval (e.g. R4/2017-11-14T21:00Z/PT3H) \nor a list of time values (e.g.\n2017-11-14T09:00Z,2017-11-14T12:00Z,2017-11-14T15:00Z,2017-11-14T18:00Z,2017-11-14T21:00Z)", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "minItems": 1, + "nullable": true, + "example": [ + [ + "2020-11-12T12:15Z" + ], + [ + "2020-11-12T12:15Z", + "2020-11-12T12:30Z", + "2020-11-12T12:45Z" + ], + [ + "R12/2022-01-14T09:00Z/2022-01-15T09:00Z" + ], + [ + "R12/2022-01-14T09:00Z/PT1H" + ], + [ + "R12/2022-01-14T09:00Z/PT1H", + "R4/2022-01-14T21:00Z/PT3H", + "R4/2022-01-15T09:00Z/PT6H" + ] + ] + } + }, + "trs": { + "description": "Coordinate reference system of the coordinates in the temporal extent\n(property `interval`). The default reference system is the Gregorian calendar.\nIn the Core this is the only supported temporal coordinate reference system.\nExtensions may support additional temporal coordinate reference systems ", + "type": "string", + "example": "TIMECRS[\"DateTime\",TDATUM[\"Gregorian Calendar\"],CS[TemporalDateTime,1],AXIS[\"Time (T)\",future]]", + "default": "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" + }, + "name": { + "description": "Name of the temporal coordinate reference system", + "type": "string" + } + } + }, + "vertical": { + "description": "The vertical extent of the information in the collection.", + "type": "object", + "required": [ + "interval", + "vrs" + ], + "properties": { + "interval": { + "description": "In the Core only a single time interval is supported. Extensions may support\nmultiple intervals. If multiple intervals are provided, the union of the\nintervals describes the vertical extent.", + "type": "array", + "minItems": 1, + "items": { + "description": "minimum and maximum heights of the vertical interval. The values are in the\nvertical coordinate reference system specified in `vrs`. By default\nthis is the vertical coordinate reference system of the source information.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "nullable": true + }, + "example": [ + [ + "2", + "100" + ] + ] + } + }, + "values": { + "description": "Vertical level intervals that data in the collection is available at \nthese can be defined as follows:\nmin level / max level (e.g. \"2/100\") or \nas number of repetitions / start level / interval (e.g.\"R5/100/50\") \nor a list of vertical levels (e.g. \"2\",10,\"80\",\"100\"}\nThe value `null` is supported and indicates an open vertical interval.", + "type": "array", + "minItems": 1, + "items": { + "type": "string", + "nullable": true, + "example": [ + [ + "2/100" + ], + [ + "R20/1000/-50" + ], + [ + "2", + "10", + "80", + "100" + ] + ] + } + }, + "vrs": { + "description": "Coordinate reference system of the coordinates in the vertical extent\n(property `interval`). ", + "type": "string", + "example": "VERTCS[\"WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PARAMETER[\"Vertical_Shift\",0.0],PARAMETER[\"Direction\",1.0],UNIT[\"Meter\",1.0]],AXIS[\"Up\",UP]", + "default": "VERTCS[\"WGS_1984\",DATUM[\"D_WGS_1984\",SPHEROID[\"WGS_1984\",6378137.0,298.257223563]],PARAMETER[\"Vertical_Shift\",0.0],PARAMETER[\"Direction\",1.0],UNIT[\"Meter\",1.0]],AXIS[\"Up\",UP]" + }, + "name": { + "description": "Name of the vertical coordinate reference system", + "type": "string" + } + } + } + } + }, + "data_queries": { + "description": "Detailed information relevant to individual query types", + "type": "object", + "properties": { + "position": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/position" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "required": [ + "query_type" + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "position" + ], + "example": "position" + } + } + } + } + } + } + }, + "radius": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/radius" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "radius" + ], + "example": "radius" + }, + "within_units": { + "description": "list of distance units radius values can be specified in", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "km", + "miles" + ] + } + } + } + } + } + } + }, + "area": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/area" + }, + "variables": { + "allOf": [ + { + "description": "Property to contain any extra metadata information that is specific to an individual data query", + "type": "object", + "required": [ + "title", + "description", + "output_formats", + "default_output_format", + "crs_details" + ], + "properties": { + "title": { + "description": "title of the query", + "type": "string", + "example": "Position query" + }, + "description": { + "description": "description of the query", + "type": "string", + "example": "Query to return data for a defined well known text point" + }, + "output_formats": { + "description": "list of output formats supported by the Position query", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "CoverageJSON", + "GeoJSON", + "IWXXM", + "GRIB" + ] + }, + "default_output_format": { + "description": "default output format for the Position query", + "type": "string" + }, + "crs_details": { + "description": "List of key/value definitions for the CRS's supported by the Position query. The key is the query parameter and the value is the Well Known Text description", + "type": "array", + "items": { + "type": "object", + "required": [ + "crs", + "wkt" + ], + "properties": { + "crs": { + "description": "name of the coordinate reference system, used as the value in the crs query parameter to define the required output CRS", + "type": "string", + "example": "native" + }, + "wkt": { + "description": "Well Known text description of the coordinate reference system", + "type": "string", + "example": "GEOGCS[\"WGS 84\",DATUM[\"WGS_1984\",SPHEROID[\"WGS 84\",6378137,298.257223563,AUTHORITY[\"EPSG\",\"7030\"]],AUTHORITY[\"EPSG\",\"6326\"]],PRIMEM[\"Greenwich\",0,AUTHORITY[\"EPSG\",\"8901\"]],UNIT[\"degree\",0.01745329251994328,AUTHORITY[\"EPSG\",\"9122\"]],AUTHORITY[\"EPSG\",\"4326\"]]" + } + } + } + } + } + } + ], + "required": [ + "query_type" + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "area" + ], + "example": "area" + } + } + } + } + } + } + }, + "cube": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/cube" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "required": [ + "query_type" + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "cube" + ], + "example": "cube" + }, + "height_units": { + "description": "list of z distance units vertical values can be specified in", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "m", + "hPa" + ] + } + } + } + } + } + } + }, + "trajectory": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/trajectory" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "trajectory" + ], + "example": "trajectory" + } + } + } + } + } + } + }, + "corridor": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/corridor" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "required": [ + "query_type" + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "corridor" + ], + "example": "corridor" + }, + "width_units": { + "description": "list of width distance units distance values can be specified in", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "km", + "miles" + ] + }, + "height_units": { + "description": "list of height distance units distance values can be specified in", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "m", + "hPa" + ] + } + } + } + } + } + } + }, + "locations": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/locations" + }, + "variables": { + "allOf": [ + { + "$ref": "#/paths/~1collections/get/responses/200/content/application~1json/schema/properties/collections/items/properties/data_queries/properties/area/properties/link/properties/variables/allOf/0" + } + ], + "required": [ + "query_type" + ], + "properties": { + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "locations" + ], + "example": "locations" + } + } + } + } + } + } + }, + "items": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/items" + }, + "variables": { + "description": "Property to contain any extra metadata information that is specific to an individual data queries", + "type": "object", + "properties": { + "title": { + "description": "title of the query", + "type": "string", + "example": "Items query" + }, + "description": { + "description": "description of the query", + "type": "string", + "example": "Query to return data for a defined well known text point" + }, + "query_type": { + "description": "Type of EDR query", + "type": "string", + "enum": [ + "items" + ], + "example": "items" + } + } + } + } + } + } + }, + "instances": { + "type": "object", + "properties": { + "link": { + "allOf": [ + { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + ], + "properties": { + "href": { + "type": "string", + "example": "https://example.com/collections/monitoringsites/instances" + }, + "variables": { + "description": "Property to contain any extra metadata information that is specific to an individual data queries", + "type": "object", + "properties": { + "title": { + "description": "title of the query", + "type": "string", + "example": "Instances query" + }, + "description": { + "description": "description of the query", + "type": "string", + "example": "Instances of collection each representing different versions" + }, + "query_type": { + "description": "Instances of collection", + "type": "string", + "enum": [ + "instances" + ], + "example": "instances" + } + } + } + } + } + } + } + } + }, + "crs": { + "description": "list of the coordinate reference systems the collection results can support", + "type": "array", + "items": { + "type": "string" + } + }, + "output_formats": { + "description": "list of formats the results can be presented in", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "CoverageJSON", + "GeoJSON", + "IWXXM", + "GRIB" + ] + }, + "parameter_names": { + "description": "list of the data parameters available in the collection", + "type": "object", + "additionalProperties": { + "items": { + "type": "object", + "title": "Parameter name", + "description": "Definition of data parameter", + "required": [ + "type", + "observedProperty" + ], + "properties": { + "type": { + "description": "type", + "enum": [ + "Parameter" + ] + }, + "description": { + "type": "string" + }, + "label": { + "type": "string" + }, + "data-type": { + "description": "Data type of returned parameter", + "type": "string", + "enum": [ + "integer", + "float", + "string" + ] + }, + "unit": { + "type": "object", + "title": "unit name", + "description": "definition of data units", + "anyOf": [ + { + "required": [ + "label" + ] + }, + { + "required": [ + "symbol" + ] + }, + { + "required": [ + "label", + "symbol" + ] + } + ], + "properties": { + "label": { + "additionalProperties": { + "type": "string" + } + }, + "symbol": { + "title": "Describe unit symbol", + "oneOf": [ + { + "type": "object", + "description": "Information about the symbol used to describe the units", + "required": [ + "value", + "type" + ], + "properties": { + "value": { + "description": "representation of the units symbol", + "type": "string" + }, + "type": { + "description": "uri to detailed desxcription of the units", + "type": "string" + } + } + }, + { + "type": "string" + } + ], + "example": { + "value": "hPa", + "type": "http://www.opengis.net/def/uom/UCUM/" + } + }, + "id": { + "type": "string" + } + }, + "example": { + "label": { + "en": "Kelvin" + }, + "symbol": { + "value": "K", + "type": "http://www.opengis.net/def/uom/UCUM/" + } + } + }, + "observedProperty": { + "type": "object", + "title": "name of property", + "description": "Description of the property", + "required": [ + "label" + ], + "properties": { + "id": { + "description": "URI linking to an external registry which contains the definitive definition of\nthe observed property", + "type": "string" + }, + "label": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "description": { + "type": "string" + }, + "categories": { + "type": "array", + "items": { + "minItems": 1, + "type": "object", + "required": [ + "id", + "label" + ], + "properties": { + "id": { + "description": "URI linking to an external registry which contains the definitive definition of\nthe observed property", + "type": "string" + }, + "label": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "description": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "required": [ + "en" + ], + "properties": { + "en": { + "type": "string" + } + } + } + ] + } + } + } + } + }, + "example": { + "id": "http://vocab.nerc.ac.uk/standard_name/sea_ice_area_fraction/", + "label": "Sea Ice Concentration" + } + }, + "categoryEncoding": { + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "array", + "items": { + "type": "integer" + } + } + ] + } + }, + "extent": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/responses/200/content/application~1json/schema/properties/extent" + }, + "id": { + "description": "Unique ID of the parameter, this is the value used for querying the data", + "type": "string" + }, + "measurementType": { + "type": "object", + "title": "Parameter measurement approach", + "description": "Approach to calculating the data values", + "required": [ + "method" + ], + "properties": { + "method": { + "type": "string", + "example": "mean" + }, + "duration": { + "type": "string", + "title": "Measurement time duration", + "description": "The time duration that the value was calculated for as an RFC3339 duration value. If the method value is instantaneous this value is not required.", + "example": "PT10M" + } + } + } + }, + "example": { + "type": "Parameter", + "id": "sea_ice", + "description": "Sea Ice concentration (ice=1;no ice=0)", + "unit": { + "label": "Ratio", + "symbol": { + "value": "1", + "type": "http://www.opengis.net/def/uom/UCUM/" + } + }, + "observedProperty": { + "id": "http://vocab.nerc.ac.uk/standard_name/sea_ice_area_fraction/", + "label": "Sea Ice Concentration" + } + } + } + } + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/position": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for position queries of collection {collectionId}", + "description": "Query end point for position queries", + "operationId": "GetDataForPoint", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "coords", + "in": "query", + "description": "location(s) to return data for, the coordinates are defined by a Well Known Text\n(wkt) string. to retrieve a single location :\n\nPOINT(x y) i.e. POINT(0 51.48) for Greenwich, London\n\nAnd for a list of locations\n\nMULTIPOINT((x y),(x1 y1),(x2 y2),(x3 y3))\n\ni.e.\nMULTIPOINT((38.9 -77),(48.85 2.35),(39.92 116.38),(-35.29 149.1),(51.5 -0.1))\n\nsee http://portal.opengeospatial.org/files/?artifact_id=25355 and \nhttps://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry\n\nthe coordinate values will depend on the CRS parameter, if this is not defined\nthe values will be assumed to WGS84 values (i.e x=longitude and y=latitude)\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for position queries of collection {collectionId}", + "description": "Query end point for position queries", + "operationId": "PostDataForPoint", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "coords" + ], + "properties": { + "coords": { + "description": "Well Known Text Point definition", + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/radius": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for radius queries of collection {collectionId}", + "description": "Query end point for to return values within a defined radius of a point queries", + "operationId": "GetDataForRadius", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "coords", + "in": "query", + "description": "location(s) to return data for, the coordinates are defined by a Well Known Text\n(wkt) string. to retrieve a single location :\n\nPOINT(x y) i.e. POINT(0 51.48) for Greenwich, London\n\nsee http://portal.opengeospatial.org/files/?artifact_id=25355 and \nhttps://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry\n\nthe coordinate values will depend on the CRS parameter, if this is not defined\nthe values will be assumed to WGS84 values (i.e x=longitude and y=latitude)\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "within", + "in": "query", + "description": "Defines radius of area around defined coordinates to include in the data selection", + "required": true, + "example": 10, + "schema": { + "type": "number" + } + }, + { + "name": "within-units", + "in": "query", + "description": "Distance units for the within parameter", + "required": true, + "example": "KM", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for radius queries of collection {collectionId}", + "description": "Query end point for to return values within a defined radius of a point queries", + "operationId": "PostDataForRadius", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "coords", + "within", + "within-units" + ], + "properties": { + "coords": { + "description": "Well Known Text Point definition", + "type": "string" + }, + "within": { + "type": "number" + }, + "within-units": { + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/area": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for area queries of collection {collectionId} defined by a polygon", + "description": "Return the data values for the data area defined by the query parameters", + "operationId": "GetDataForArea", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "coords", + "in": "query", + "description": "Only data that has a geometry that intersects the area defined by the polygon\nare selected. \n\nThe polygon is defined using a Well Known Text string following \n\ncoords=POLYGON((x y,x1 y1,x2 y2,...,xn yn x y))\n\nwhich are values in the coordinate system defined by the crs query parameter \n(if crs is not defined the values will be assumed to be WGS84 longitude/latitude coordinates). \n\nFor instance a polygon that roughly describes an area that contains \nSouth West England in WGS84 would look like: \n\ncoords=POLYGON((-6.1 50.3,-4.35 51.4,-2.6 51.6,-2.8 50.6,-5.3 49.9,-6.1,50.3))\n\nsee http://portal.opengeospatial.org/files/?artifact_id=25355 and \nhttps://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry\n\nThe coords parameter will only support 2D POLYGON definitions", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "z", + "in": "query", + "description": "Define the vertical level to return data from \ni.e. z=level\n\nfor instance if the 850hPa pressure level is being queried\n\nz=850\n\nor a range to return data for all levels between and including 2 defined levels\ni.e. z=minimum value/maximum value\n\nfor instance if all values between and including 10m and 100m\n\nz=10/100\n\nfinally a list of height values can be specified\ni.e. z=value1,value2,value3\n\nfor instance if values at 2m, 10m and 80m are required\n\nz=2,10,80\n\nAn Arithmetic sequence using Recurring height intervals, the difference is the number of recurrences is defined at the start \nand the amount to increment the height by is defined at the end\n\ni.e. z=Rn/min height/height interval\n\nso if the request was for 20 height levels 50m apart starting at 100m:\n\nz=R20/100/50\n\nWhen not specified data from all available heights SHOULD be returned\n", + "required": false, + "schema": { + "type": "string" + }, + "style": "form", + "explode": false + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "name": "parameter-name", + "in": "query", + "description": "comma delimited list of parameters to retrieve data for. Valid parameters are listed in the collections metadata", + "schema": { + "type": "string" + }, + "style": "form", + "explode": false, + "required": false + }, + { + "name": "crs", + "in": "query", + "description": "identifier (id) of the coordinate system to return data in list of valid crs identifiers for the chosen collection are defined in the metadata responses. If not supplied the coordinate reference system will default to WGS84.", + "required": false, + "example": "native", + "schema": { + "type": "string" + } + }, + { + "name": "resolution-x", + "in": "query", + "description": "Defined it the user requires data at a different resolution from the native resolution of the data along the x-axis\n\nIf this is a single value it denotes the number of intervals to retrieve data for along the x-axis\n \n i.e. resolution-x=10 \n \nwould retrieve 10 values along the x-axis from the minimum x coordinate to maximum x coordinate (i.e. a value at both the minimum x and maximum x coordinates and 8 values between).\n", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "name": "resolution-y", + "in": "query", + "description": "Defined it the user requires data at a different resolution from the native resolution of the data along the y-axis\n\nIf this is a single value it denotes the number of intervals to retrieve data for along the y-axis\n \n i.e. resolution-y=10 \n \nwould retrieve 10 values along the y-axis from the minimum y coordinate to maximum y coordinate (i.e. a value at both the minimum y and maximum y coordinates and 8 values between).\n", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "description": "Data ranges required to construct valid queries for the choosen data collection", + "content": { + "application/vnd.cov+json": { + "schema": { + "type": "object", + "title": "CoverageJSON", + "description": "A geospatial coverage interchange format based on JavaScript Object Notation (JSON)", + "required": [ + "type" + ], + "properties": { + "type": { + "description": "Coverage domain type", + "type": "string", + "enum": [ + "Coverage", + "CoverageCollection", + "Domain" + ] + }, + "domainType": { + "type": "string" + }, + "coverages": { + "type": "array", + "items": { + "type": "object", + "required": [ + "type", + "domain", + "ranges" + ], + "properties": { + "type": { + "description": "Coverage domain type", + "type": "string", + "enum": [ + "Coverage" + ] + }, + "domain": { + "description": "A Domain, which defines a set of positions and their extent in one or more referencing systems", + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "Domain" + ] + }, + "domainType": { + "type": "string" + }, + "axes": { + "type": "object", + "oneOf": [ + { + "description": "Grid domain: x and y are required, z and t optional", + "properties": { + "x": { + "description": "Simple axis with numeric values", + "oneOf": [ + { + "description": "Axis defined by list of numeric axis values and optional bounds", + "allOf": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/coverages/items/properties/domain/properties/axes/oneOf/0/properties/t/allOf/0" + }, + { + "properties": { + "values": { + "items": { + "type": "number" + } + }, + "bounds": { + "items": { + "type": "number" + } + } + }, + "additionalProperties": false + } + ] + }, + { + "description": "A regularly-spaced numeric axis", + "properties": { + "start": { + "type": "number" + }, + "stop": { + "type": "number" + }, + "num": { + "type": "integer", + "minimum": 1 + } + }, + "required": [ + "start", + "stop", + "num" + ], + "additionalProperties": false + } + ] + }, + "y": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/coverages/items/properties/domain/properties/axes/oneOf/0/properties/x" + }, + "z": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/coverages/items/properties/domain/properties/axes/oneOf/0/properties/x" + }, + "t": { + "description": "Simple axis with string values (e.g. time strings)", + "allOf": [ + { + "description": "Base schema for values-based axis schemas", + "properties": { + "dataType": { + "type": "string", + "not": { + "enum": [ + "primitive" + ] + } + }, + "values": { + "type": "array", + "minItems": 1, + "uniqueItems": true + }, + "coordinates": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 2 + }, + "bounds": { + "description": "Optional axis bounds. Shall be twice as long (and same data type) as \"values\"", + "type": "array", + "minItems": 2 + } + }, + "required": [ + "values" + ] + }, + { + "properties": { + "values": { + "items": { + "type": "string" + } + }, + "bounds": { + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + } + ] + } + }, + "required": [ + "x", + "y" + ] + }, + { + "description": "Trajectory domain: mandatory composite axis and optional z axis", + "properties": { + "axes": { + "properties": { + "composite": { + "description": "Tuple-based axis", + "allOf": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/coverages/items/properties/domain/properties/axes/oneOf/0/properties/t/allOf/0" + }, + { + "properties": { + "dataType": { + "type": "string", + "enum": [ + "tuple" + ] + }, + "values": { + "items": { + "description": "A tuple of axis values (numbers or strings)", + "type": "array", + "items": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "minItems": 2 + } + }, + "coordinates": {} + }, + "required": [ + "dataType", + "values", + "coordinates" + ], + "additionalProperties": false + } + ] + }, + "z": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/coverages/items/properties/domain/properties/axes/oneOf/0/properties/x" + } + }, + "required": [ + "composite" + ] + } + } + } + ] + }, + "referencing": { + "type": "array", + "items": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/referencing/items" + } + } + }, + "required": [ + "type", + "axes" + ] + }, + "ranges": { + "additionalProperties": { + "type": "object", + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1vnd.cov%2Bjson/schema/properties/ranges/additionalProperties" + } + } + } + } + }, + "parameters": { + "additionalProperties": { + "type": "object", + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items" + } + }, + "ranges": { + "type": "object", + "additionalProperties": { + "type": "object", + "description": "Object representing a multidimensional (>= 0D) array with named axes, encoded as a flat one-dimensional array in row-major order", + "properties": { + "type": { + "type": "string", + "enum": [ + "NdArray" + ] + }, + "dataType": { + "enum": [ + "float", + "integer", + "string" + ] + }, + "shape": { + "type": "array", + "items": { + "type": "number" + } + }, + "axisNames": { + "type": "array", + "items": { + "type": "string" + }, + "uniqueItems": true + }, + "values": { + "type": "array", + "items": { + "type": "number", + "nullable": true + }, + "minItems": 1 + } + }, + "oneOf": [ + { + "properties": { + "values": { + "items": { + "type": "number" + }, + "nullable": true + } + } + }, + { + "properties": { + "values": { + "items": { + "type": "integer" + }, + "nullable": true + } + } + }, + { + "properties": { + "values": { + "items": { + "type": "string" + }, + "nullable": true + } + } + }, + { + "properties": { + "shape": { + "minItems": 1 + }, + "axisNames": { + "minItems": 1 + } + }, + "required": [ + "shape", + "axisNames" + ] + } + ], + "required": [ + "type", + "dataType", + "values" + ] + } + }, + "referencing": { + "type": "array", + "items": { + "description": "Reference System Connection object: connects coordinates to reference systems", + "type": "object", + "properties": { + "coordinates": { + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + }, + "system": { + "type": "object", + "properties": { + "type": { + "type": "string" + } + }, + "required": [ + "type" + ], + "oneOf": [ + { + "description": "Temporal reference system", + "properties": { + "calendar": { + "type": "string" + }, + "timeScale": { + "type": "string" + } + }, + "required": [ + "calendar" + ] + }, + { + "description": "An identifier-based reference system", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "description": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "targetConcept": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "description": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + } + }, + "required": [ + "label" + ] + }, + "identifiers": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "description": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + } + }, + "required": [ + "label" + ] + } + } + }, + "required": [ + "targetConcept" + ] + } + ] + } + }, + "required": [ + "coordinates", + "system" + ] + }, + "minItems": 1 + } + } + } + }, + "application/geo+json": { + "schema": { + "type": "object", + "required": [ + "type", + "features" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "FeatureCollection" + ] + }, + "features": { + "type": "array", + "items": { + "type": "object", + "required": [ + "type", + "geometry", + "properties" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Feature" + ] + }, + "geometry": { + "oneOf": [ + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Point" + ] + }, + "coordinates": { + "type": "array", + "minItems": 2, + "items": { + "type": "number" + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPoint" + ] + }, + "coordinates": { + "type": "array", + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "number" + } + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LineString", + "LineStringM", + "LineStringZ", + "LineStringZM" + ] + }, + "coordinates": { + "type": "array", + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "array", + "minItems": 2, + "maxItems": 4, + "items": { + "type": "number" + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiLineString" + ] + }, + "coordinates": { + "type": "array", + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "number" + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "Polygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "type": "array", + "minItems": 4, + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "number" + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "coordinates" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "MultiPolygon" + ] + }, + "coordinates": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "array", + "minItems": 4, + "items": { + "type": "array", + "minItems": 2, + "items": { + "type": "number" + } + } + } + } + } + } + }, + { + "type": "object", + "required": [ + "type", + "geometries" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "GeometryCollection" + ] + }, + "geometries": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/2" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/3" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/features/items/properties/geometry/oneOf/5" + } + ] + } + } + } + } + ] + }, + "properties": { + "type": "object", + "title": "EDR GeoJSON Properties", + "description": "Properties to describe existing EDR features -- may be real-world or virtual sampling features.", + "example": [ + { + "datetime": "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z", + "label": "Monitoring site name", + "parameter-name": [ + "velocity", + "temperature" + ], + "edrqueryendpoint": "https://example.org/api/collections/collection/locations/location_123" + } + ], + "required": [ + "datetime", + "parameter-name", + "label", + "edrqueryendpoint" + ], + "properties": { + "datetime": { + "type": "string", + "title": "Date/time Domain", + "description": "Either a date-time or a period string that adheres to RFC 3339. Indicates the time instant or period for which data are available from the EDR feature.", + "default": "", + "example": [ + "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" + ] + }, + "parameter-name": { + "type": "array", + "title": "Available Parameters", + "description": "Unique IDs of available parameters, this is the value used for querying the data and corresponds to an ID in the parameter metadata of the collection.", + "items": { + "type": "string", + "title": "Parameter ID list", + "description": "Each entry should contain one parameter ID that can be used to query against the feature.", + "default": "", + "example": [ + "velocity", + "temperature" + ] + } + }, + "label": { + "type": "string", + "title": "Label", + "description": "A label such as a site name or other text to use on a link.", + "default": "", + "example": [ + "Site A" + ] + }, + "edrqueryendpoint": { + "type": "string", + "title": "EDR Query Endpoint", + "description": "A URI identifying the query end point. May identify a specific location.", + "default": "", + "example": [ + "https://example.org/api/collections/collection/locations/location_123d}" + ] + } + } + }, + "id": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "links": { + "type": "array", + "items": { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + } + } + } + }, + "parameters": { + "description": "list of the data parameters available in the collection", + "type": "array", + "items": { + "type": "object", + "description": "Represents metadata about the values of the coverage", + "properties": { + "id": { + "type": "string" + }, + "type": { + "description": "Type of the parameter object, shall be \"Parameter\"", + "type": "string", + "enum": [ + "Parameter" + ] + }, + "description": { + "type": "object", + "description": "Object representing an internationalised string.", + "additionalProperties": { + "type": "string" + } + }, + "observedProperty": { + "type": "object", + "description": "A definition of the quantity being measured.", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "description": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "categories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "description": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + } + }, + "required": [ + "id", + "label" + ] + }, + "minItems": 1 + } + }, + "required": [ + "label" + ] + }, + "unit": { + "type": "object", + "description": "The units of measure", + "properties": { + "id": { + "type": "string" + }, + "label": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema/properties/parameters/items/properties/description" + }, + "symbol": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "value" + ] + } + ] + } + }, + "anyOf": [ + { + "required": [ + "label" + ] + }, + { + "required": [ + "symbol" + ] + } + ] + }, + "categoryEncoding": { + "type": "object", + "description": "Maps IDs of categories in the observedProperty to range values", + "additionalProperties": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "array", + "items": { + "type": "integer" + } + } + ] + } + } + }, + "required": [ + "type", + "observedProperty" + ] + } + }, + "links": { + "type": "array", + "items": { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + } + }, + "timeStamp": { + "description": "This property indicates the time and date when the response was generated.", + "type": "string", + "format": "date-time", + "example": "2017-08-17T08:05:32Z" + }, + "numberMatched": { + "description": "The number of features of the feature type that match the selection\nparameters like `bbox`.", + "type": "integer", + "minimum": 0, + "example": 127 + }, + "numberReturned": { + "type": "integer", + "description": "The number of features in the feature collection.\n\nA server may omit this information in a response, if the information\nabout the number of features is not known or difficult to compute.\n\nIf the value is provided, the value shall be identical to the number\nof items in the \"features\" array.", + "minimum": 0, + "example": 10 + } + } + } + }, + "application/x-netcdf": { + "schema": { + "type": "object" + } + }, + "text/xml": { + "schema": { + "type": "string" + } + } + } + }, + "202": { + "description": "Data request still being processed" + }, + "308": { + "description": "Request will take a significant time to process" + }, + "400": { + "description": "Invalid request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/paths/~1collections/get/responses/default/content/application~1json/schema" + } + }, + "text/xml": {} + } + }, + "404": { + "description": "Requested data not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/paths/~1collections/get/responses/default/content/application~1json/schema" + } + }, + "text/xml": {} + } + }, + "413": { + "description": "Requested data volume to large to be handled by this service.", + "content": { + "application/json": { + "schema": { + "$ref": "#/paths/~1collections/get/responses/default/content/application~1json/schema" + } + }, + "text/xml": {} + } + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for area queries of collection {collectionId} defined by a polygon", + "description": "Return the data values for the data area defined by the query parameters", + "operationId": "PostDataForArea", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "coords" + ], + "properties": { + "coords": { + "description": "Well Known Text Polygon definition", + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "resolution-x": { + "type": "string" + }, + "resolution-y": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/cube": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for Cube queries of collection {collectionId} defined by a cube", + "description": "Return the data values for the data Cube defined by the query parameters", + "operationId": "GetDataForCube", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "bbox", + "in": "query", + "description": "Only features that have a geometry that intersects the bounding box are selected.\nThe bounding box is provided as four numbers:\n* Lower left corner, coordinate axis 1\n* Lower left corner, coordinate axis 2\n* Upper right corner, coordinate axis 1\n* Upper right corner, coordinate axis 2\n\nFor WGS 84 longitude/latitude the values are in most cases the sequence of\nminimum longitude, minimum latitude, maximum longitude and maximum latitude.\nHowever, in cases where the box spans the antimeridian the first value\n(west-most box edge) is larger than the third value (east-most box edge).\nIf a feature has multiple spatial geometry properties, it is the decision of the\nserver whether only a single spatial geometry property is used to determine\nthe extent or all relevant geometries.", + "required": true, + "schema": { + "oneOf": [ + { + "items": { + "type": "number" + }, + "type": "array", + "minItems": 4, + "maxItems": 4 + }, + { + "items": { + "type": "number" + }, + "type": "array", + "minItems": 6, + "maxItems": 6 + } + ] + }, + "style": "form", + "explode": false + }, + { + "name": "z", + "in": "query", + "description": "Define the vertical levels to return data from \n\nThe value will override any vertical values defined in the BBOX query parameter \n\nA range to return data for all levels between and including 2 defined levels\n\ni.e. z=minimum value/maximum value\n\nfor instance if all values between and including 10m and 100m\n\nz=10/100\n\nA list of height values can be specified\ni.e. z=value1,value2,value3\n\nfor instance if values at 2m, 10m and 80m are required\n\nz=2,10,80\n\nAn Arithmetic sequence using Recurring height intervals, the difference is the number of recurrences is defined at the start \nand the amount to increment the height by is defined at the end\n\ni.e. z=Rn/min height/height interval\n\nso if the request was for 20 height levels 50m apart starting at 100m:\n\nz=R20/100/50\n\nWhen not specified data from all available heights SHOULD be returned\n", + "required": false, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for Cube queries of collection {collectionId} defined by a cube", + "description": "Return the data values for the data Cube defined by the query parameters", + "operationId": "PostDataForCube", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "bbox" + ], + "properties": { + "bbox": { + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/trajectory": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for trajectory queries of collection {collectionId} defined by a wkt linestring and a iso8601 time period", + "description": "Return the data values for the data Polygon defined by the query parameters", + "operationId": "GetDataForTrajectory", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for trajectory queries of collection {collectionId} defined by a wkt linestring and a iso8601 time period", + "description": "Return the data values for the data Polygon defined by the query parameters", + "operationId": "PostDataForTrajectory", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "coords" + ], + "properties": { + "coords": { + "description": "Well Known Text LineString definition", + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/corridor": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for Corridor queries of collection {collectionId} defined by a polygon", + "description": "Return the data values for the Corridor defined by the query parameters", + "operationId": "GetDataForCorridor", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "coords", + "in": "query", + "description": "Only data that has a geometry that intersects the area defined by the linestring\nare selected. \n\nThe trajectory is defined using a Well Known Text string following \n\nA 2D trajectory, on the surface of earth with no time or height dimensions: \n coords=LINESTRING(-2.87 51.14 , -2.98 51.36,-3.15 51.03 ,-3.48 50.74 ,-3.36 50.9 )\n\nA 2D trajectory, on the surface of earth with all for the same time and no height dimension, time value defined in ISO8601 format by the `datetime` query parameter : \n coords=LINESTRING(-2.87 51.14 , -2.98 51.36 ,-3.15 51.03 ,-3.48 50.74 ,-3.36 50.9 )&time=2018-02-12T23:00:00Z \n \nA 2D trajectory, on the surface of earth with no time value but at a fixed height level, height defined in the collection height units by the `z` query parameter : \n coords=LINESTRING(-2.87 51.14 , -2.98 51.36 ,-3.15 51.03 ,-3.48 50.74 ,-3.36 50.9 )&z=850 \n\nA 2D trajectory, on the surface of earth with all for the same time and at a fixed height level, time value defined in ISO8601 format by the `datetime` query parameter and height defined in the collection height units by the `z` query parameter : \n coords=LINESTRING(-2.87 51.14 , -2.98 51.36 ,-3.15 51.03 ,-3.48 50.74 ,-3.36 50.9 )&time=2018-02-12T23:00:00Z&z=850 \n\nA 3D trajectory, on the surface of the earth but over a time range with no height values:\ncoords=LINESTRINGM(-2.87 51.14 1560507000,-2.98 51.36 1560507600,-3.15 51.03 1560508200,-3.48 50.74 1560508500,-3.36 50.9 1560510240)\n\nA 3D trajectory, on the surface of the earth but over a time range with a fixed height value, height defined in the collection height units by the `z` query parameter : \ncoords=LINESTRINGM(-2.87 51.14 1560507000,-2.98 51.36 1560507600,-3.15 51.03 1560508200,-3.48 50.74 1560508500,-3.36 50.9 1560510240)&z=200\n\n\nA 3D trajectory, through a 3D volume with height or depth, but no defined time:\ncoords=LINESTRINGZ(-2.87 51.14 0.1,-2.98 51.36 0.2,-3.15 51.03 0.3,-3.48 50.74 0.4,-3.36 50.9 0.5)\n\nA 3D trajectory, through a 3D volume with height or depth, but a fixed time time value defined in ISO8601 format by the `datetime` query parameter:\ncoords=LINESTRINGZ(-2.87 51.14 0.1,-2.98 51.36 0.2,-3.15 51.03 0.3,-3.48 50.74 0.4,-3.36 50.9 0.5)&time=2018-02-12T23:00:00Z\n\nA 4D trajectory, through a 3D volume but over a time range:\ncoords=LINESTRINGZM(-2.87 51.14 0.1 1560507000,-2.98 51.36 0.2 1560507600,-3.15 51.03 0.3 1560508200, -3.48 50.74 0.4 1560508500, -3.36 50.9 0.5 1560510240)\n(using either the `time` or `z` parameters with a 4D trajectory wil generate an error response)\n\nwhere Z in `LINESTRINGZ` and `LINESTRINGZM` refers to the height value. \n`If the specified CRS does not define the height units, the heights units will default to metres above mean sea level`\n\nand the M in `LINESTRINGM` and `LINESTRINGZM` refers to the number of seconds that have elapsed since the Unix epoch, that is the time 00:00:00 UTC on 1 January 1970. See\nhttps://en.wikipedia.org/wiki/Unix_time", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "name": "corridor-width", + "in": "query", + "description": "width of the corridor\n\nThe width value represents the whole width of the corridor where\nthe trajectory supplied in the `coords` query parameter is the centre\npoint of the corridor\n\n`corridor-width={width}`\n\ne.g. corridor-width=100\n\nWould be a request for a corridor 100 units wide with the coords parameter values being the centre point of the requested corridor, \nthe request would be for data values 50 units either side of the trajectory coordinates defined in the coords parameter. \n\nThe width units supported by the collection will be provided in the API metadata responses\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "width-units", + "in": "query", + "description": "Distance units for the corridor-width parameter", + "required": true, + "example": "KM", + "schema": { + "type": "string" + } + }, + { + "name": "corridor-height", + "in": "query", + "description": "height of the corridor\n\nThe height value represents the whole height of the corridor where\nthe trajectory supplied in the `coords` query parameter is the centre\npoint of the corridor\n\n`corridor-height={height}`\n\ne.g. corridor-height=100\n\nWould be a request for a corridor 100 units high with the coords parameter values being the centre point of the requested corridor, \nthe request would be for data values 50 units either side of the trajectory coordinates defined in the coords parameter. \n\nThe height units supported by the collection will be provided in the API metadata responses\n", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "height-units", + "in": "query", + "description": "Distance units for the corridor-height parameter", + "required": true, + "example": "KM", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/6" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/7" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for Corridor queries of collection {collectionId} defined by a polygon", + "description": "Return the data values for the Corridor defined by the query parameters", + "operationId": "PostDataForCorridor", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "coords", + "corridor-width", + "width-units", + "corridor-height", + "height-units" + ], + "properties": { + "coords": { + "description": "Well Known Text LineString definition", + "type": "string" + }, + "z": { + "type": "string" + }, + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "corridor-width": { + "type": "string" + }, + "width-units": { + "type": "string" + }, + "corridor-height": { + "type": "string" + }, + "height-units": { + "type": "string" + }, + "resolution-x": { + "type": "string" + }, + "resolution-y": { + "type": "string" + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/items": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "List available items", + "description": "List the items available in the collection accessible via a unique identifier", + "operationId": "ListDataItems", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + } + ], + "responses": { + "200": { + "description": "List of pre-existing items available for retrieval", + "content": { + "application/geo+json": { + "schema": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200/content/application~1geo%2Bjson/schema" + } + }, + "application/json": { + "schema": { + "type": "string" + } + }, + "text/xml": { + "schema": { + "type": "string" + } + } + } + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "List available items", + "description": "List the items available in the collection accessible via a unique identifier", + "operationId": "PostListDataItems", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "bbox" + ], + "properties": { + "bbox": { + "type": "string" + }, + "datetime": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1items/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/items/{itemId}": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Return item {itemId} from collection {collectionId}", + "description": "Query end point to retrieve data from collection {collectionId} using a unique identifier", + "operationId": "GetDataForItem", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "itemId", + "in": "path", + "required": true, + "description": "Retrieve data from the collection using a unique identifier.", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Return item {itemId} from collection {collectionId}", + "description": "Query end point to retrieve data from collection {collectionId} using a unique identifier", + "operationId": "PostDataForItem", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1items~1%7BitemId%7D/get/parameters/1" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances": { + "get": { + "tags": [ + "Instance metadata" + ], + "summary": "List data instances of {collectionId}", + "description": "This will provide list of the avalable instances of the collection Use content negotiation to request HTML or JSON.", + "operationId": "getCollectionInstances", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "description": "Metadata about the instance of {collectionId} collection shared by this API", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "links", + "instances" + ], + "properties": { + "links": { + "type": "array", + "items": { + "$ref": "#/paths/~1/get/responses/200/content/application~1json/schema/properties/links/items" + }, + "example": [ + { + "href": "https://example.org/edr/collections/the_collection_id/instances", + "hreflang": "en", + "rel": "self", + "type": "application/json" + }, + { + "href": "https://example.org/edr/collections/the_collection_id/instances?f=html", + "hreflang": "en", + "rel": "alternate", + "type": "text/html" + }, + { + "href": "https://example.org/edr/collections/the_collection_id/instances?f=xml", + "hreflang": "en", + "rel": "alternate", + "type": "application/xml" + } + ] + }, + "instances": { + "type": "array", + "items": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/responses/200/content/application~1json/schema" + } + } + } + } + }, + "text/html": { + "schema": { + "type": "string" + } + } + } + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/position": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for position queries of instance {instanceId} of collection {collectionId}", + "description": "Query end point for position queries", + "operationId": "GetInstanceDataForPoint", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1position/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for position queries of instance {instanceId} of collection {collectionId}", + "description": "Query end point for position queries", + "operationId": "PostInstanceDataForPoint", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1position/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/radius": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point to return data within defined radius of a point for an instance {instanceId} of collection {collectionId}", + "description": "Query end point to return all data within a defined radius of the defined point location queries", + "operationId": "PostInstanceDataForRadius", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1radius/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1radius/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1radius/get/parameters/3" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point to return data within defined radius of a point for an instance {instanceId} of collection {collectionId}", + "description": "Query end point to return all data within a defined radius of the defined point location queries", + "operationId": "PostInstanceDataForRadius", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1radius/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/area": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for area queries of instance {instanceId} of collection {collectionId} defined by a polygon", + "description": "Return the data values for the data area defined by the query parameters", + "operationId": "GetInstanceDataForArea", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "instanceId", + "in": "path", + "description": "Identifier (id) of a specific instance of a collection", + "required": true, + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/6" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/7" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for area queries of instance {instanceId} of collection {collectionId} defined by a polygon", + "description": "Return the data values for the data area defined by the query parameters", + "operationId": "PostInstanceDataForArea", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/cube": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for Cube queries of instance {instanceId} of collection {collectionId} defined by a cube", + "description": "Return the data values for the data Cube defined by the query parameters", + "operationId": "GetInstanceDataForCube", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1cube/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for Cube queries of instance {instanceId} of collection {collectionId} defined by a cube", + "description": "Return the data values for the data Cube defined by the query parameters", + "operationId": "PostInstanceDataForCube", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1cube/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/trajectory": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for trajectory queries of instance {instanceId} of collection {collectionId} defined by a wkt linestring and a iso8601 time period", + "description": "Return the data values for the data Polygon defined by the query parameters", + "operationId": "GetInstanceDataForTrajectory", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for trajectory queries of instance {instanceId} of collection {collectionId} defined by a wkt linestring and a iso8601 time period", + "description": "Return the data values for the data Polygon defined by the query parameters", + "operationId": "PostInstanceDataForTrajectory", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1trajectory/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/corridor": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for Corridor queries of instance {instanceId} of collection {collectionId} defined by a polygon", + "description": "Return the data values for the Corridor defined by the query parameters", + "operationId": "GetInstanceDataForCorridor", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/2" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/5" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/6" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/7" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/get/parameters/8" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/6" + }, + { + "name": "resolution-z", + "in": "query", + "description": "Defined it the user requires data at a different resolution from the native resolution of the data along the z-axis\n\nIf this is a single value it denotes the number of intervals to retrieve data for along the z-axis\n \n i.e. resolution-z=10 \n \nwould retrieve 10 values along the z-axis from the minimum z coordinate to maximum z coordinate (i.e. a value at both the minimum z and maximum z coordinates and 8 values between).\n", + "required": false, + "schema": { + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for Corridor queries of instance {instanceId} of collection {collectionId} defined by a polygon", + "description": "Return the data values for the Corridor defined by the query parameters", + "operationId": "PostInstanceDataForCorridor", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1corridor/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/locations": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "List available location identifers for the collection", + "description": "List the locations available for the collection", + "operationId": "ListCollectionDataLocations", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1items/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "List available location identifers for the collection", + "description": "List the locations available for the collection", + "operationId": "PostListCollectionDataLocations", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "bbox": { + "type": "string" + }, + "datetime": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/locations/{locId}": { + "get": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for queries of collection {collectionId} defined by a location id", + "description": "Return data the for the location defined by locid", + "operationId": "GetCollectionDataForLocation", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "name": "locId", + "in": "path", + "required": true, + "description": "Retreive data for the location defined by locId (i.e. London_Heathrow, EGLL, 03772 etc)", + "schema": { + "type": "string" + } + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/4" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Collection data queries" + ], + "summary": "Query end point for queries of collection {collectionId} defined by a location id", + "description": "Return data the for the location defined by locid", + "operationId": "PostCollectionDataForLocation", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1locations~1%7BlocId%7D/get/parameters/1" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "datetime": { + "type": "string" + }, + "parameter-name": { + "type": "array", + "items": { + "type": "string" + } + }, + "crs": { + "type": "string" + }, + "f": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/locations": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "List available location identifers for the instance", + "description": "List the locations available for the instance of the collection", + "operationId": "ListDataInstanceLocations", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1items/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "List available location identifers for the instance", + "description": "List the locations available for the instance of the collection", + "operationId": "ListDataInstanceLocations", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1locations/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + }, + "/collections/{collectionId}/instances/{instanceId}/locations/{locId}": { + "get": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for queries of instance {instanceId} of collection {collectionId} defined by a location id", + "description": "Return data the for the location defined by locid", + "operationId": "GetInstanceDataForLocation", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1locations~1%7BlocId%7D/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/parameters/5" + }, + { + "$ref": "#/paths/~1/get/parameters/0" + } + ], + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + }, + "post": { + "tags": [ + "Instance data queries" + ], + "summary": "Query end point for queries of instance {instanceId} of collection {collectionId} defined by a location id", + "description": "Return data the for the location defined by locid", + "operationId": "PostInstanceDataForLocation", + "parameters": [ + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D/get/parameters/0" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1instances~1%7BinstanceId%7D~1area/get/parameters/1" + }, + { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1locations~1%7BlocId%7D/get/parameters/1" + } + ], + "requestBody": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1locations~1%7BlocId%7D/post/requestBody" + }, + "responses": { + "200": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/200" + }, + "202": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/202" + }, + "308": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/308" + }, + "400": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/400" + }, + "404": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/404" + }, + "413": { + "$ref": "#/paths/~1collections~1%7BcollectionId%7D~1area/get/responses/413" + }, + "default": { + "$ref": "#/paths/~1collections/get/responses/default" + } + } + } + } + } +}