{ "openapi": "3.0.0", "info": { "title": "La vie de la rivi\u00e8re", "version": "1.0.0" }, "paths": { "\/api\/cities": { "get": { "tags": [ "Geojson" ], "summary": "Get cities as geojson", "operationId": null, "responses": { "200": { "description": "Geojson", "content": { "application\/json": { "schema": { "required": [ "type", "features" ], "properties": { "type": { "description": "Valeur fixe : 'FeatureCollection'.", "type": "string", "example": "FeatureCollection" }, "features": { "description": "Features list.", "type": "array", "items": { "schema": "CityController", "required": [ "type", "geometry", "properties" ], "properties": { "type": { "description": "Valeur fixe : 'Feature'.", "type": "string", "example": "Feature" }, "geometry": { "required": [ "type", "coordinates" ], "properties": { "type": { "description": "Geometry types", "type": "string", "example": "MultiPolygon" }, "coordinates": { "description": "WGS84 MultiPolygon.", "type": "array", "items": { "schema": "CityController", "type": "array", "items": { "schema": "CityController", "type": "array", "items": { "schema": "CityController", "type": "array", "items": { "description": "Coordinates segment part", "type": "number", "format": "float" }, "maxLength": 2, "minLength": 2 }, "example": [ [ 42.538, 2.771 ], [ 43.538, 3.771 ], [ 43.43, 3.05 ] ] } } } }, "type": "object" }, "properties": { "required": [ "id", "label", "zip", "department", "latitude", "longitude" ], "properties": { "id": { "description": "City id", "type": "number", "format": "integer", "example": 10 }, "label": { "description": "City label", "type": "string", "example": "Toulouse" }, "zip": { "description": "City zip", "type": "string", "example": "31470" }, "department": { "description": "City department", "required": [ "code", "label" ], "properties": { "code": { "description": "Department code", "type": "string" }, "label": { "description": "Department label", "type": "string" } }, "type": "object", "example": { "code": 31, "label": "Haute-Garonne" } }, "latitude": { "description": "Latitde of city center", "type": "number", "format": "float", "example": 1.2093 }, "longitude": { "description": "longitude of city center", "type": "number", "format": "float", "example": 1.2093 } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/hydro-stations": { "get": { "tags": [ "Geojson" ], "summary": "Get hydro stations as geojson", "operationId": null, "responses": { "200": { "description": "Geojson", "content": { "application\/json": { "schema": { "required": [ "type", "features" ], "properties": { "type": { "description": "Hardcoded value: 'FeatureCollection'.", "type": "string", "example": "FeatureCollection" }, "features": { "description": "Features list.", "type": "array", "items": { "schema": "HydroStationController", "required": [ "type", "geometry", "properties" ], "properties": { "type": { "description": "Hardcoded value: 'Feature'.", "type": "string", "example": "Feature" }, "geometry": { "required": [ "type", "coordinates" ], "properties": { "type": { "description": "Geometry types", "type": "string", "example": "Point" }, "coordinates": { "description": "WGS84 location.", "type": "array", "items": { "schema": "HydroStationController", "type": "number", "format": "float" }, "example": [ 42.538, 2.771 ] } }, "type": "object" }, "properties": { "required": [ "code", "label", "short_label", "is_spc", "has_daily_quantiles", "quantities", "doe_threshold", "dar_threshold", "da_threshold", "dcr_threshold", "department", "manager", "management_unit", "watercourse", "pool", "order" ], "properties": { "code": { "description": "Entity code", "type": "string", "example": "O2000010" }, "label": { "description": "Entity label", "type": "string", "example": "Ribennes [Ganivet]" }, "short_label": { "description": "Entity short label", "type": "string", "example": "Ganivet" }, "is_spc": { "description": "True if hydro station is SPC", "type": "boolean", "example": true }, "has_daily_quantiles": { "description": "True if hydro station has daily quantiles", "type": "boolean", "example": true }, "quantities": { "description": "List of available quantities", "type": "array", "items": { "type": "string", "example": "H" } }, "thresholds": { "properties": { "doe": { "description": "DOE Threshold", "type": "number", "format": "float", "example": 100.2 }, "dar": { "description": "DAR Threshold", "type": "number", "format": "float", "example": 4590 }, "da": { "description": "DA Threshold", "type": "number", "format": "float", "example": 218.6 }, "dcr": { "description": "DCR Threshold", "type": "number", "format": "float", "example": 218.6 } }, "type": "object" }, "sub_management_unit": { "properties": { "id": { "description": "sub management unit id", "type": "number", "format": "integer", "example": 100 }, "label": { "description": "sub management unit label", "type": "number", "format": "integer", "example": "Lot amont (amont Mende)" }, "order": { "description": "sub management unit order", "type": "number", "format": "integer", "example": 1 } }, "type": "object" }, "department": { "description": "department", "required": [ "code", "label" ], "properties": { "code": { "description": "Department code", "type": "string" }, "label": { "description": "Department label", "type": "string" } }, "type": "object", "example": { "code": 31, "label": "Haute-Garonne" } }, "managers": { "description": "Entity managers", "type": "string", "example": "EDF" }, "management_unit": { "description": "Manager unit", "type": "string", "example": "Colagne" }, "pool": { "description": "Pool", "type": "string", "example": "Lot amont" }, "watercourse": { "description": "Watercourse", "properties": { "id": { "description": "Watercourse ID", "type": "number", "format": "integer" }, "label": { "description": "Watercourse label", "type": "string" } }, "type": "object", "example": { "id": 84000, "label": "le Vers" } }, "order": { "description": "usefull to sort entities", "type": "number", "format": "integer", "example": 8 } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/autocomplete": { "get": { "tags": [ "Tools" ], "summary": "Get global results (hydro stations, cities & sub management units) that match given search string.", "operationId": null, "parameters": [ { "name": "term", "in": "query", "description": "Search string", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Autocompletion results", "content": { "application\/json": { "schema": { "type": "array", "items": { "required": [ "label", "code", "type", "id", "latitude", "longitude" ], "properties": { "label": { "description": "Label of the entity (hydro station \/ city \/ sub management unit)", "type": "string" }, "code": { "description": "Code of hydro station or sub management unit \/ Zip of city", "type": "string" }, "type": { "description": "Entity type ; can be hydro_station, city or sub_management_unit", "type": "string" }, "id": { "description": "Technical ID", "type": "string" }, "latitude": { "description": "Latitude of entity", "type": "number", "format": "float" }, "longitude": { "description": "Longitude of entiy", "type": "number", "format": "float" } }, "type": "object" } } } } } } } }, "\/api\/map\/all-groups-layers": { "get": { "tags": [ "Map" ], "summary": "Get all map layers grouped by map layer groups, and ordered by weight.", "operationId": null, "responses": { "200": { "description": "Get all map layers grouped by map layer groups, and ordered by weight", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "MapLayerController", "required": [ "id", "label", "weight", "layers" ], "properties": { "id": { "description": "Unique universal identifier. Is NULL for the default group.", "type": "string", "format": "uuid", "example": "3decfc3a-8bdc-4f18-89fb-4fcbc8d4f64e" }, "label": { "description": "Display label.", "type": "string", "example": "Hydrography" }, "weight": { "description": "Weight.", "type": "integer", "example": 10 }, "layers": { "description": "List of layers.", "type": "array", "items": { "schema": "MapLayerController", "required": [ "id", "label", "weight", "dataProducer", "type", "url", "isBase", "isDisplayedByDefault", "handler", "attribution", "style", "settings" ], "properties": { "id": { "description": "Unique universal identifier.", "type": "string", "format": "uuid", "example": "c6110092-28d2-4639-bffa-b19517cb9d13" }, "label": { "description": "Display label.", "type": "string", "example": "Rivers" }, "weight": { "description": "Weight.", "type": "integer", "example": 5 }, "dataProducer": { "description": "Who produced this data. For information.", "type": "string", "example": "M\u00e9t\u00e9o France" }, "type": { "description": "Type of layer. One of: 'wms_tile_layer', 'tile_layer', 'geojson', 'station', 'sub_management_unit', 'hydrography', 'toponym', 'precipitation'.", "type": "string", "example": "geojson" }, "geojsonSource": { "description": "True for locally managed geojson, False otherwise.", "type": "boolean", "example": true }, "url": { "description": "Where to find this layer's data.", "type": "string", "example": "https:\/\/{s}.example.com\/map\/{z}\/{x}\/{y}.png" }, "isDisplayedByDefault": { "description": "Whether this layer is displayed by default.", "type": "boolean", "example": true }, "attribution": { "description": "What to be displayed on the map as attribution.", "type": "string", "example": "Your company - Copyright 2018-2021" }, "style": { "description": "Layer style, usually as JSON.", "type": "string", "example": "{ \"color\": \"#b30500us\", \"radius\": 3 }" }, "settings": { "description": "Layer settings, usually as JSON.", "type": "string", "example": "{\"layers\":\"main_areas\",\"transparent\":true,\"format\":\"image\/png\", \"bbox\": [0.3, 44.2, 3.7, 45.1]}" } }, "type": "object" } } }, "type": "object" } } } } } } } }, "\/api\/observations": { "get": { "tags": [ "Observations" ], "summary": "Get data.", "operationId": null, "parameters": [ { "name": "code", "in": "query", "description": "Entity code", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "startAt", "in": "query", "description": "First date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "endAt", "in": "query", "description": "Last date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "quantity", "in": "query", "description": "Requested quantity : Qi|QmH|QmJ|Qm3J|Qm10J|H", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "(Qi|QmH|QmJ|Qm3J|Qm10J|H)" } } ], "responses": { "200": { "description": "Get observations", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "ObservationController", "required": [ "d", "v" ], "properties": { "d": { "description": "Observation date (format: 'yyyy-mm-ddThh-ii-ssZ')", "type": "string", "format": "date-time", "example": "2000-01-31T00:00:00Z" }, "v": { "description": "Observation value (m3\/l for flow, mm for height", "type": "number", "format": "integer", "example": 10 } }, "type": "object" } } } } }, "400": { "description": "Invalid request" } } } }, "\/api\/vcn3": { "get": { "tags": [ "Observations" ], "summary": "Get vcn3", "operationId": null, "parameters": [ { "name": "code", "in": "query", "description": "Entity code", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "startAt", "in": "query", "description": "First date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "endAt", "in": "query", "description": "Last date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get VCN3 values", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "ObservationController", "required": [ "d", "v" ], "properties": { "y": { "description": "VCN3 year", "type": "number", "format": "integer", "example": "2000" }, "d": { "description": "Observation date (format: 'yyyy-mm-ddThh-ii-ssZ')", "type": "string", "format": "date-time", "example": "2000-01-31T00:00:00Z" }, "v": { "description": "VCN3 value (m3\/l)", "type": "number", "format": "float", "example": 10 } }, "type": "object" } } } } }, "400": { "description": "Invalid request" } } } }, "\/api\/vcn10": { "get": { "tags": [ "Observations" ], "summary": "Get vcn10", "operationId": null, "parameters": [ { "name": "code", "in": "query", "description": "Entity code", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } }, { "name": "startAt", "in": "query", "description": "First date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "endAt", "in": "query", "description": "Last date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get VCN10 values", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "ObservationController", "required": [ "d", "v" ], "properties": { "y": { "description": "VCN10 year", "type": "number", "format": "integer", "example": "2000" }, "d": { "description": "Observation date (format: 'yyyy-mm-ddThh-ii-ssZ')", "type": "string", "format": "date-time", "example": "2000-01-31T00:00:00Z" }, "v": { "description": "VCN10 value (m3\/l)", "type": "number", "format": "float", "example": 10 } }, "type": "object" } } } } }, "400": { "description": "Invalid request" } } } }, "\/api\/multiple-entities\/observations": { "get": { "tags": [ "Observations" ], "summary": "Get data.", "operationId": null, "parameters": [ { "name": "codes[]", "in": "query", "description": "Entity codes", "required": false, "allowEmptyValue": false, "explode": true, "schema": { "type": "array", "items": {}, "default": null } }, { "name": "startAt", "in": "query", "description": "First date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "endAt", "in": "query", "description": "Last date in format Y-m-dTH:i:sZ", "required": false, "allowEmptyValue": true, "schema": { "type": "string", "default": null } }, { "name": "quantity", "in": "query", "description": "Requested quantity : Qi|QmH|QmJ|Qm3J|Qm10J|H", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null, "pattern": "(Qi|QmH|QmJ|Qm3J|Qm10J|H)" } } ], "responses": { "200": { "description": "Get observations", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "ObservationController", "required": [ "d", "v" ], "properties": { "d": { "description": "Observation date (format: 'yyyy-mm-ddThh-ii-ssZ')", "type": "string", "format": "date-time", "example": "2000-01-31T00:00:00Z" }, "v": { "description": "Observations values (m3\/s for flow, mm for height", "properties": { "[ENTITY CODE]": { "description": "Observation value (m3\/s for flow, mm for height for specific entity code", "type": "number", "format": "float", "example": 10.9182 } }, "type": "object" } }, "type": "object" } } } } }, "400": { "description": "Invalid request" } } } }, "\/api\/daily-quantiles": { "get": { "tags": [ "Observations" ], "summary": "Get data.", "operationId": null, "parameters": [ { "name": "code", "in": "query", "description": "Entity code", "required": false, "allowEmptyValue": false, "schema": { "type": "string", "default": null } } ], "responses": { "200": { "description": "Get daily quantiles for given hydro site", "content": { "application\/json": { "schema": { "type": "array", "items": { "schema": "ObservationController", "required": [ "d", "maximum", "q90", "q80", "q50", "q20", "q10", "minimum", "numYears" ], "properties": { "d": { "description": "Quantile date (in the format 'mm-dd'", "type": "string", "format": "date-time", "example": "01-31" }, "maximum": { "description": "Maximum", "type": "number", "format": "float", "example": 1686.621 }, "q90": { "description": "Wet decade", "type": "number", "format": "float", "example": 829.734 }, "q80": { "description": "Wet quinquennial", "type": "number", "format": "float", "example": 594.088 }, "q50": { "description": "Median", "type": "number", "format": "float", "example": 406.733 }, "q20": { "description": "Dry quinquennial", "type": "number", "format": "float", "example": 196.428 }, "q10": { "description": "Dry decennial", "type": "number", "format": "float", "example": 126.464 }, "minimum": { "description": "Minimum", "type": "number", "format": "float", "example": 94.428 }, "numYears": { "description": "Number of observations", "type": "number", "format": "integer", "example": 50 } }, "type": "object" } } } } }, "400": { "description": "Invalid request" } } } }, "\/api\/sub-management-units": { "get": { "tags": [ "Geojson" ], "summary": "Get sub management units as geojson", "operationId": null, "responses": { "200": { "description": "Geojson", "content": { "application\/json": { "schema": { "required": [ "type", "features" ], "properties": { "type": { "description": "Hardcoded value: 'FeatureCollection'.", "type": "string", "example": "FeatureCollection" }, "features": { "description": "Features list.", "type": "array", "items": { "schema": "SubManagementUnit", "required": [ "type", "geometry", "properties" ], "properties": { "type": { "description": "Hardcoded value: 'Feature'.", "type": "string", "example": "Feature" }, "geometry": { "required": [ "type", "coordinates" ], "properties": { "type": { "description": "Geometry types", "type": "string", "example": "MultiPolygon" }, "coordinates": { "description": "WGS84 MultiPolygon.", "type": "array", "items": { "schema": "SubManagementUnit", "type": "array", "items": { "schema": "SubManagementUnit", "type": "array", "items": { "schema": "SubManagementUnit", "type": "array", "items": { "description": "Coordinates segment part", "type": "number", "format": "float" }, "maxLength": 2, "minLength": 2 }, "example": [ [ 42.538, 2.771 ], [ 43.538, 3.771 ], [ 43.43, 3.05 ] ] } } } }, "type": "object" }, "properties": { "required": [ "id", "label", "manangement_unit", "reference_hydro_station" ], "properties": { "id": { "description": "Sub management unit id", "type": "number", "format": "integer", "example": 154 }, "label": { "description": "Sub management unit label", "type": "string", "example": "Lot domanial amont" }, "manangement_unit": { "description": "Management unit", "properties": { "id": { "description": "Management unit ID", "type": "number", "format": "integer" }, "label": { "description": "Management unit label", "type": "string" } }, "type": "object", "example": { "id": 92, "label": "Lot amont" } }, "reference_hydro_station": { "description": "Reference hydro station", "properties": { "code": { "description": "Hydro station code", "type": "string" }, "label": { "description": "Hydro station label", "type": "string" } }, "type": "object", "example": { "code": "O7021530", "label": "Mende [aval]" } } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/watercourses": { "get": { "tags": [ "Geojson" ], "summary": "Get watercourses as geojson", "operationId": null, "responses": { "200": { "description": "Geojson", "content": { "application\/json": { "schema": { "required": [ "type", "features" ], "properties": { "type": { "description": "Hardcoded value: 'FeatureCollection'.", "type": "string", "example": "FeatureCollection" }, "features": { "description": "Features list.", "type": "array", "items": { "schema": "WatercourseController", "required": [ "type", "geometry", "properties" ], "properties": { "type": { "description": "Hardcoded value: 'Feature'.", "type": "string", "example": "Feature" }, "geometry": { "required": [ "type", "coordinates" ], "properties": { "type": { "description": "Geometry types", "type": "string", "example": "LineString" }, "coordinates": { "description": "WGS84 LineString.", "type": "array", "items": { "schema": "WatercourseController", "type": "array", "items": { "description": "Coordinates segment part", "type": "number", "format": "float" }, "maxLength": 2, "minLength": 2 }, "example": [ [ 42.538, 2.771 ], [ 43.538, 3.771 ] ] } }, "type": "object" }, "properties": { "required": [ "id", "label", "manangement_unit", "reference_hydro_station" ], "properties": { "id": { "description": "Watercourse id", "type": "number", "format": "integer", "example": 92202 }, "label": { "description": "Watercourse label", "type": "string", "example": "l'Urugne" }, "manangement_unit": { "description": "Management unit", "properties": { "id": { "description": "Management unit ID", "type": "number", "format": "integer" }, "label": { "description": "Management unit label", "type": "string" } }, "type": "object", "example": { "id": 92, "label": "Lot amont" } }, "reference_hydro_station": { "description": "Reference hydro station", "properties": { "code": { "description": "Hydro station code", "type": "string" }, "label": { "description": "Hydro station label", "type": "string" } }, "type": "object", "example": { "code": "O7021530", "label": "Mende [aval]" } } }, "type": "object" } }, "type": "object" } } }, "type": "object" } } } } } } }, "\/api\/doc.json": { "get": { "operationId": null, "responses": { "default": { "description": "" } } } } } }