geovisio 2.9.0__py3-none-any.whl → 2.11.0__py3-none-any.whl

geovisio/web/docs.py

@@ -1,4 +1,4 @@
-from geovisio.web import collections, items, prepare, users, utils, upload_set, reports, excluded_areas, pages
+from geovisio.web import collections, items, prepare, users, utils, upload_set, reports, excluded_areas, pages, annotations
 from geovisio.utils import (
     upload_set as upload_set_utils,
     reports as reports_utils,
@@ -245,6 +245,12 @@ 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"
             ),
+            "GeovisioPostToken": {
+                "type": "object",
+                "properties": {
+                    "description": {"type": "string", "description": "optional description of the token"},
+                },
+            },
             "GeoVisioPostUploadSet": upload_set.UploadSetCreationParameter.model_json_schema(
                 ref_template="#/components/schemas/GeoVisioPostUploadSet/$defs/{model}", mode="serialization"
             ),
@@ -303,7 +309,7 @@ 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.
+                "description": f"""CSV file containing the collections.
 
 The CSV headers will be:
 * id: ID of the collection
@@ -388,6 +394,7 @@ The CSV headers will be:
                             "geovisio:sorted-by": {"$ref": "#/components/schemas/GeoVisioCollectionSortedBy"},
                             "geovisio:upload-software": {"$ref": "#/components/schemas/GeoVisioCollectionUploadSoftware"},
                             "geovisio:length_km": {"$ref": "#/components/schemas/GeoVisioLengthKm"},
+                            "geovisio:visibility": {"$ref": "#/components/schemas/GeoVisioVisibility"},
                             "quality:horizontal_accuracy": {"type": "number", "title": "Estimated GPS position precision (in meters)"},
                             "quality:horizontal_accuracy_type": {
                                 "type": "string",
@@ -464,7 +471,22 @@ The CSV headers will be:
                                     "datetimetz": {
                                         "type": "string",
                                         "format": "date-time",
-                                        "title": "Date & time with original timezone information",
+                                        "title": "Date & time of the picture (when it was captured).",
+                                    },
+                                    "datetimetz": {
+                                        "type": "string",
+                                        "format": "date-time",
+                                        "title": "Date & time of the picture (when it was captured) with original timezone information",
+                                    },
+                                    "created": {
+                                        "type": "string",
+                                        "format": "date-time",
+                                        "title": "Date & time of picture upload",
+                                    },
+                                    "updated": {
+                                        "type": "string",
+                                        "format": "date-time",
+                                        "title": "Date & time of picture's metadata update",
                                     },
                                     "geovisio:status": {"$ref": "#/components/schemas/GeoVisioItemStatus"},
                                     "geovisio:producer": {"type": "string"},
@@ -475,6 +497,7 @@ The CSV headers will be:
                                         "minimum": 1,
                                         "title": "Rank of the picture in its collection.",
                                     },
+                                    "geovisio:visibility": {"$ref": "#/components/schemas/GeoVisioVisibility"},
                                     "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": {
@@ -538,7 +561,7 @@ The CSV headers will be:
                     "override_capture_time": {
                         "type": "string",
                         "format": "date-time",
-                        "description": "datetime when the picture was taken. It will change the picture's metadata with this datetime. It should be an iso 3339 formated datetime (like '2017-07-21T17:32:28Z')",
+                        "description": "datetime when the picture was taken. It will change the picture's metadata with this datetime. It should be an iso 3339 formatted datetime (like '2017-07-21T17:32:28Z')",
                     },
                     "override_latitude": {
                         "type": "number",
@@ -591,6 +614,20 @@ Example values are:
 Note that this parameter is not taken in account for 360° pictures, as by definition a nearby place would be theorically always visible in it.
 """,
                             },
+                            "sortby": {
+                                "description": """Define the sort order of the results of a search. 
+Sort order is defined based on preceding '+' (asc) or '-' (desc).
+
+By default we sort to get the last updated pictures first.
+
+Available properties are:
+* `ts`: capture datetime of the picture
+* `updated`: sort by updated datetime of the picture
+* `id`: us the picture ID for sort
+""",
+                                "default": "-updated",
+                                "type": "string",
+                            },
                         },
                     },
                 ],
@@ -620,7 +657,15 @@ Available properties are:
             },
             "GeoVisioItemStatus": {
                 "type": "string",
-                "enum": ["ready", "broken", "waiting-for-process"],
+                "enum": ["ready", "broken", "waiting-for-process", "pouet"],
+            },
+            "GeoVisioVisibility": {
+                "type": "string",
+                "description": """Visibility of the object. Can be set to:
+    * `anyone`: visible to anyone
+    * `owner-only`: visible to the owner and administrator only
+    * `logged-only`: visible to logged users only. Note that this is not available on all Panoramax instances, only those with restricted account creation. See the possible visibility values for a given instance on /api/configuration (field `visibility`).""",
+                "enum": ["anyone", "owner-only", "logged-only"],
             },
             "GeoVisioPostReport": reports.ReportCreationParameter.model_json_schema(
                 ref_template="#/components/schemas/GeoVisioPostReport/$defs/{model}", mode="serialization"
@@ -776,6 +821,32 @@ Available properties are:
                         "description": "The GeoVisio API version number",
                         "example": "2.6.0-12-ab12cd34",
                     },
+                    "defaults": {
+                        "type": "object",
+                        "properties": {
+                            "collaborative_metadata": {
+                                "type": "integer",
+                                "description": "If `true`, the pictures's metadata will be, by default, editable by all users.",
+                            },
+                            "split_distance": {
+                                "type": "integer",
+                                "description": "Maximum distance between two pictures to be considered in the same sequence (in meters). If both split_distance and split_time are None, no split will occur by default.",
+                            },
+                            "split_time": {
+                                "type": "integer",
+                                "description": "Maximum time interval between two pictures to be considered in the same sequence. If both split_distance and split_time are None, no split will occur by default.",
+                            },
+                            "duplicate_distance": {
+                                "type": "integer",
+                                "description": "Maximum distance between two pictures to be considered as duplicates (in meters). If both duplicate_distance andduplicate_rotation are None, no deduplication will occur by default.",
+                            },
+                            "duplicate_rotation": {
+                                "type": "integer",
+                                "description": "Maximum angle of rotation for two too-close-pictures to be considered as duplicates (in degrees).",
+                            },
+                        },
+                        "required": ["collaborative_metadata", "duplicate_distance", "duplicate_rotation", "split_distance", "split_time"],
+                    },
                 },
                 "required": ["auth"],
             },
@@ -841,9 +912,12 @@ Available properties are:
             "GeoVisioAnnotation": annotations_utils.Annotation.model_json_schema(
                 ref_template="#/components/schemas/GeoVisioAnnotation/$defs/{model}", mode="serialization"
             ),
-            "GeoVisioPostAnnotation": annotations_utils.AnnotationCreationParameter.model_json_schema(
+            "GeoVisioPostAnnotation": annotations.AnnotationPostParameter.model_json_schema(
                 ref_template="#/components/schemas/GeoVisioPostAnnotation/$defs/{model}", mode="serialization"
             ),
+            "GeoVisioPatchAnnotation": annotations.AnnotationPatchParameter.model_json_schema(
+                ref_template="#/components/schemas/GeoVisioPatchAnnotation/$defs/{model}", mode="serialization"
+            ),
         },
         "parameters": {
             "STAC_bbox": {"$ref": f"https://api.stacspec.org/v{utils.STAC_VERSION}/item-search/openapi.yaml#/components/parameters/bbox"},
@@ -871,10 +945,11 @@ Available properties are:
                 "description": """
 A CQL2 filter expression for filtering sequences.
 
-Allowed properties are: 
+Allowed properties are:
  * "created": upload date
  * "updated": last edit date
- * "status": status of the sequence. Can either be "ready" (for collections ready to be served) or "deleted"  for deleted collection. By default, only the "ready" collections will be shown.
+
+Note: the `status` filter is not supported anymore, use the `show_deleted` parameter instead if you need to query deleted collections
 
 Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html
 
@@ -895,7 +970,7 @@ Examples:
                 "description": """
 A CQL2 filter expression for filtering tiles.
 
-Allowed properties are: 
+Allowed properties are:
  * "status": status of the sequence. Can either be "ready" (for collections ready to be served) or "hidden" for hidden collections. By default, only the "ready" collections will be shown.
 
 Usage doc can be found here: https://docs.geoserver.org/2.23.x/en/user/tutorials/cql/cql_tutorial.html
@@ -939,6 +1014,24 @@ 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},
             },
+            "GeoVisioSearchSortedBy": {
+                "name": "sortby",
+                "in": "query",
+                "description": """Define the sort order of the results of a search. 
+Sort order is defined based on preceding '+' (asc) or '-' (desc).
+
+By default we sort to get the last updated pictures first (-updated).
+
+Available properties are:
+* `ts`: capture datetime of the picture
+* `updated`: sort by updated datetime of the picture
+* `id`: us the picture ID for sort
+""",
+                "required": False,
+                "schema": {
+                    "type": "string",
+                },
+            },
             "searchCQL2_filter": {
                 "name": "filter",
                 "in": "query",
@@ -955,11 +1048,14 @@ For the moment only equality (`=`) and list (`IN`) filters are supported. We do
 
 To search for any values of a semantic tag, use `semantics.some_key IS NOT NULL` (case matter here).
 
+To search for items with any semantic tags, use `"semantics" IS NOT NULL`.
+
 Examples:
 
 * "semantics.osm|traffic_sign"='yes'
 * "semantics.osm|traffic_sign" IS NOT NULL'
 * "semantics.osm|amenity" IN ('bench', 'whatever') OR "semantics.osm|traffic_sign"='yes'
+* "semantics" IS NOT NULL
 """,
                 "required": False,
                 "schema": {
@@ -972,7 +1068,7 @@ Examples:
                 "description": """
 A CQL2 filter expression for filtering reports.
 
-Allowed properties are: 
+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
@@ -997,7 +1093,7 @@ By default, we only show open or waiting reports, sorted by descending creation
                 "description": """
 A CQL2 filter expression for filtering reports.
 
-Allowed properties are: 
+Allowed properties are:
  * status: 'open', 'open_autofix', 'waiting', 'closed_solved', 'closed_ignored'
  * reporter: 'me' or unset
  * owner: 'me' or unset
@@ -1022,7 +1118,7 @@ By default, we only show open or waiting reports concerning you, sorted by desce
                 "description": """
 A CQL2 filter expression for filtering upload sets.
 
-Allowed properties are: 
+Allowed properties are:
  * completed: TRUE or FALSE
  * dispatched: TRUE or FALSE
 
@@ -1092,7 +1188,7 @@ def getApiInfo():
     """Return API metadata parsed from pyproject.toml"""
     apiMeta = metadata.metadata("geovisio")
 
-    # url is formated like 'Home, <url>
+    # url is formatted like 'Home, <url>
     url = apiMeta["Project-URL"].split(",")[1].rstrip()
     # there can be several authors, but we only display the first one in docs
     author = apiMeta["Author-email"].split(",")[0]