Merge pull request #468 from NHSDigital/apm-4807-remove-api-catalogue-functionality

APM-4807: Remove anything to do with the API Catalogue

Author: alexhawdon

ansible/collections/ansible_collections/nhsd/apigee/plugins/action/deploy_api_catalog_item.py

@@ -1,5 +1,3 @@
-import typing
-
 APIGEE_BASE_URL = "https://api.enterprise.apigee.com/v1/"
 APIGEE_DAPI_URL = "https://apigee.com/dapi/api/"
 
@@ -13,16 +11,3 @@
     ],
     "nhsd-prod": ["dev", "int", "sandbox", "prod"],
 }
-
-
-def portal_uri(org: typing.Literal["nhsd-nonprod", "nhsd-prod"]) -> str:
-    portal_ids = {
-        "nhsd-nonprod": "nhsd-nonprod-developerportal",
-        "nhsd-prod": "nhsd-prod-developerportal",
-    }
-    if org not in portal_ids:
-        raise ValueError(f"Invalid organization name {org}")
-    return f"https://apigee.com/portals/api/sites/{portal_ids[org]}/apidocs"
-
-
-

ansible/collections/ansible_collections/nhsd/apigee/plugins/module_utils/constants.py

@@ -59,11 +59,4 @@ def apply_namespace(cls, manifest, values):
             for spec in env.specs:
                 spec.name = spec.name.replace(old, new, 1)
 
-            for entry in env.api_catalog:
-                entry.edgeAPIProductName = entry.edgeAPIProductName.replace(
-                    old, new, 1
-                )
-                entry.title =  f"[{display}] {entry.title}"
-                entry.specId = entry.specId.replace(old, new, 1)
-
         return manifest

ansible/collections/ansible_collections/nhsd/apigee/plugins/module_utils/models/ansible/apply_pull_request_namespace.py

@@ -1,8 +1,5 @@
 import typing
 import pydantic
-from ansible_collections.nhsd.apigee.plugins.module_utils.models.apigee.apidoc import (
-    ApigeeApidoc,
-)
 from ansible_collections.nhsd.apigee.plugins.module_utils.models.apigee.spec import (
     ApigeeSpec,
 )
@@ -16,7 +13,6 @@ class ManifestApigeeEnvironment(pydantic.BaseModel):
     name: LITERAL_APIGEE_ENVIRONMENTS
     products: typing.List[ApigeeProduct] = []
     specs: typing.List[ApigeeSpec] = []
-    api_catalog: typing.List[ApigeeApidoc] = []
 
     @pydantic.validator("products", "specs")
     def names_unique(cls, values):
@@ -25,22 +21,6 @@ def names_unique(cls, values):
             raise ValueError("Names are not unique")
         return values
 
-    @pydantic.validator("api_catalog")
-    def catalog_references(cls, api_catalog, values):
-        spec_names = [spec.name for spec in values.get("specs", [])]
-        product_names = [product.name for product in values.get("products", [])]
-
-        for item in api_catalog:
-            if item.edgeAPIProductName not in product_names:
-                raise ValueError(
-                    f"edgeAPIProductName {item.edgeAPIProductName} not in list of products in this environment"
-                )
-            if item.specId and item.specId not in spec_names:
-                raise ValueError(
-                    f"specId {item.specId} not in list of specs in this environment"
-                )
-        return api_catalog
-
     @pydantic.validator("products", pre=True)
     def set_single_environment(cls, products, values):
         """

ansible/collections/ansible_collections/nhsd/apigee/plugins/module_utils/models/ansible/deploy_api_catalog_item.py

@@ -4,7 +4,7 @@
 
 from ansible_collections.nhsd.apigee.plugins.module_utils.paas import api_registry
 
-SCHEMA_VERSION = "1.1.6"
+SCHEMA_VERSION = "1.1.8"
 
 _REGISTRY_DATA = {}
 

ansible/collections/ansible_collections/nhsd/apigee/plugins/module_utils/models/apigee/apidoc.py

@@ -74,56 +74,6 @@ def put(url, access_token, **kwargs):
     return request("PUT", url, access_token, **kwargs)
 
 
-def select_unique(
-    items: typing.List[typing.Dict[str, typing.Any]],
-    key: str,
-    value: str,
-    valid_lengths: typing.Optional[typing.List[int]] = None,
-) -> typing.List[typing.Dict[str, typing.Any]]:
-
-    selected = [item for item in items if item.get(key) == value]
-    if not valid_lengths:
-        valid_lengths = [0, 1]
-    if len(selected) not in valid_lengths:
-        raise ValueError(f"{JSON.dumps(selected)}")
-    return selected
-
-
-def get_all_apidocs(organization, access_token, task_vars=None, refresh=False):
-    """
-    Get all apidocs for organization. Requires valid apigee acess_token.
-
-    If task_vars is passed in, will search in there for the apidocs.
-    If task_vars is included, will update the task_vars with APIGEE_APIDOCS.
-    """
-    if task_vars is None:
-        task_vars = {}
-    apidocs = task_vars.get("APIGEE_APIDOCS")
-    if refresh or not apidocs:
-        all_results = []
-
-        params = {
-            "pageSize" : 100
-        }
-        scan = True
-
-        while scan:
-            apidocs_request = get(constants.portal_uri(organization), access_token, params=params)
-            if apidocs_request.get("failed"):
-                return apidocs_request
-
-            next_page_token = apidocs_request["response"]["body"]["next_page_token"]
-            all_results += apidocs_request["response"]["body"]["data"]
-
-            if next_page_token != "":
-                params["pageToken"] = next_page_token
-            else:
-                scan = False
-
-        task_vars.update({"APIGEE_APIDOCS": all_results})
-    return task_vars
-
-
 def get_all_spec_resources(organization, access_token, task_vars=None, refresh=False):
     """
     Get all spec_resources for organization.  Requires valid apigee

ansible/collections/ansible_collections/nhsd/apigee/plugins/module_utils/models/manifest/apigee_environment.py

@@ -62,14 +62,3 @@
     organization: "{{ APIGEE_ORGANIZATION }}"
     access_token: "{{ APIGEE_ACCESS_TOKEN }}"
   loop: "{{ apigee_environment.specs }}"
-
-- name: deploy api catalog
-  nhsd.apigee.deploy_api_catalog_item:
-    api_catalog_item: "{{ item }}"
-    organization: "{{ APIGEE_ORGANIZATION }}"
-    access_token: "{{ APIGEE_ACCESS_TOKEN }}"
-  loop: "{{ apigee_environment.api_catalog }}"
-  # See comment on product loop control. (I believe APIDocs
-  # actually can reference products that don't exist. But this is
-  # cleaner.)
-  when: APIGEE_ORGANIZATION == 'nhsd-prod' and item.edgeAPIProductName | regex_search('^' + SERVICE_NAME + '-' + PULL_REQUEST | default(APIGEE_ENVIRONMENT))