[A] Conditionally disable the POST /{catalog}/{action} endpoint

Author: dsotirho-ucsc

lambdas/indexer/app.py

@@ -53,7 +53,7 @@
         # changes and reset the minor version to zero. Otherwise, increment only
         # the minor version for backwards compatible changes. A backwards
         # compatible change is one that does not require updates to clients.
-        'version': '3.3',
+        'version': '4.0',
         'description': fd('''
             This is the internal API for Azul's indexer component.
         ''')

lambdas/indexer/openapi.json

@@ -721,115 +721,6 @@
                 ]
             }
         },
-        "/{catalog}/{action}": {
-            "post": {
-                "tags": [
-                    "Indexing"
-                ],
-                "summary": "Notify the indexer to perform an action on a bundle",
-                "description": "\nQueue a bundle for addition to or deletion from the index.\n\nThe request must be authenticated using HMAC via the ``signature``\nheader. Each Azul deployment has its own unique HMAC key. The HMAC\ncomponents are the request method, request path, and the SHA256\ndigest of the request body.\n\nA valid HMAC header proves that the client is in possession of the\nsecret HMAC key and that the request wasn't tampered with while\ntravelling between client and service, even though the latter is not\nstrictly necessary considering that TLS is used to encrypt the\nentire exchange. Internal clients can obtain the secret key from the\nenvironment they are running in, and that they share with the\nservice. External clients must have been given the secret key. The\nnow-defunct DSS was such an external client. The Azul indexer\nprovided the HMAC secret to DSS when it registered with DSS to be\nnotified about bundle additions/deletions. These days only internal\nclients use this endpoint.\n",
-                "requestBody": {
-                    "description": "Contents of the notification",
-                    "required": true,
-                    "content": {
-                        "application/json": {
-                            "schema": {
-                                "type": "object",
-                                "properties": {
-                                    "bundle_fqid": {
-                                        "type": "object",
-                                        "properties": {
-                                            "uuid": {
-                                                "type": "string"
-                                            },
-                                            "version": {
-                                                "type": "string"
-                                            },
-                                            "source": {
-                                                "type": "object",
-                                                "properties": {
-                                                    "id": {
-                                                        "type": "string"
-                                                    },
-                                                    "spec": {
-                                                        "type": "string"
-                                                    }
-                                                },
-                                                "required": [
-                                                    "id",
-                                                    "spec"
-                                                ],
-                                                "additionalProperties": false
-                                            }
-                                        },
-                                        "required": [
-                                            "uuid",
-                                            "version",
-                                            "source"
-                                        ],
-                                        "additionalProperties": false
-                                    }
-                                },
-                                "required": [
-                                    "bundle_fqid"
-                                ],
-                                "additionalProperties": false
-                            }
-                        }
-                    }
-                },
-                "parameters": [
-                    {
-                        "name": "catalog",
-                        "in": "path",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "enum": [
-                                "dcp2"
-                            ]
-                        },
-                        "description": "The name of the catalog to notify."
-                    },
-                    {
-                        "name": "action",
-                        "in": "path",
-                        "required": true,
-                        "schema": {
-                            "type": "string",
-                            "enum": [
-                                "add",
-                                "delete"
-                            ]
-                        },
-                        "description": "Which action to perform."
-                    },
-                    {
-                        "name": "signature",
-                        "in": "header",
-                        "required": true,
-                        "schema": {
-                            "type": "string"
-                        },
-                        "description": "HMAC authentication signature."
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "description": "Notification was successfully queued for processing"
-                    },
-                    "400": {
-                        "description": "Request was rejected due to malformed parameters"
-                    },
-                    "401": {
-                        "description": "Request lacked a valid HMAC header"
-                    },
-                    "504": {
-                        "description": "\nRequest timed out. When handling this response, clients\nshould wait the number of seconds specified in the\n`Retry-After` header and then retry the request.\n"
-                    }
-                }
-            }
-        },
         "/schemas/{facility}/{schema_name}/{version_and_extension}": {
             "get": {
                 "summary": "Retrieve JSON schemas",

src/azul/indexer/index_controller.py

@@ -70,6 +70,7 @@ def handlers(self) -> dict[str, Any]:
         @self.app.route(
             '/{catalog}/{action}',
             methods=['POST'],
+            enabled=config.enable_bundle_notifications,
             spec={
                 'tags': ['Indexing'],
                 'summary': 'Notify the indexer to perform an action on a bundle',