Releasing version 2.54.0

Author: oci-dex-release-bot

CHANGELOG.rst

@@ -3,6 +3,27 @@ Change Log
 All notable changes to this project will be documented in this file.
 
 The format is based on `Keep a Changelog <http://keepachangelog.com/>`_.
+====================
+2.54.0 - 2022-01-11
+====================
+
+Added
+------
+* Support for calling Oracle Cloud Infrastructure services in the af-johannesburg-1 region
+* Support for multiple protocols on the same listener in the Network Load Balancing service
+* IPv6 support in the Network Load Balancing service
+* Support for creating Enterprise Manager-based Solaris and SunOS host targets in the Operations Insights service
+* Support for choosing Data Guard type (Active Data Guard or regular) on databases in the Database service
+* Support for allowing control characters in responses as requested in https://github.com/oracle/oci-python-sdk/issues/404. Please see the github issue for more details
+ 
+Fixed
+-----
+* The root cause of the issue causing data corruption as mentioned in https://github.com/oracle/oci-python-sdk/issues/410 has been fixed. Please see the github issue for more details
+ 
+Breaking
+--------
+* Support for retries enabled by default on all operations in the Java Management service
+
 ====================
 2.53.1 - 2021-12-21
 ====================

CONTRIBUTING.rst

@@ -5,7 +5,7 @@ Contributing to the Oracle Cloud Infrastructure Python SDK
 *This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.*
 
 Pull requests can be made under
-`The Oracle Contributor Agreement <https://www.oracle.com/technetwork/community/oca-486395.html>`_ (OCA).
+`The Oracle Contributor Agreement <https://oca.opensource.oracle.com>`_ (OCA).
 
 For pull requests to be accepted, the bottom of
 your commit message must have the following line using your name and

docs/sdk_behaviors/allow_control_chars_response.rst

@@ -0,0 +1,26 @@
+.. _sdk-allow_control_chars_response:
+
+Allow control characters in response
+~~~~~~~~
+The SDK helps deserialize any response object that is coming in from an API call. The deserialization uses the json library 
+to call json.loads(). By defaualt, the deserialization will not allow the response object to contain control characters in a string.
+If the user chooses to allow control characters in a response, the SDK provides 3 option of settings to allow this feature:
+* Request setting: Specify in the request to allow control characters
+* Client setting: Set a specific service client's base client to allow control character
+* Global setting: Set BaseClient to allow control characters on all response.
+
+The request setting will take the highest precedence, follow by the client setting, and finally global setting. 
+
+Example
+-------
+
+.. code-block:: python
+
+    # Allowing control characters at the request level.
+    response = identity_client.list_region_subscriptions.list_region_subscriptions(compartment_id, allow_control_chars=True)
+
+    # Allow control characters at the client level.
+    identity_client.base_client.allow_control_chars = True
+
+    # Allow control characters at the global level.
+    BaseClient.ALLOW_CONTROL_CHARACTERS = True

docs/sdk_behaviors/index.rst

@@ -12,6 +12,7 @@ This section describes SDK-specific behaviors:
 * :doc:`Signing bodies </sdk_behaviors/signing_bodies>`
 * :doc:`Enable Selective Service Imports </sdk_behaviors/enable_selective_service_imports>`
 * :doc:`Circuit Breakers </sdk_behaviors/circuit_breakers>`
+* :doc:`Allow control characters in response </sdk_behaviors/allow_control_chars_response>`
 
 .. toctree::
     :hidden:
@@ -24,4 +25,5 @@ This section describes SDK-specific behaviors:
     calculate_content_length
     signing_bodies
     enable_selective_service_imports
-    circuit_breakers
+    circuit_breakers
+    allow_control_chars_response

examples/Resource_Principle_v2.2_Functions_example/func.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
 # This example uses functions service to get the rpv2.2 token, for how to use functions, please refer fn Tutorials: https://fnproject.io/tutorials/

examples/add_API_key.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
 import oci

examples/add_soc_group_policy.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
 from os import path

examples/add_soc_user.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
 from os import path

examples/adw_example.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-# Copyright (c) 2016, 2021, Oracle and/or its affiliates.  All rights reserved.
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
 # This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 
 import oci

examples/allow_control_characters_example.py

@@ -0,0 +1,14 @@
+# coding: utf-8
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+import oci
+
+
+config = oci.config.from_file()
+compartment_id = config["tenancy"]
+identity = oci.identity.IdentityClient(config)
+
+# list users from the compartmentId, adding allow_control_chars=True
+# to the request will allow the response to contain control characters
+users = identity.list_users(compartment_id, allow_control_chars=True)