chore: re-gen global-catalog service with latest API def

Author: padamstx

ibm_platform_services/global_catalog_v1.py

@@ -151,14 +151,16 @@ def list_catalog_entries(self, *, account: str = None, include: str = None, q: s
         return response
 
 
-    def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str, images: 'Image', disabled: bool, tags: List[str], provider: 'Provider', *, parent_id: str = None, parent_url: str = None, group: bool = None, metadata: 'ObjectMetaData' = None, active: bool = None, children: List['CatalogEntry'] = None, account: str = None, **kwargs) -> DetailedResponse:
+    def create_catalog_entry(self, id: str, name: str, overview_ui: 'OverviewUI', kind: str, images: 'Image', disabled: bool, tags: List[str], provider: 'Provider', *, parent_id: str = None, group: bool = None, metadata: 'ObjectMetaData' = None, active: bool = None, account: str = None, **kwargs) -> DetailedResponse:
         """
         Create a catalog entry.
 
         The created catalog entry is restricted by default. You must have an administrator
         or editor role in the scope of the provided token. This API will return an ETag
         that can be used for standard ETag processing, except when depth query is used.
 
+        :param str id: Catalog entry's unique ID. It's the same across all catalog
+               instances.
         :param str name: Programmatic name for this catalog entry, which must be
                formatted like a CRN segment. See the display name in OverviewUI for a
                user-readable name.
@@ -177,17 +179,12 @@ def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str,
                with a catalog entry.
         :param str parent_id: (optional) The ID of the parent catalog entry if it
                exists.
-        :param str parent_url: (optional) The catalog URL of the parent catalog
-               entry.
         :param bool group: (optional) Boolean value that determines whether the
                catalog entry is a group.
         :param ObjectMetaData metadata: (optional) Metadata is not returned by
                default, and includes specific data depending on the object **kind**.
         :param bool active: (optional) Boolean value that describes whether the
                service is active.
-        :param List[CatalogEntry] children: (optional) The children of this catalog
-               entry. This is read-only and ignored on put or post. It is filled in when
-               `?depth=_value_` is used.
         :param str account: (optional) This changes the scope of the request
                regardless of the authorization header. Example scopes are `account` and
                `global`. `account=global` is reqired if operating with a service ID that
@@ -197,6 +194,8 @@ def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str,
         :rtype: DetailedResponse
         """
 
+        if id is None:
+            raise ValueError('id must be provided')
         if name is None:
             raise ValueError('name must be provided')
         if overview_ui is None:
@@ -216,8 +215,6 @@ def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str,
         provider = convert_model(provider)
         if metadata is not None:
             metadata = convert_model(metadata)
-        if children is not None:
-            children = [ convert_model(x) for x in children ]
         headers = {}
         sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME, service_version='V1', operation_id='create_catalog_entry')
         headers.update(sdk_headers)
@@ -227,6 +224,7 @@ def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str,
         }
 
         data = {
+            'id': id,
             'name': name,
             'overview_ui': overview_ui,
             'kind': kind,
@@ -235,11 +233,9 @@ def create_catalog_entry(self, name: str, overview_ui: 'OverviewUI', kind: str,
             'tags': tags,
             'provider': provider,
             'parent_id': parent_id,
-            'parent_url': parent_url,
             'group': group,
             'metadata': metadata,
-            'active': active,
-            'children': children
+            'active': active
         }
         data = {k: v for (k, v) in data.items() if v is not None}
         data = json.dumps(data)
@@ -441,11 +437,11 @@ def update_catalog_entry(self, id: str, name: str, overview_ui: 'OverviewUI', ki
         return response
 
 
-    def archive_catalog_entry(self, id: str, *, account: str = None, **kwargs) -> DetailedResponse:
+    def delete_catalog_entry(self, id: str, *, account: str = None, **kwargs) -> DetailedResponse:
         """
-        Archive a catalog entry.
+        Delete a catalog entry.
 
-        Archive a catalog entry. This will archive the catalog entry for a minimum of two
+        Delete a catalog entry. This will archive the catalog entry for a minimum of two
         weeks. While archived, it can be restored using the PUT restore API. After two
         weeks, it will be deleted and cannot be restored. You must have administrator role
         in the scope of the provided token to modify it. This endpoint is ETag enabled.
@@ -463,7 +459,7 @@ def archive_catalog_entry(self, id: str, *, account: str = None, **kwargs) -> De
         if id is None:
             raise ValueError('id must be provided')
         headers = {}
-        sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME, service_version='V1', operation_id='archive_catalog_entry')
+        sdk_headers = get_sdk_headers(service_name=self.DEFAULT_SERVICE_NAME, service_version='V1', operation_id='delete_catalog_entry')
         headers.update(sdk_headers)
 
         params = {
@@ -1394,8 +1390,8 @@ class CatalogEntry():
     """
     An entry in the global catalog.
 
-    :attr str id: (optional) Catalog entry's unique ID. It's the same across all
-          catalog instances.
+    :attr str id: Catalog entry's unique ID. It's the same across all catalog
+          instances.
     :attr str catalog_crn: (optional) The cloud resource name of the catalog entry.
     :attr str url: (optional) The catalog URL for the catalog entry.
     :attr str name: Programmatic name for this catalog entry, which must be
@@ -1433,10 +1429,12 @@ class CatalogEntry():
           `?depth=_value_` is used.
     """
 
-    def __init__(self, name: str, overview_ui: 'OverviewUI', kind: str, images: 'Image', disabled: bool, tags: List[str], provider: 'Provider', *, id: str = None, catalog_crn: str = None, url: str = None, parent_id: str = None, children_url: str = None, parent_url: str = None, geo_tags: List[str] = None, pricing_tags: List[str] = None, group: bool = None, created: datetime = None, updated: datetime = None, metadata: 'ObjectMetaData' = None, active: bool = None, children: List['CatalogEntry'] = None) -> None:
+    def __init__(self, id: str, name: str, overview_ui: 'OverviewUI', kind: str, images: 'Image', disabled: bool, tags: List[str], provider: 'Provider', *, catalog_crn: str = None, url: str = None, parent_id: str = None, children_url: str = None, parent_url: str = None, geo_tags: List[str] = None, pricing_tags: List[str] = None, group: bool = None, created: datetime = None, updated: datetime = None, metadata: 'ObjectMetaData' = None, active: bool = None, children: List['CatalogEntry'] = None) -> None:
         """
         Initialize a CatalogEntry object.
 
+        :param str id: Catalog entry's unique ID. It's the same across all catalog
+               instances.
         :param str name: Programmatic name for this catalog entry, which must be
                formatted like a CRN segment. See the display name in OverviewUI for a
                user-readable name.
@@ -1495,6 +1493,8 @@ def from_dict(cls, _dict: Dict) -> 'CatalogEntry':
         args = {}
         if 'id' in _dict:
             args['id'] = _dict.get('id')
+        else:
+            raise ValueError('Required property \'id\' not present in CatalogEntry JSON')
         if 'catalog_crn' in _dict:
             args['catalog_crn'] = _dict.get('catalog_crn')
         if 'url' in _dict:

test/unit/test_global_catalog_v1.py

@@ -363,22 +363,8 @@ def test_create_catalog_entry_all_params(self):
         object_meta_data_model['original_name'] = 'testString'
         object_meta_data_model['other'] = { 'foo': 'bar' }
 
-        # Construct a dict representation of a CatalogEntry model
-        catalog_entry_model = {}
-        catalog_entry_model['name'] = 'testString'
-        catalog_entry_model['overview_ui'] = overview_ui_model
-        catalog_entry_model['kind'] = 'testString'
-        catalog_entry_model['images'] = image_model
-        catalog_entry_model['parent_id'] = 'testString'
-        catalog_entry_model['parent_url'] = 'testString'
-        catalog_entry_model['disabled'] = True
-        catalog_entry_model['tags'] = ['testString']
-        catalog_entry_model['group'] = True
-        catalog_entry_model['provider'] = provider_model
-        catalog_entry_model['metadata'] = object_meta_data_model
-        catalog_entry_model['active'] = True
-
         # Set up parameter values
+        id = 'testString'
         name = 'testString'
         overview_ui = overview_ui_model
         kind = 'testString'
@@ -387,15 +373,14 @@ def test_create_catalog_entry_all_params(self):
         tags = ['testString']
         provider = provider_model
         parent_id = 'testString'
-        parent_url = 'testString'
         group = True
         metadata = object_meta_data_model
         active = True
-        children = [catalog_entry_model]
         account = 'testString'
 
         # Invoke method
         response = service.create_catalog_entry(
+            id,
             name,
             overview_ui,
             kind,
@@ -404,11 +389,9 @@ def test_create_catalog_entry_all_params(self):
             tags,
             provider,
             parent_id=parent_id,
-            parent_url=parent_url,
             group=group,
             metadata=metadata,
             active=active,
-            children=children,
             account=account,
             headers={}
         )
@@ -422,6 +405,7 @@ def test_create_catalog_entry_all_params(self):
         assert 'account={}'.format(account) in query_string
         # Validate body params
         req_body = json.loads(str(responses.calls[0].request.body, 'utf-8'))
+        assert req_body['id'] == 'testString'
         assert req_body['name'] == 'testString'
         assert req_body['overview_ui'] == overview_ui_model
         assert req_body['kind'] == 'testString'
@@ -430,11 +414,9 @@ def test_create_catalog_entry_all_params(self):
         assert req_body['tags'] == ['testString']
         assert req_body['provider'] == provider_model
         assert req_body['parent_id'] == 'testString'
-        assert req_body['parent_url'] == 'testString'
         assert req_body['group'] == True
         assert req_body['metadata'] == object_meta_data_model
         assert req_body['active'] == True
-        assert req_body['children'] == [catalog_entry_model]
 
 
     #--------------------------------------------------------
@@ -682,22 +664,8 @@ def test_create_catalog_entry_required_params(self):
         object_meta_data_model['original_name'] = 'testString'
         object_meta_data_model['other'] = { 'foo': 'bar' }
 
-        # Construct a dict representation of a CatalogEntry model
-        catalog_entry_model = {}
-        catalog_entry_model['name'] = 'testString'
-        catalog_entry_model['overview_ui'] = overview_ui_model
-        catalog_entry_model['kind'] = 'testString'
-        catalog_entry_model['images'] = image_model
-        catalog_entry_model['parent_id'] = 'testString'
-        catalog_entry_model['parent_url'] = 'testString'
-        catalog_entry_model['disabled'] = True
-        catalog_entry_model['tags'] = ['testString']
-        catalog_entry_model['group'] = True
-        catalog_entry_model['provider'] = provider_model
-        catalog_entry_model['metadata'] = object_meta_data_model
-        catalog_entry_model['active'] = True
-
         # Set up parameter values
+        id = 'testString'
         name = 'testString'
         overview_ui = overview_ui_model
         kind = 'testString'
@@ -706,14 +674,13 @@ def test_create_catalog_entry_required_params(self):
         tags = ['testString']
         provider = provider_model
         parent_id = 'testString'
-        parent_url = 'testString'
         group = True
         metadata = object_meta_data_model
         active = True
-        children = [catalog_entry_model]
 
         # Invoke method
         response = service.create_catalog_entry(
+            id,
             name,
             overview_ui,
             kind,
@@ -722,11 +689,9 @@ def test_create_catalog_entry_required_params(self):
             tags,
             provider,
             parent_id=parent_id,
-            parent_url=parent_url,
             group=group,
             metadata=metadata,
             active=active,
-            children=children,
             headers={}
         )
 
@@ -735,6 +700,7 @@ def test_create_catalog_entry_required_params(self):
         assert response.status_code == 201
         # Validate body params
         req_body = json.loads(str(responses.calls[0].request.body, 'utf-8'))
+        assert req_body['id'] == 'testString'
         assert req_body['name'] == 'testString'
         assert req_body['overview_ui'] == overview_ui_model
         assert req_body['kind'] == 'testString'
@@ -743,11 +709,9 @@ def test_create_catalog_entry_required_params(self):
         assert req_body['tags'] == ['testString']
         assert req_body['provider'] == provider_model
         assert req_body['parent_id'] == 'testString'
-        assert req_body['parent_url'] == 'testString'
         assert req_body['group'] == True
         assert req_body['metadata'] == object_meta_data_model
         assert req_body['active'] == True
-        assert req_body['children'] == [catalog_entry_model]
 
 
     #--------------------------------------------------------
@@ -995,22 +959,8 @@ def test_create_catalog_entry_value_error(self):
         object_meta_data_model['original_name'] = 'testString'
         object_meta_data_model['other'] = { 'foo': 'bar' }
 
-        # Construct a dict representation of a CatalogEntry model
-        catalog_entry_model = {}
-        catalog_entry_model['name'] = 'testString'
-        catalog_entry_model['overview_ui'] = overview_ui_model
-        catalog_entry_model['kind'] = 'testString'
-        catalog_entry_model['images'] = image_model
-        catalog_entry_model['parent_id'] = 'testString'
-        catalog_entry_model['parent_url'] = 'testString'
-        catalog_entry_model['disabled'] = True
-        catalog_entry_model['tags'] = ['testString']
-        catalog_entry_model['group'] = True
-        catalog_entry_model['provider'] = provider_model
-        catalog_entry_model['metadata'] = object_meta_data_model
-        catalog_entry_model['active'] = True
-
         # Set up parameter values
+        id = 'testString'
         name = 'testString'
         overview_ui = overview_ui_model
         kind = 'testString'
@@ -1019,14 +969,13 @@ def test_create_catalog_entry_value_error(self):
         tags = ['testString']
         provider = provider_model
         parent_id = 'testString'
-        parent_url = 'testString'
         group = True
         metadata = object_meta_data_model
         active = True
-        children = [catalog_entry_model]
 
         # Pass in all but one required param and check for a ValueError
         req_param_dict = {
+            "id": id,
             "name": name,
             "overview_ui": overview_ui,
             "kind": kind,
@@ -2088,15 +2037,15 @@ def test_update_catalog_entry_value_error(self):
 
 
 #-----------------------------------------------------------------------------
-# Test Class for archive_catalog_entry
+# Test Class for delete_catalog_entry
 #-----------------------------------------------------------------------------
-class TestArchiveCatalogEntry():
+class TestDeleteCatalogEntry():
 
     #--------------------------------------------------------
-    # archive_catalog_entry()
+    # delete_catalog_entry()
     #--------------------------------------------------------
     @responses.activate
-    def test_archive_catalog_entry_all_params(self):
+    def test_delete_catalog_entry_all_params(self):
         # Set up mock
         url = base_url + '/testString'
         responses.add(responses.DELETE,
@@ -2108,7 +2057,7 @@ def test_archive_catalog_entry_all_params(self):
         account = 'testString'
 
         # Invoke method
-        response = service.archive_catalog_entry(
+        response = service.delete_catalog_entry(
             id,
             account=account,
             headers={}
@@ -2124,10 +2073,10 @@ def test_archive_catalog_entry_all_params(self):
 
 
     #--------------------------------------------------------
-    # test_archive_catalog_entry_required_params()
+    # test_delete_catalog_entry_required_params()
     #--------------------------------------------------------
     @responses.activate
-    def test_archive_catalog_entry_required_params(self):
+    def test_delete_catalog_entry_required_params(self):
         # Set up mock
         url = base_url + '/testString'
         responses.add(responses.DELETE,
@@ -2138,7 +2087,7 @@ def test_archive_catalog_entry_required_params(self):
         id = 'testString'
 
         # Invoke method
-        response = service.archive_catalog_entry(
+        response = service.delete_catalog_entry(
             id,
             headers={}
         )
@@ -2149,10 +2098,10 @@ def test_archive_catalog_entry_required_params(self):
 
 
     #--------------------------------------------------------
-    # test_archive_catalog_entry_value_error()
+    # test_delete_catalog_entry_value_error()
     #--------------------------------------------------------
     @responses.activate
-    def test_archive_catalog_entry_value_error(self):
+    def test_delete_catalog_entry_value_error(self):
         # Set up mock
         url = base_url + '/testString'
         responses.add(responses.DELETE,
@@ -2169,7 +2118,7 @@ def test_archive_catalog_entry_value_error(self):
         for param in req_param_dict.keys():
             req_copy = {key:val if key is not param else None for (key,val) in req_param_dict.items()}
             with pytest.raises(ValueError):
-                service.archive_catalog_entry(**req_copy)
+                service.delete_catalog_entry(**req_copy)