Merge pull request #44 from joaherrerama/DocsAPIresponses

Documentation for 400 HTTP responses
actinia-org · Nov 24, 2021 · 8e3aeb2 · 8e3aeb2
2 parents 9e35905 + ec8c4a2
commit 8e3aeb2
Show file tree

Hide file tree

Showing 4 changed files with 87 additions and 6 deletions.
diff --git a/actinia_stac_plugin/apidocs/stac_collections_docs.py b/actinia_stac_plugin/apidocs/stac_collections_docs.py
@@ -64,6 +64,19 @@
     "responses": {
         "200": {
             "description": "This response returns a message with the STAC collection successfully added"
-        }
+        },
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "Please check the URL provided (Should be a STAC Collection)",
+                    }
+                },
+            },
+        },
     },
 }
diff --git a/actinia_stac_plugin/apidocs/stac_collections_id_docs.py b/actinia_stac_plugin/apidocs/stac_collections_id_docs.py
@@ -38,7 +38,22 @@
             "required": True,
         }
     ],
-    "responses": {"200": {"description": "This response returns a STAC collection"}},
+    "responses": {
+        "200": {"description": "This response returns a STAC collection"},
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "Please check the collection id provide",
+                    }
+                },
+            },
+        },
+    },
 }
 
 staccollection_id_delete_docs = {
@@ -56,6 +71,20 @@
     "responses": {
         "200": {
             "description": "This response returns a message with the STAC collection successfully deleted"
-        }
+        },
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "stac_collection_id does not match the pattern "
+                        + "stac.<stac_instance_id>.rastercube.<stac_collection_id",
+                    }
+                },
+            },
+        },
     },
 }
diff --git a/actinia_stac_plugin/apidocs/stac_instances_docs.py b/actinia_stac_plugin/apidocs/stac_instances_docs.py
@@ -58,6 +58,19 @@
     "responses": {
         "200": {
             "description": "This response returns a message with the instance successfully added"
-        }
+        },
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "Please check the ID given (no spaces or undercore characters)",
+                    }
+                },
+            },
+        },
     },
 }
diff --git a/actinia_stac_plugin/apidocs/stac_instances_id_docs.py b/actinia_stac_plugin/apidocs/stac_instances_id_docs.py
@@ -39,7 +39,20 @@
         }
     ],
     "responses": {
-        "200": {"description": "This response returns a instance with its collections"}
+        "200": {"description": "This response returns a instance with its collections"},
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "stac instance ID does not match with the instences stored",
+                    }
+                },
+            },
+        },
     },
 }
 
@@ -59,6 +72,19 @@
         "200": {
             "description": "This response returns a message with the "
             + "instance and the STAC collections deleted"
-        }
+        },
+        "400": {
+            "description": "This response returns a detail error message",
+            "schema": {
+                "type": "object",
+                "properties": {
+                    "message": {
+                        "type": "string",
+                        "description": "detailed message",
+                        "example": "Something went wrong please check that the element is well typed",
+                    }
+                },
+            },
+        },
     },
 }