geovisio 2.5.0__py3-none-any.whl → 2.7.0__py3-none-any.whl

geovisio/web/configuration.py

@@ -1,5 +1,8 @@
 import flask
+from typing import Dict, Any
 from flask import jsonify
+from flask_babel import get_locale
+from geovisio.web.utils import get_api_version
 
 bp = flask.Blueprint("configuration", __name__, url_prefix="/api")
 
@@ -19,14 +22,25 @@ def configuration():
                         $ref: '#/components/schemas/GeoVisioConfiguration'
     """
 
+    apiSum = flask.current_app.config["API_SUMMARY"]
+    userLang = get_locale().language
     return jsonify(
         {
+            "name": _get_translated(apiSum.name, userLang),
+            "description": _get_translated(apiSum.description, userLang),
+            "logo": apiSum.logo,
+            "color": str(apiSum.color),
             "auth": _auth_configuration(),
             "license": _license_configuration(),
+            "version": get_api_version(),
         }
     )
 
 
+def _get_translated(prop: Dict[str, str], userLang) -> Dict[str, Any]:
+    return {"label": prop.get(userLang, prop.get("en")), "langs": prop}
+
+
 def _auth_configuration():
     from geovisio.utils import auth
 

geovisio/web/docs.py

@@ -1,7 +1,9 @@
-from geovisio.web import utils
+from geovisio.web import utils, upload_set, reports, excluded_areas
+from geovisio.utils import upload_set as upload_set_utils, reports as reports_utils, excluded_areas as excluded_areas_utils
 from importlib import metadata
 import re
 
+
 API_CONFIG = {
     "openapi": "3.1.0",
     "paths": {
@@ -40,6 +42,28 @@ API_CONFIG = {
             "STACCollection": {
                 "$ref": f"https://api.stacspec.org/v{utils.STAC_VERSION}/collections/openapi.yaml#/components/schemas/collection"
             },
+            "STACProvider": {
+                # We cannot reference the STACProvider from the STAC spec because it is defined in an array, so this is a copy of the definition
+                "type": "object",
+                "required": ["name"],
+                "properties": {
+                    "name": {"description": "The name of the organization or the individual.", "type": "string"},
+                    "description": {
+                        "description": "Multi-line description to add further provider information such as processing details for processors and producers, hosting details for hosts or basic contact information.\n\n[CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.",
+                        "type": "string",
+                    },
+                    "roles": {
+                        "description": "Roles of the provider.\n\nThe provider's role(s) can be one or more of the following\nelements:\n\n* licensor: The organization that is licensing the dataset under\n  the license specified in the collection's license field.\n* producer: The producer of the data is the provider that\n  initially captured and processed the source data, e.g. ESA for\n  Sentinel-2 data.\n* processor: A processor is any provider who processed data to a\n  derived product.\n* host: The host is the actual provider offering the data on their\n  storage. There should be no more than one host, specified as last\n  element of the list.",
+                        "type": "array",
+                        "items": {"type": "string", "enum": ["producer", "licensor", "processor", "host"]},
+                    },
+                    "url": {
+                        "description": "Homepage on which the provider describes the dataset and publishes contact information.",
+                        "type": "string",
+                        "format": "url",
+                    },
+                },
+            },
             "STACCollectionItems": {
                 # The following link is the one that should be used, but is broken due to geometryCollectionGeoJSON definition
                 # "$ref": f"https://api.stacspec.org/v{utils.STAC_VERSION}/ogcapi-features/openapi.yaml#/components/schemas/featureCollectionGeoJSON"
@@ -120,10 +144,63 @@ API_CONFIG = {
             "STACItemSearchBody": {
                 "$ref": f"https://api.stacspec.org/v{utils.STAC_VERSION}/item-search/openapi.yaml#/components/schemas/searchBody"
             },
+            "MapLibreStyleJSON": {
+                "type": "object",
+                "description": """MapLibre Style JSON, see https://maplibre.org/maplibre-style-spec/ for reference.
+
+Source ID is either \"geovisio\" or \"geovisio_{userId}\".
+
+Layers ID are \"geovisio_grid\", \"geovisio_sequences\" and \"geovisio_pictures\", or with user UUID included (\"geovisio_{userId}_sequences\" and \"geovisio_{userId}_pictures\").
+
+Note that you may not rely only on these ID that could change through time.
+""",
+                "properties": {
+                    "version": {"type": "integer", "example": 8},
+                    "name": {"type": "string", "example": "GeoVisio Vector Tiles"},
+                    "sources": {
+                        "type": "object",
+                        "properties": {
+                            "geovisio": {
+                                "type": "object",
+                                "properties": {
+                                    "type": {"type": "string", "example": "vector"},
+                                    "minzoom": {"type": "integer", "example": "0"},
+                                    "maxzoom": {"type": "integer", "example": "15"},
+                                    "tiles": {"type": "array", "items": {"type": "string"}},
+                                },
+                            }
+                        },
+                    },
+                    "layers": {
+                        "type": "array",
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "id": {"type": "string"},
+                                "source": {"type": "string"},
+                                "source-layer": {"type": "string"},
+                                "type": {"type": "string"},
+                                "paint": {"type": "object"},
+                                "layout": {"type": "object"},
+                            },
+                        },
+                    },
+                },
+            },
             "GeoVisioLanding": {
                 "allOf": [
                     {"$ref": "#/components/schemas/STACLanding"},
-                    {"type": "object", "properties": {"extent": {"$ref": "#/components/schemas/STACExtent"}}},
+                    {
+                        "type": "object",
+                        "properties": {
+                            "extent": {"$ref": "#/components/schemas/STACExtent"},
+                            "geovisio_version": {
+                                "type": "string",
+                                "description": "The GeoVisio API version number",
+                                "example": "2.6.0-12-ab12cd34",
+                            },
+                        },
+                    },
                 ]
             },
             "GeoVisioCatalog": {
@@ -148,12 +225,31 @@ API_CONFIG = {
                     },
                 ]
             },
+            "GeoVisioPostUploadSet": upload_set.UploadSetCreationParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPostUploadSet/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioUploadSet": upload_set_utils.UploadSet.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioUploadSet/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioAddToUploadSet": upload_set.AddFileToUploadSetParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioAddToUploadSet/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioUploadSets": upload_set_utils.UploadSets.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioUploadSets/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioUploadSetFile": upload_set_utils.UploadSetFile.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioUploadSetFile/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioUploadSetFiles": upload_set_utils.UploadSetFiles.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioUploadSetFiles/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioCollectionOfCollection": {
                 "allOf": [
                     {"$ref": "#/components/schemas/STACCollection"},
                     {
                         "type": "object",
                         "properties": {
+                            "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
                             "links": {
                                 "type": "array",
                                 "items": {
@@ -163,6 +259,7 @@ API_CONFIG = {
                                         "stats:items": {"$ref": "#/components/schemas/STACStatsForItems"},
                                         "extent": {"$ref": "#/components/schemas/STACExtentTemporal"},
                                         "geovisio:status": {"$ref": "#/components/schemas/GeoVisioCollectionStatus"},
+                                        "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
                                         "created": {
                                             "type": "string",
                                             "format": "date-time",
@@ -175,7 +272,7 @@ API_CONFIG = {
                                         },
                                     },
                                 },
-                            }
+                            },
                         },
                     },
                 ]
@@ -220,6 +317,18 @@ API_CONFIG = {
                     },
                 },
             },
+            "GeoVisioProvider": {
+                # In geovisio, Provider have an additional optional ID
+                "allOf": [
+                    {"$ref": "#/components/schemas/STACProvider"},
+                    {
+                        "type": "object",
+                        "properties": {
+                            "id": {"type": "string", "format": "uuid"},
+                        },
+                    },
+                ]
+            },
             "GeoVisioCollection": {
                 "allOf": [
                     {"$ref": "#/components/schemas/STACCollection"},
@@ -229,6 +338,14 @@ API_CONFIG = {
                             "stats:items": {"$ref": "#/components/schemas/STACStatsForItems"},
                             "geovisio:status": {"$ref": "#/components/schemas/GeoVisioCollectionStatus"},
                             "geovisio:sorted-by": {"$ref": "#/components/schemas/GeoVisioCollectionSortedBy"},
+                            "geovisio:upload-software": {"$ref": "#/components/schemas/GeoVisioCollectionUploadSoftware"},
+                            "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
+                            "providers": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/GeoVisioProvider",
+                                },
+                            },
                         },
                     },
                 ]
@@ -312,6 +429,11 @@ If unset, sort order is unchanged.
                             "properties": {
                                 "type": "object",
                                 "properties": {
+                                    "datetimetz": {
+                                        "type": "string",
+                                        "format": "date-time",
+                                        "title": "Date & time with original timezone information",
+                                    },
                                     "geovisio:status": {"$ref": "#/components/schemas/GeoVisioItemStatus"},
                                     "geovisio:producer": {"type": "string"},
                                     "geovisio:image": {"type": "string", "format": "uri"},
@@ -349,7 +471,7 @@ If unset, sort order is unchanged.
             "GeoVisioPostItem": {
                 "type": "object",
                 "patternProperties": {
-                    "override_(Exif|Xmp)\..+": {
+                    r"override_(Exif|Xmp)\..+": {
                         "type": "string",
                         "description": "An EXIF or XMP tag to use instead of existing one in picture file metadata. The query name can be any valid Exiv2 property name.",
                     }
@@ -395,12 +517,12 @@ If unset, sort order is unchanged.
                             "place_position": {
                                 "description": "Geographical coordinates (lon,lat) of a place you'd like to have pictures of. Returned pictures are either 360° or looking in direction of wanted place.",
                                 "type": "string",
-                                "pattern": "-?\d+\.\d+,-?\d+\.\d+",
+                                "pattern": r"-?\d+\.\d+,-?\d+\.\d+",
                             },
                             "place_distance": {
                                 "description": "Distance range (in meters) to search pictures for a particular place (place_position). Default range is 3-15. Only used if place_position parameter is defined.",
                                 "type": "string",
-                                "pattern": "\d+-\d+",
+                                "pattern": r"\d+-\d+",
                             },
                             "place_fov_tolerance": {
                                 "type": "integer",
@@ -445,6 +567,7 @@ Note that this parameter is not taken in account for 360° pictures, as by defin
                 },
             },
             "GeoVisioCollectionStatus": {"type": "string", "enum": ["ready", "broken", "preparing", "waiting-for-process"]},
+            "GeoVisioLengthKm": {"type": "number", "description": "Total length of sequence (in kilometers)"},
             "GeoVisioCollectionSortedBy": {
                 "description": """
 Define the pictures sort order of the sequence. Null by default, and can be set via the collection PATCH.
@@ -458,10 +581,39 @@ Available properties are:
                 "type": "string",
                 "enum": ["+gpsdate", "-gpsdate", "+filedate", "-filedate", "+filename", "-filename"],
             },
+            "GeoVisioCollectionUploadSoftware": {
+                "type": "string",
+                "enum": ["unknown", "other", "website", "cli", "mobile_app"],
+                "description": "Simplified name of software used to create this collection",
+            },
             "GeoVisioItemStatus": {
                 "type": "string",
                 "enum": ["ready", "broken", "waiting-for-process"],
             },
+            "GeoVisioPostReport": reports.ReportCreationParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPostReport/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioPatchReport": reports.EditReportParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPatchReport/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioReport": reports_utils.Report.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioReport/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioReports": reports_utils.Reports.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioReports/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioExcludedArea": excluded_areas_utils.ExcludedAreaFeature.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioExcludedArea/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioExcludedAreas": excluded_areas_utils.ExcludedAreaFeatureCollection.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioExcludedAreas/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioExcludedAreaCreateFeature": excluded_areas.ExcludedAreaCreateFeature.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioExcludedAreaCreateFeature/$defs/{model}", mode="serialization"
+            ),
+            "GeoVisioExcludedAreaCreateCollection": excluded_areas.ExcludedAreaCreateCollection.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioExcludedAreaCreateCollection/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioUserList": {
                 "type": "object",
                 "properties": {
@@ -521,6 +673,39 @@ Available properties are:
             "GeoVisioConfiguration": {
                 "type": "object",
                 "properties": {
+                    "name": {
+                        "type": "object",
+                        "properties": {
+                            "label": {"type": "string", "description": "User-readable server name, in user language"},
+                            "langs": {
+                                "type": "object",
+                                "additionalProperties": "string",
+                                "description": "Translated names as lang -> value object",
+                                "default": {"en": "GeoVisio"},
+                            },
+                        },
+                    },
+                    "description": {
+                        "type": "object",
+                        "properties": {
+                            "label": {"type": "string", "description": "User-readable server description, in user language"},
+                            "langs": {
+                                "type": "object",
+                                "additionalProperties": "string",
+                                "description": "Translated descriptions as lang -> value object",
+                                "default": {"en": "The open source photo mapping solution"},
+                            },
+                        },
+                    },
+                    "logo": {
+                        "default": "https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/logo.svg",
+                        "format": "uri",
+                        "maxLength": 2083,
+                        "minLength": 1,
+                        "title": "Logo",
+                        "type": "string",
+                    },
+                    "color": {"default": "#bf360c", "format": "color", "title": "Color", "type": "string"},
                     "auth": {
                         "type": "object",
                         "properties": {
@@ -537,6 +722,11 @@ Available properties are:
                         },
                         "required": ["id"],
                     },
+                    "geovisio_version": {
+                        "type": "string",
+                        "description": "The GeoVisio API version number",
+                        "example": "2.6.0-12-ab12cd34",
+                    },
                 },
                 "required": ["auth"],
             },
@@ -558,7 +748,7 @@ Available properties are:
                     },
                 },
             },
-            "JWToken": {
+            "GeoVisioEncodedToken": {
                 "type": "object",
                 "properties": {
                     "id": {"type": "string"},
@@ -572,7 +762,7 @@ Available properties are:
             },
             "JWTokenClaimable": {
                 "allOf": [
-                    {"$ref": "#/components/schemas/JWToken"},
+                    {"$ref": "#/components/schemas/GeoVisioEncodedToken"},
                     {
                         "type": "object",
                         "properties": {
@@ -591,6 +781,14 @@ Available properties are:
                     },
                 ]
             },
+            "GeoVisioError": {
+                "type": "object",
+                "properties": {
+                    "message": {"type": "string", "description": "The error message"},
+                    "status_code": {"type": "integer", "description": "The HTTP status code"},
+                    "payload": {"type": "object", "description": "The error payload"},
+                },
+            },
         },
         "parameters": {
             "STAC_bbox": {"$ref": f"https://api.stacspec.org/v{utils.STAC_VERSION}/item-search/openapi.yaml#/components/parameters/bbox"},
@@ -655,14 +853,14 @@ Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials
                 "in": "query",
                 "required": False,
                 "description": "Geographical coordinates (lon,lat) of a place you'd like to have pictures of. Returned pictures are either 360° or looking in direction of wanted place.",
-                "schema": {"type": "string", "pattern": "-?\d+\.\d+,-?\d+\.\d+"},
+                "schema": {"type": "string", "pattern": r"-?\d+\.\d+,-?\d+\.\d+"},
             },
             "GeoVisio_place_distance": {
                 "name": "place_distance",
                 "in": "query",
                 "required": False,
                 "description": "Distance range (in meters) to search pictures for a particular place (place_position). Default range is 3-15. Only used if place_position parameter is defined.",
-                "schema": {"type": "string", "pattern": "\d+-\d+", "default": "3-15"},
+                "schema": {"type": "string", "pattern": r"\d+-\d+", "default": "3-15"},
             },
             "GeoVisio_place_fov_tolerance": {
                 "name": "place_fov_tolerance",
@@ -686,6 +884,78 @@ Note that this parameter is not taken in account for 360° pictures, as by defin
                 "required": False,
                 "schema": {"type": "integer", "minimum": 2, "maximum": 180, "default": 30},
             },
+            "GeoVisioReports_filter": {
+                "name": "filter",
+                "in": "query",
+                "description": """
+A CQL2 filter expression for filtering reports.
+
+Allowed properties are: 
+ * status: 'open', 'open_autofix', 'waiting', 'closed_solved', 'closed_ignored'
+ * reporter: 'me', user account ID or unset
+ * owner: 'me', user account ID or unset
+
+Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html
+
+Examples:
+
+* status IN ('open', 'open_autofix', 'waiting') AND (reporter = 'me' OR owner = 'me')
+
+By default, we only show open or waiting reports, sorted by descending creation date.
+""",
+                "required": False,
+                "schema": {
+                    "type": "string",
+                    "default": "status IN ('open', 'open_autofix', 'waiting') AND (reporter = 'me' OR owner = 'me')",
+                },
+            },
+            "GeoVisioUserReports_filter": {
+                "name": "filter",
+                "in": "query",
+                "description": """
+A CQL2 filter expression for filtering reports.
+
+Allowed properties are: 
+ * status: 'open', 'open_autofix', 'waiting', 'closed_solved', 'closed_ignored'
+ * reporter: 'me' or unset
+ * owner: 'me' or unset
+
+Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html
+
+Examples:
+
+* status IN ('open', 'open_autofix', 'waiting') AND (reporter = 'me' OR owner = 'me')
+
+By default, we only show open or waiting reports concerning you, sorted by descending creation date.
+""",
+                "required": False,
+                "schema": {
+                    "type": "string",
+                    "default": "status IN ('open', 'open_autofix', 'waiting') AND (reporter = 'me' OR owner = 'me')",
+                },
+            },
+            "UploadSetFilter": {
+                "name": "filter",
+                "in": "query",
+                "description": """
+A CQL2 filter expression for filtering upload sets.
+
+Allowed properties are: 
+ * completed: TRUE or FALSE
+ * dispatched: TRUE or FALSE
+
+Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html
+
+Examples:
+
+* 'completed = TRUE AND dispatched = FALSE'
+
+By default, we only show non dispatched upload sets.
+If you want all the upload sets, you need to set an empty filter or a filter that matches everything.
+""",
+                "required": False,
+                "schema": {"type": "string", "default": "completed=FALSE AND dispatched = FALSE"},
+            },
             "OGC_sortby": {
                 "name": "sortby",
                 "in": "query",
@@ -746,7 +1016,7 @@ def getApiInfo():
     author = apiMeta["Author-email"].split(",")[0]
     m = AUTHOR_RGX.match(author)
     if not m:
-        raise Exception("impossible to find email in pyproject")
+        raise Exception("Impossible to find email in pyproject")
     name = m.group("Name")
     email = m.group("Email")
 
@@ -768,8 +1038,14 @@ def getApiDocs():
             {"name": "Sequences", "description": "Collections of pictures"},
             {"name": "Pictures", "description": "Geolocated images"},
             {"name": "Map", "description": "Tiles for web map display"},
-            {"name": "Upload", "description": "Sending pictures & sequences"},
+            {
+                "name": "Upload",
+                "description": "Sending pictures & sequences",
+                "externalDocs": {"url": "https://docs.panoramax.fr/api/api/api/#upload"},
+            },
             {"name": "Editing", "description": "Modifying pictures & sequences"},
+            {"name": "Reports", "description": "Report issues with pictures & sequences"},
+            {"name": "Excluded Areas", "description": "Areas where pictures cannot be uploaded"},
             {"name": "Users", "description": "Account management"},
             {"name": "Auth", "description": "User authentication"},
         ],