Merge branch 'main' of https://github.com/IBM/secrets-manager-python-sdk into prerelease

# Conflicts:
#	examples/test_secrets_manager_v2_examples.py
#	ibm_secrets_manager_sdk/secrets_manager_v2.py
#	test/integration/test_secrets_manager_v2.py
#	test/unit/test_secrets_manager_v2.py

Author: TatyanaBol

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.26
+current_version = 2.1.0
 commit = True
 message = Update version {current_version} -> {new_version}
 

.github/workflows/create-release.yml

@@ -18,7 +18,7 @@ jobs:
       - name: setup nodejs
         uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
 
       - name: release using semantic-release
         env:
@@ -29,10 +29,11 @@ jobs:
           GIT_COMMITTER_EMAIL: secrets.automation.dev@il.ibm.com
         run: |
           sudo apt-get update
-          sudo apt-get install python
+          sudo apt-get install python3
           pip install --user bumpversion
           npm install @semantic-release/changelog
           npm install @semantic-release/exec
           npm install @semantic-release/git
           npm install @semantic-release/github
+          npm install @semantic-release/release-notes-generator -D
           npx semantic-release

.github/workflows/publish.yaml

@@ -28,6 +28,6 @@ jobs:
           --outdir dist/
           .
       - name: Publish distribution to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@v1.8.4
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.releaserc

@@ -5,7 +5,10 @@
     ["@semantic-release/commit-analyzer", {
         "preset": "angular",
         "releaseRules": [
-            {"type": "release","release": "patch"}
+            {"type": "release","release": "patch"},
+            {"type": "major","release": "major"},
+            {"type": "minor","release": "minor"},
+            {"type": "patch","release": "patch"}
     ]}],
     "@semantic-release/release-notes-generator",
     "@semantic-release/changelog",

CHANGELOG.md

@@ -1,18 +1,19 @@
-## [1.0.26](https://github.com/IBM/secrets-manager-python-sdk/compare/v1.0.25...v1.0.26) (2022-12-05)
+# [2.1.0](https://github.com/IBM/secrets-manager-python-sdk/compare/v2.0.0...v2.1.0) (2023-09-19)
 
-## [1.0.25](https://github.com/IBM/secrets-manager-python-sdk/compare/v1.0.24...v1.0.25) (2022-11-30)
+# [2.0.0](https://github.com/IBM/secrets-manager-python-sdk/compare/v1.0.26...v2.0.0) (2023-04-17)
 
-## [1.0.24](https://github.com/IBM/secrets-manager-python-sdk/compare/v1.0.23...v1.0.24) (2022-11-30)
 
-## [1.0.23](https://github.com/IBM/secrets-manager-python-sdk/compare/v1.0.22...v1.0.23) (2022-11-29)
+### Features
 
+* new SM v2 API release ([d44e987](https://github.com/IBM/secrets-manager-python-sdk/commit/d44e98718143fc6d8c5f27cd1d148586f94ba029))
+* new SM v2 API release ([1b553dd](https://github.com/IBM/secrets-manager-python-sdk/commit/1b553dd266287962de302de3558ceb072cd1137f))
 
-### Bug Fixes
 
-* new workflow ([2e7f2af](https://github.com/IBM/secrets-manager-python-sdk/commit/2e7f2af1a31f44e04408dd25f6a91421659155ae))
-* new workflow ([6375f21](https://github.com/IBM/secrets-manager-python-sdk/commit/6375f2187a1894cd535a3a461e45888b75a501a3))
-* revert to admin token ([790c6f5](https://github.com/IBM/secrets-manager-python-sdk/commit/790c6f5ed0b6a32087fb7e1c13fc030ffc5cd48f))
-* test adding token ([cc3f2bc](https://github.com/IBM/secrets-manager-python-sdk/commit/cc3f2bc58b325b5c4196ad52073a4df89ac20360))
-* test new token permissions ([5ea4eb3](https://github.com/IBM/secrets-manager-python-sdk/commit/5ea4eb39c57233cd9b936e52fba8b679136fdb3b))
-* test new token permissions ([68c8faa](https://github.com/IBM/secrets-manager-python-sdk/commit/68c8faaf360b003c2ce4113de3cdac99c46c8f96))
-* testing workflow ([21f1176](https://github.com/IBM/secrets-manager-python-sdk/commit/21f117679ca4692aa65a268e39c3db7c5cd151e6))
+### BREAKING CHANGES
+
+* new v2 API.
+
+Signed-off-by: yuval-shlomo-dekel <yuval.shlomo.dekel@ibm.com>
+* new v2 API.
+
+Signed-off-by: yuval-shlomo-dekel <yuval.shlomo.dekel@ibm.com>

README.md

@@ -1,7 +1,6 @@
 # IBM Cloud Secrets Manager Python SDK
 
-A Python client library to interact with
-the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager).
+A Python client library to interact with the [IBM Cloud® Secrets Manager APIs](https://cloud.ibm.com/apidocs/secrets-manager).
 
 <details>
 <summary>Table of Contents</summary>
@@ -25,7 +24,7 @@ services:
 
 | Service name                                                     | Imported class name  |
 |------------------------------------------------------------------|----------------------|
-| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV1     |
+| [Secrets Manager](https://cloud.ibm.com/apidocs/secrets-manager) | SecretsManagerV2     |
 
 ## Prerequisites
 
@@ -67,7 +66,7 @@ authenticators from `ibm_cloud_sdk_core.authenticators`.
 ```python
 from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
 
-secretsManager = SecretsManagerV1(
+secretsManager = SecretsManagerV2(
     authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
 )
 ```
@@ -90,31 +89,39 @@ Here's an example `secrets_manager.py` file:
 
 ```python
 from ibm_cloud_sdk_core.authenticators.iam_authenticator import IAMAuthenticator
-from ibm_secrets_manager_sdk.secrets_manager_v1 import *
+from ibm_secrets_manager_sdk.secrets_manager_v2 import *
 
-secretsManager = SecretsManagerV1(
+secretsManager = SecretsManagerV2(
     authenticator=IAMAuthenticator(apikey='<IBM_CLOUD_API_KEY>')
 )
 
 secretsManager.set_service_url('<SERVICE_URL>')
 
 # create arbitrary secret
+secret_prototype_model = {
+    'custom_metadata': {'metadata_custom_key':'metadata_custom_value'},
+    'description': 'Description of my arbitrary secret.',
+    'expiration_date': '2030-10-05T11:49:42Z',
+    'labels': ['dev', 'us-south'],
+    'name': 'example-arbitrary-secret',
+    'secret_group_id': 'default',
+    'secret_type': 'arbitrary',
+    'payload': 'secret-data',
+    'version_custom_metadata': {'custom_version_key':'custom_version_value'},
+}
+
 response = secretsManager.create_secret(
-    'arbitrary',
-    {'collection_type': 'application/vnd.ibm.secrets-manager.secret+json', 'collection_total': 1},
-    [{'name': 'example-arbitrary-secret', 'description': 'Extended description for this secret.',
-      'payload': 'secret-data'}]
+  secret_prototype=secret_prototype_model,
 )
 
-secretId = response.result['resources'][0]['id']
+secretId = response.result['id']
 
 # get arbitrary secret
 response = secretsManager.get_secret(
-    'arbitrary',
-    secretId
+    id=secretId
 )
 
-secretPayload = response.result['resources'][0]['secret_data']['payload']
+secretPayload = response.result['payload']
 print('The arbitrary secret payload is: ' + secretPayload)
 
 ```
@@ -145,6 +152,4 @@ For general contribution guidelines, see [CONTRIBUTING](CONTRIBUTING.md).
 
 ## License
 
-This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE). 
-
-dummy_PR #1
+This SDK project is released under the Apache 2.0 license. The license's full text can be found in [LICENSE](LICENSE).

examples/test_secrets_manager_v2_examples.py

@@ -98,6 +98,7 @@ def test_create_secret_group_example(self):
         create_secret_group request example
         """
         try:
+            global secret_group_id_for_get_secret_group_link
             print('\ncreate_secret_group() result:')
             # begin-create_secret_group
 
@@ -110,7 +111,6 @@ def test_create_secret_group_example(self):
 
             # end-create_secret_group
 
-            global secret_group_id_for_get_secret_group_link
             secret_group_id_for_get_secret_group_link = secret_group['id']
         except ApiException as e:
             pytest.fail(str(e))
@@ -121,19 +121,21 @@ def test_create_secret_example(self):
         create_secret request example
         """
         try:
+            global secret_id_for_get_secret_link
+            global secret_id_for_get_secret_version_link
             print('\ncreate_secret() result:')
             # begin-create_secret
 
             secret_prototype_model = {
-                'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},
+                'custom_metadata': {'metadata_custom_key':'metadata_custom_value'},
                 'description': 'Description of my arbitrary secret.',
                 'expiration_date': '2030-10-05T11:49:42Z',
                 'labels': ['dev', 'us-south'],
                 'name': 'example-arbitrary-secret',
                 'secret_group_id': 'default',
                 'secret_type': 'arbitrary',
                 'payload': 'secret-data',
-                'version_custom_metadata': {'custom_version_key': 'custom_version_value'},
+                'version_custom_metadata': {'custom_version_key':'custom_version_value'},
             }
 
             response = secrets_manager_service.create_secret(
@@ -145,9 +147,7 @@ def test_create_secret_example(self):
 
             # end-create_secret
 
-            global secret_id_for_get_secret_link
             secret_id_for_get_secret_link = secret['id']
-            global secret_id_for_get_secret_version_link
             secret_id_for_get_secret_version_link = secret['id']
         except ApiException as e:
             pytest.fail(str(e))
@@ -158,14 +158,15 @@ def test_update_secret_metadata_example(self):
         update_secret_metadata request example
         """
         try:
+            global secret_name_link
             print('\nupdate_secret_metadata() result:')
             # begin-update_secret_metadata
 
             secret_metadata_patch_model = {
                 'name': 'updated-arbitrary-secret-name-example',
                 'description': 'updated Arbitrary Secret description',
                 'labels': ['dev', 'us-south'],
-                'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},
+                'custom_metadata': {'metadata_custom_key':'metadata_custom_value'},
             }
 
             response = secrets_manager_service.update_secret_metadata(
@@ -178,7 +179,6 @@ def test_update_secret_metadata_example(self):
 
             # end-update_secret_metadata
 
-            global secret_name_link
             secret_name_link = secret_metadata['name']
         except ApiException as e:
             pytest.fail(str(e))
@@ -189,6 +189,13 @@ def test_list_secret_versions_example(self):
         list_secret_versions request example
         """
         try:
+            global secret_version_id_for_get_secret_version_link
+            global secret_id_for_create_secret_version_link
+            global secret_version_id_for_get_secret_version_metadata_link
+            global secret_version_id_for_update_secret_version_metadata_link
+            global secret_id_for_create_secret_version_locks_link
+            global secret_version_id_for_create_secret_version_locks_link
+            global secret_version_id_for_delete_secret_version_locks_link
             print('\nlist_secret_versions() result:')
             # begin-list_secret_versions
 
@@ -201,19 +208,12 @@ def test_list_secret_versions_example(self):
 
             # end-list_secret_versions
 
-            global secret_version_id_for_get_secret_version_link
             secret_version_id_for_get_secret_version_link = secret_version_metadata_collection['versions'][0]['id']
-            global secret_id_for_create_secret_version_link
             secret_id_for_create_secret_version_link = secret_version_metadata_collection['versions'][0]['secret_id']
-            global secret_version_id_for_get_secret_version_metadata_link
             secret_version_id_for_get_secret_version_metadata_link = secret_version_metadata_collection['versions'][0]['id']
-            global secret_version_id_for_update_secret_version_metadata_link
             secret_version_id_for_update_secret_version_metadata_link = secret_version_metadata_collection['versions'][0]['id']
-            global secret_id_for_create_secret_version_locks_link
             secret_id_for_create_secret_version_locks_link = secret_version_metadata_collection['versions'][0]['secret_id']
-            global secret_version_id_for_create_secret_version_locks_link
             secret_version_id_for_create_secret_version_locks_link = secret_version_metadata_collection['versions'][0]['id']
-            global secret_version_id_for_delete_secret_version_locks_link
             secret_version_id_for_delete_secret_version_locks_link = secret_version_metadata_collection['versions'][0]['id']
         except ApiException as e:
             pytest.fail(str(e))
@@ -224,13 +224,16 @@ def test_create_secret_locks_bulk_example(self):
         create_secret_locks_bulk request example
         """
         try:
+            global secret_id_for_list_secret_locks_link
+            global secret_id_for_list_secret_version_locks_link
+            global secret_version_id_for_list_secret_version_locks_link
             print('\ncreate_secret_locks_bulk() result:')
             # begin-create_secret_locks_bulk
 
             secret_lock_prototype_model = {
                 'name': 'lock-example-1',
                 'description': 'lock for consumer 1',
-                'attributes': {'key': 'value'},
+                'attributes': {'key':'value'},
             }
 
             response = secrets_manager_service.create_secret_locks_bulk(
@@ -243,11 +246,8 @@ def test_create_secret_locks_bulk_example(self):
 
             # end-create_secret_locks_bulk
 
-            global secret_id_for_list_secret_locks_link
             secret_id_for_list_secret_locks_link = secret_locks['secret_id']
-            global secret_id_for_list_secret_version_locks_link
             secret_id_for_list_secret_version_locks_link = secret_locks['secret_id']
-            global secret_version_id_for_list_secret_version_locks_link
             secret_version_id_for_list_secret_version_locks_link = secret_locks['versions'][0]['version_id']
         except ApiException as e:
             pytest.fail(str(e))
@@ -258,6 +258,7 @@ def test_create_configuration_example(self):
         create_configuration request example
         """
         try:
+            global configuration_name_for_get_configuration_link
             print('\ncreate_configuration() result:')
             # begin-create_configuration
 
@@ -292,7 +293,6 @@ def test_create_configuration_example(self):
 
             # end-create_configuration
 
-            global configuration_name_for_get_configuration_link
             configuration_name_for_get_configuration_link = configuration['name']
         except ApiException as e:
             pytest.fail(str(e))
@@ -492,8 +492,8 @@ def test_create_secret_version_example(self):
 
             secret_version_prototype_model = {
                 'payload': 'updated secret credentials',
-                'custom_metadata': {'metadata_custom_key': 'metadata_custom_value'},
-                'version_custom_metadata': {'custom_version_key': 'custom_version_value'},
+                'custom_metadata': {'metadata_custom_key':'metadata_custom_value'},
+                'version_custom_metadata': {'custom_version_key':'custom_version_value'},
             }
 
             response = secrets_manager_service.create_secret_version(
@@ -673,7 +673,7 @@ def test_create_secret_version_locks_bulk_example(self):
             secret_lock_prototype_model = {
                 'name': 'lock-example-1',
                 'description': 'lock for consumer 1',
-                'attributes': {'key': 'value'},
+                'attributes': {'key':'value'},
             }
 
             response = secrets_manager_service.create_secret_version_locks_bulk(