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

geovisio/web/docs.py

@@ -1,4 +1,4 @@
-from geovisio.web import utils, upload_set, reports, excluded_areas
+from geovisio.web import annotations, collections, items, prepare, users, utils, upload_set, reports, excluded_areas, pages
 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
@@ -135,6 +135,9 @@ API_CONFIG = {
                 },
             },
             "STACStatsForItems": {"$ref": "https://stac-extensions.github.io/stats/v0.2.0/schema.json#/definitions/stats_for_items"},
+            "STACStatsForCollections": {
+                "$ref": "https://stac-extensions.github.io/stats/v0.2.0/schema.json#/definitions/stats_for_collections"
+            },
             "STACLinks": {
                 "type": "object",
                 "properties": {
@@ -157,6 +160,15 @@ 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"},
+                    "metadata": {
+                        "type": "object",
+                        "properties": {
+                            "panoramax:fields": {
+                                "type": "object",
+                                "description": "Available properties per layer (layer: [field1, field2...])",
+                            }
+                        },
+                    },
                     "sources": {
                         "type": "object",
                         "properties": {
@@ -225,6 +237,9 @@ Note that you may not rely only on these ID that could change through time.
                     },
                 ]
             },
+            "PreparationParameter": prepare.PreparationParameter.model_json_schema(
+                ref_template="#/components/schemas/PreparationParameter/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioPostUploadSet": upload_set.UploadSetCreationParameter.model_json_schema(
                 ref_template="#/components/schemas/GeoVisioPostUploadSet/$defs/{model}", mode="serialization"
             ),
@@ -257,6 +272,7 @@ Note that you may not rely only on these ID that could change through time.
                                     "required": ["href", "rel"],
                                     "properties": {
                                         "stats:items": {"$ref": "#/components/schemas/STACStatsForItems"},
+                                        "stats:collections": {"$ref": "#/components/schemas/STACStatsForCollections"},
                                         "extent": {"$ref": "#/components/schemas/STACExtentTemporal"},
                                         "geovisio:status": {"$ref": "#/components/schemas/GeoVisioCollectionStatus"},
                                         "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
@@ -277,6 +293,30 @@ Note that you may not rely only on these ID that could change through time.
                     },
                 ]
             },
+            "GeoVisioCSVCollections": {
+                "type": "string",
+                "descrition": f"""CSV file containing the collections.
+
+The CSV headers will be:
+* id: ID of the collection
+* status: Status of the collection
+* name: Name of the collection (its title)
+* created: Creation date of the collection
+* updated: Last update date of the collection
+* capture_date: Computed capture date of the collection (date of its first picture)
+* minimum_capture_time: Capture datetime of the first picture
+* maximum_capture_time: Capture datetime of the last picture
+* min_x: Minimum X coordinate of the bounding box of the collection
+* min_y: Minimum Y coordinate of the bounding box of the collection
+* max_x: Maximum X coordinate of the bounding box of the collection
+* max_y: Maximum Y coordinate of the bounding box of the collection
+* nb_pictures: Number of pictures in the collection
+* length_km: Total length of the collection in kilometers
+* computed_h_pixel_density: Horizontal pixel density of the pictures in the collection, if all pictures have the same one
+* computed_gps_accuracy: GPS accuracy of the pictures in the collection, if all pictures have the same one
+
+""",
+            },
             "GeoVisioCollections": {
                 "allOf": [
                     {"$ref": "#/components/schemas/STACCollections"},
@@ -340,12 +380,28 @@ Note that you may not rely only on these ID that could change through time.
                             "geovisio:sorted-by": {"$ref": "#/components/schemas/GeoVisioCollectionSortedBy"},
                             "geovisio:upload-software": {"$ref": "#/components/schemas/GeoVisioCollectionUploadSoftware"},
                             "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
+                            "quality:horizontal_accuracy": {"type": "number", "title": "Estimated GPS position precision (in meters)"},
+                            "quality:horizontal_accuracy_type": {
+                                "type": "string",
+                                "title": "Estimation process for GPS precision",
+                                "example": "95% confidence interval",
+                            },
                             "providers": {
                                 "type": "array",
                                 "items": {
                                     "$ref": "#/components/schemas/GeoVisioProvider",
                                 },
                             },
+                            "summaries": {
+                                "type": "object",
+                                "properties": {
+                                    "panoramax:horizontal_pixel_density": {
+                                        "type": "array",
+                                        "title": "Number of pixels on horizon per field of view degree (as a list with a single value for STAC conformance)",
+                                        "items": {"type": "integer", "minimum": 0},
+                                    },
+                                },
+                            },
                         },
                     },
                 ]
@@ -375,41 +431,9 @@ Note that you may not rely only on these ID that could change through time.
                 "type": "object",
                 "properties": {"title": {"type": "string", "description": "The sequence title"}},
             },
-            "GeoVisioPatchCollection": {
-                "type": "object",
-                "properties": {
-                    "visible": {
-                        "type": "string",
-                        "description": "Should the sequence be publicly visible ?",
-                        "enum": ["true", "false", "null"],
-                        "default": "null",
-                    },
-                    "title": {
-                        "type": "string",
-                        "description": "The sequence title (publicly displayed)",
-                    },
-                    "relative_heading": {
-                        "type": "number",
-                        "minimum": -180,
-                        "maximum": 180,
-                        "description": "The relative heading (in degrees), offset based on movement path (0° = looking forward, -90° = looking left, 90° = looking right). Headings are unchanged if this parameter is not set.",
-                    },
-                    "sortby": {
-                        "description": """
-Define the pictures sort order based on given property. Sort order is defined based on preceding '+' (asc) or '-' (desc).
-
-Available properties are:
-* `gpsdate`: sort by GPS datetime
-* `filedate`: sort by the camera-generated capture date. This is based on EXIF tags `Exif.Image.DateTimeOriginal`, `Exif.Photo.DateTimeOriginal`, `Exif.Image.DateTime` or `Xmp.GPano.SourceImageCreateTime` (in this order).
-* `filename`: sort by the original picture file name
-
-If unset, sort order is unchanged.
-""",
-                        "type": "string",
-                        "enum": ["+gpsdate", "-gpsdate", "+filedate", "-filedate", "+filename", "-filename"],
-                    },
-                },
-            },
+            "GeoVisioPatchCollection": collections.PatchCollectionParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPatchCollection/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioCollectionItems": {
                 "allOf": [
                     {"$ref": "#/components/schemas/STACCollectionItems"},
@@ -440,6 +464,15 @@ If unset, sort order is unchanged.
                                     "geovisio:thumbnail": {"type": "string", "format": "uri"},
                                     "original_file:size": {"type": "integer", "minimum": 0, "title": "Size of the original file, in bytes"},
                                     "original_file:name": {"type": "string", "title": "Original file name"},
+                                    "panoramax:horizontal_pixel_density": {
+                                        "type": "integer",
+                                        "minimum": 0,
+                                        "title": "Number of pixels on horizon per field of view degree",
+                                    },
+                                    "quality:horizontal_accuracy": {
+                                        "type": "number",
+                                        "title": "Estimated GPS position precision (in meters)",
+                                    },
                                 },
                             }
                         },
@@ -485,7 +518,7 @@ If unset, sort order is unchanged.
                     },
                     "isBlurred": {
                         "type": "string",
-                        "description": "Is picture blurred",
+                        "description": "Is picture blurred. If set to 'true', the server will not apply the face blurring algorithm but will publish the image as it is",
                         "enum": ["true", "false", "null"],
                         "default": "false",
                     },
@@ -549,23 +582,9 @@ Note that this parameter is not taken in account for 360° pictures, as by defin
                     },
                 ],
             },
-            "GeoVisioPatchItem": {
-                "type": "object",
-                "properties": {
-                    "visible": {
-                        "type": "string",
-                        "description": "Should the picture be publicly visible ?",
-                        "enum": ["true", "false", "null"],
-                        "default": "null",
-                    },
-                    "heading": {
-                        "type": "number",
-                        "minimum": 0,
-                        "maximum": 360,
-                        "description": "The picture heading (in degrees). North is 0°, East = 90°, South = 180° and West = 270°.",
-                    },
-                },
-            },
+            "GeoVisioPatchItem": items.PatchItemParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPatchItem/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioCollectionStatus": {"type": "string", "enum": ["ready", "broken", "preparing", "waiting-for-process"]},
             "GeoVisioLengthKm": {"type": "number", "description": "Total length of sequence (in kilometers)"},
             "GeoVisioCollectionSortedBy": {
@@ -625,6 +644,9 @@ Available properties are:
                     },
                 },
             },
+            "GeoVisioUserConfiguration": users.UserConfiguration.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioUserConfiguration/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioUser": {
                 "type": "object",
                 "properties": {
@@ -670,6 +692,10 @@ Available properties are:
                     },
                 },
             },
+            "GeoVisioPageName": {"type": "string", "enum": ["end-user-license-agreement", "terms-of-service"]},
+            "GeoVisioPageSummary": pages.PageSummary.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPageSummary/$defs/{model}", mode="serialization"
+            ),
             "GeoVisioConfiguration": {
                 "type": "object",
                 "properties": {
@@ -697,6 +723,21 @@ Available properties are:
                             },
                         },
                     },
+                    "geo_coverage": {
+                        "type": "object",
+                        "properties": {
+                            "label": {
+                                "type": "string",
+                                "description": "Instance geographical coverage for pictures uploads, in user language",
+                            },
+                            "langs": {
+                                "type": "object",
+                                "additionalProperties": "string",
+                                "description": "Translated descriptions as lang -> value object",
+                                "default": {"en": "Worldwide\nThe picture can be sent from anywhere in the world."},
+                            },
+                        },
+                    },
                     "logo": {
                         "default": "https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/logo.svg",
                         "format": "uri",
@@ -706,11 +747,13 @@ Available properties are:
                         "type": "string",
                     },
                     "color": {"default": "#bf360c", "format": "color", "title": "Color", "type": "string"},
+                    "email": {"default": "panoramax@panoramax.fr", "format": "email", "title": "Contact email", "type": "string"},
                     "auth": {
                         "type": "object",
                         "properties": {
                             "user_profile": {"type": "object", "properties": {"url": {"type": "string"}}},
                             "enabled": {"type": "boolean"},
+                            "enforce_tos_acceptance": {"type": "boolean"},
                         },
                         "required": ["enabled"],
                     },
@@ -1044,9 +1087,11 @@ def getApiDocs():
                 "externalDocs": {"url": "https://docs.panoramax.fr/api/api/api/#upload"},
             },
             {"name": "Editing", "description": "Modifying pictures & sequences"},
+            {"name": "Semantics", "description": "Panoramax semantics"},
             {"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"},
+            {"name": "Configuration", "description": "Various settings"},
         ],
     }