✨ Introduce delete data product docs (#2495)

* ✨ Introduce delete data product docs * 🔖 Update changelog and version file to v1.0.14
ministryofjustice · Nov 23, 2023 · 5b47681 · 5b47681
1 parent 6a4e90f
commit 5b47681
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 3 deletions.
diff --git a/containers/daap-docs/CHANGELOG.md b/containers/daap-docs/CHANGELOG.md
@@ -9,6 +9,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.14] 2023-11-23
+
+## Added
+
+- Delete data product documentation
+
 ## [1.0.13] 2023-11-14
 
 - Fix parameter names for /preview endpoint

diff --git a/containers/daap-docs/config.json b/containers/daap-docs/config.json
@@ -1,6 +1,6 @@
 {
     "name": "daap-docs",
-    "version": "1.0.13",
+    "version": "1.0.14",
     "registry": "ecr",
     "ecr": {
         "role": "arn:aws:iam::013433889002:role/modernisation-platform-oidc-cicd",

diff --git a/containers/daap-docs/src/var/task/swagger.json b/containers/daap-docs/src/var/task/swagger.json
@@ -409,6 +409,65 @@
             "authorizationToken": []
           }
         ]
+      },
+      "delete": {
+        "tags": [
+          "data product"
+        ],
+        "summary": "Delete an existing Data Product.",
+        "description": "Deletes an existing Data Product.",
+        "operationId": "deleteDataProduct",
+        "parameters": [
+          {
+            "in": "header",
+            "name": "authorizationToken",
+            "schema": {
+              "type": "string",
+              "format": "uuid"
+            },
+            "required": true
+          },
+          {
+            "in": "path",
+            "name": "data-product-name",
+            "required": true,
+            "example": "my_data_product",
+            "schema": {
+              "type": "string",
+              "minimum": 1
+            },
+            "description": "The name of the data product you want to delete."
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successfully updated",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "required": [
+                    "version"
+                  ],
+                  "properties": {
+                    "message": {
+                      "type": "string",
+                      "example": "Successfully removed data product 'data_product_name'."
+                    }
+                  },
+                  "example": {
+                    "message": "Successfully removed data product 'data_product_name'."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "authorizationToken": []
+          }
+        ]
       }
     },
     "/data-product/{data-product-name}/table/{table-name}/schema": {
@@ -880,7 +939,11 @@
           "status": {
             "type": "string",
             "description": "this is an enum representing the status of this version of the Data Product. Allowed values are: [draft|published|retired]. This is a metadata that communicates the overall status of the Data Product but is not reflected to the actual deployment status.",
-            "enum": ["draft", "published", "retired"]
+            "enum": [
+              "draft",
+              "published",
+              "retired"
+            ]
           },
           "dpiaRequired": {
             "type": "boolean",
@@ -899,7 +962,9 @@
           "tags": {
             "type": "object",
             "description": "Additional tags to add.",
-            "example": { "sandbox": true }
+            "example": {
+              "sandbox": true
+            }
           }
         },
         "additionalProperties": false