feat(policy): add soft-delete/deactivation to namespaces, attribute definitions, attribute values #96 #108

docs/openapi/attributes/attributes.swagger.json

@@ -18,7 +18,7 @@
   "paths": {
     "/attributes": {
       "post": {
-        "summary": "Create Attribute\nExample:\n grpcurl -plaintext -d '{\"attribute\": {\"namespace_id\": \"namespace_id\", \"name\": \"attribute_name\", \"rule\": \"ATTRIBUTE_RULE_TYPE_ENUM_ALL_OF\"}}' localhost:8080 attributes.AttributesService/CreateAttribute",
+        "summary": "Create Attribute\nRequest:\ngrpcurl -plaintext -d '{\"attribute\": {\"namespace_id\": \"namespace_id\", \"name\": \"attribute_name\", \"rule\": \"ATTRIBUTE_RULE_TYPE_ENUM_ALL_OF\"}}' localhost:9000 attributes.AttributesService/CreateAttribute\nResponse\n{\n\"attribute\": {\n\"id\": \"e06f067b-d158-44bc-a814-1aa3f968dcf0\",\n\"metadata\": {\n\"createdAt\": \"2024-02-14T20:24:23.057404Z\",\n\"updatedAt\": \"2024-02-14T20:24:23.057404Z\"\n},\n\"namespace\": {\n\"id\": \"namespace_id\"\n},\n\"name\": \"attribute_name\",\n\"rule\": \"ATTRIBUTE_RULE_TYPE_ENUM_ALL_OF\",\n\"active\": true\n}\n}",
         "operationId": "AttributesService_CreateAttribute",
         "responses": {
           "200": {
@@ -80,12 +80,12 @@
         ]
       },
       "delete": {
-        "operationId": "AttributesService_DeleteAttributeValue",
+        "operationId": "AttributesService_DeactivateAttributeValue",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/attributesDeleteAttributeValueResponse"
+              "$ref": "#/definitions/attributesDeactivateAttributeValueResponse"
             }
           },
           "default": {
@@ -246,7 +246,7 @@
     },
     "/attributes/{attributeId}/values": {
       "post": {
-        "summary": "Create Attribute Value\nExample:\n grpcurl -plaintext -d '{\"attribute_id\": \"attribute_id\", \"value\": {\"value\": \"value\"}}' localhost:8080 attributes.AttributesService/CreateValue",
+        "summary": "Create Attribute Value\nExample:\n grpcurl -plaintext -d '{\"attribute_id\": \"attribute_id\", \"value\": {\"value\": \"value\"}}' localhost:8080 attributes.AttributesService/CreateAttributeValue",
         "operationId": "AttributesService_CreateAttributeValue",
         "responses": {
           "200": {
@@ -357,12 +357,12 @@
         ]
       },
       "delete": {
-        "operationId": "AttributesService_DeleteAttribute",
+        "operationId": "AttributesService_DeactivateAttribute",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/attributesDeleteAttributeResponse"
+              "$ref": "#/definitions/attributesDeactivateAttributeResponse"
             }
           },
           "default": {
@@ -474,6 +474,10 @@
             "type": "object",
             "$ref": "#/definitions/kasregistryKeyAccessServer"
           }
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },
@@ -544,15 +548,15 @@
         }
       }
     },
-    "attributesDeleteAttributeResponse": {
+    "attributesDeactivateAttributeResponse": {
       "type": "object",
       "properties": {
         "attribute": {
           "$ref": "#/definitions/attributesAttribute"
         }
       }
     },
-    "attributesDeleteAttributeValueResponse": {
+    "attributesDeactivateAttributeValueResponse": {
       "type": "object",
       "properties": {
         "value": {
@@ -662,6 +666,10 @@
             "$ref": "#/definitions/kasregistryKeyAccessServer"
           },
           "title": "list of key access servers"
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },
@@ -694,6 +702,17 @@
         }
       }
     },
+    "commonActiveStateEnum": {
+      "type": "string",
+      "enum": [
+        "ACTIVE_STATE_ENUM_UNSPECIFIED",
+        "ACTIVE_STATE_ENUM_ACTIVE",
+        "ACTIVE_STATE_ENUM_INACTIVE",
+        "ACTIVE_STATE_ENUM_ANY"
+      ],
+      "default": "ACTIVE_STATE_ENUM_UNSPECIFIED",
+      "title": "buflint ENUM_VALUE_PREFIX: to make sure that C++ scoping rules aren't violated when users add new enum values to an enum in a given package"
+    },
     "commonMetadata": {
       "type": "object",
       "properties": {
@@ -779,6 +798,10 @@
         "name": {
           "type": "string",
           "title": "used to partition Attribute Definitions, support by namespace AuthN and enable federation"
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },

docs/openapi/namespaces/namespaces.swagger.json

@@ -18,6 +18,7 @@
   "paths": {
     "/attributes/namespaces": {
       "get": {
+        "summary": "NOTE: ACTIVE state by default, INACTIVE or ANY when specified\nRequest: \ngrpcurl -plaintext localhost:9000 namespaces.NamespaceService/ListNamespaces\nResponse:\n{\n\"namespaces\": [\n{\n\"id\": \"namespace-id\",\n\"name\": \"namespace-name\",\n\"active\": true\n}\n]\n}",
         "operationId": "NamespaceService_ListNamespaces",
         "responses": {
           "200": {
@@ -33,11 +34,28 @@
             }
           }
         },
+        "parameters": [
+          {
+            "name": "state",
+            "description": "ACTIVE by default when not specified",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "enum": [
+              "ACTIVE_STATE_ENUM_UNSPECIFIED",
+              "ACTIVE_STATE_ENUM_ACTIVE",
+              "ACTIVE_STATE_ENUM_INACTIVE",
+              "ACTIVE_STATE_ENUM_ANY"
+            ],
+            "default": "ACTIVE_STATE_ENUM_UNSPECIFIED"
+          }
+        ],
         "tags": [
           "NamespaceService"
         ]
       },
       "post": {
+        "summary": "Request: \ngrpcurl -plaintext -d '{\"name\": \"namespace-name\"}' localhost:9000 namespaces.NamespaceService/CreateNamespace\nResponse:\n{ \"namespace\": { \"id\": \"namespace-id\", \"active\": true } }",
         "operationId": "NamespaceService_CreateNamespace",
         "responses": {
           "200": {
@@ -68,6 +86,7 @@
     },
     "/attributes/namespaces/{id}": {
       "get": {
+        "summary": "Request: \ngrpcurl -plaintext -d '{\"id\": \"namespace-id\"}' localhost:9000 namespaces.NamespaceService/GetNamespace\nResponse:\n{\n\"namespace\": {\n\"id\": \"namespace-id\",\n\"name\": \"namespace-name\",\n\"active\": true\n}\n}",
         "operationId": "NamespaceService_GetNamespace",
         "responses": {
           "200": {
@@ -96,12 +115,12 @@
         ]
       },
       "delete": {
-        "operationId": "NamespaceService_DeleteNamespace",
+        "operationId": "NamespaceService_DeactivateNamespace",
         "responses": {
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/namespacesDeleteNamespaceResponse"
+              "$ref": "#/definitions/namespacesDeactivateNamespaceResponse"
             }
           },
           "default": {
@@ -160,6 +179,17 @@
     }
   },
   "definitions": {
+    "commonActiveStateEnum": {
+      "type": "string",
+      "enum": [
+        "ACTIVE_STATE_ENUM_UNSPECIFIED",
+        "ACTIVE_STATE_ENUM_ACTIVE",
+        "ACTIVE_STATE_ENUM_INACTIVE",
+        "ACTIVE_STATE_ENUM_ANY"
+      ],
+      "default": "ACTIVE_STATE_ENUM_UNSPECIFIED",
+      "title": "buflint ENUM_VALUE_PREFIX: to make sure that C++ scoping rules aren't violated when users add new enum values to an enum in a given package"
+    },
     "namespacesCreateNamespaceResponse": {
       "type": "object",
       "properties": {
@@ -168,7 +198,7 @@
         }
       }
     },
-    "namespacesDeleteNamespaceResponse": {
+    "namespacesDeactivateNamespaceResponse": {
       "type": "object"
     },
     "namespacesGetNamespaceResponse": {
@@ -201,6 +231,10 @@
         "name": {
           "type": "string",
           "title": "used to partition Attribute Definitions, support by namespace AuthN and enable federation"
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },

docs/openapi/resourcemapping/resource_mapping.swagger.json

@@ -204,6 +204,10 @@
             "$ref": "#/definitions/kasregistryKeyAccessServer"
           },
           "title": "list of key access servers"
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },

docs/openapi/subjectmapping/subject_mapping.swagger.json

@@ -194,6 +194,10 @@
             "$ref": "#/definitions/kasregistryKeyAccessServer"
           },
           "title": "list of key access servers"
+        },
+        "active": {
+          "type": "boolean",
+          "title": "active by default until explicitly deactivated"
         }
       }
     },