From cfed3f12c269a3ae261eab12c6d7a7ff454a7977 Mon Sep 17 00:00:00 2001 From: Art Hall Date: Thu, 27 Sep 2018 19:29:38 -0400 Subject: [PATCH] Add Key Management service docs The Key Management service docs were missed in the 2.0.4 release. This commit add the docs for ReadtheDocs as stop-gab until the next release. --- README.rst | 4 ++++ docs/api/index.rst | 25 ++++++++++++++++++++++++ docs/api/key_management.rst | 38 +++++++++++++++++++++++++++++++++++++ docs/api/landing.rst | 2 ++ 4 files changed, 69 insertions(+) create mode 100644 docs/api/key_management.rst diff --git a/README.rst b/README.rst index eede868e6b..686c3279d1 100644 --- a/README.rst +++ b/README.rst @@ -85,6 +85,10 @@ A downloadable version of the documentation is include with in the release zip, __ https://github.com/oracle/oci-python-sdk/releases +The downloadable version of the documentation does not contain the Key Management service API documentation. This will be fixed with the next release. For the Key Management service API, please refer to the online API documentation `here`__. + +__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/index.html + ==== Help ==== diff --git a/docs/api/index.rst b/docs/api/index.rst index 1d429b67ac..b132b0c714 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -234,6 +234,31 @@ Identity :noindex: +============== +Key Management +============== + +-------- + Client +-------- + +.. autoclass:: oci.key_management.key_management_client.KeyManagementClient + :members: + :noindex: + +-------- + Models +-------- + +.. automodule:: oci.key_management.models + :special-members: __init__ + :members: + :undoc-members: + :imported-members: + :inherited-members: + :noindex: + + ============= Load Balancer ============= diff --git a/docs/api/key_management.rst b/docs/api/key_management.rst new file mode 100644 index 0000000000..4a3712cbfc --- /dev/null +++ b/docs/api/key_management.rst @@ -0,0 +1,38 @@ +Key Management +============== + +.. autosummary:: + :toctree: key_management/client + :nosignatures: + :template: autosummary/service_client.rst + + oci.key_management.KeyManagementClient + oci.key_management.KeyManagementClientCompositeOperations + +-------- + Models +-------- + +.. autosummary:: + :toctree: key_management/models + :nosignatures: + :template: autosummary/model_class.rst + + oci.key_management.models.CreateKeyDetails + oci.key_management.models.CreateVaultDetails + oci.key_management.models.DecryptDataDetails + oci.key_management.models.DecryptedData + oci.key_management.models.EncryptDataDetails + oci.key_management.models.EncryptedData + oci.key_management.models.GenerateKeyDetails + oci.key_management.models.GeneratedKey + oci.key_management.models.Key + oci.key_management.models.KeyShape + oci.key_management.models.KeySummary + oci.key_management.models.KeyVersion + oci.key_management.models.KeyVersionSummary + oci.key_management.models.ScheduleVaultDeletionDetails + oci.key_management.models.UpdateKeyDetails + oci.key_management.models.UpdateVaultDetails + oci.key_management.models.Vault + oci.key_management.models.VaultSummary diff --git a/docs/api/landing.rst b/docs/api/landing.rst index 7aa17bd6c1..2879a58c94 100644 --- a/docs/api/landing.rst +++ b/docs/api/landing.rst @@ -13,6 +13,7 @@ API Reference * :doc:`Email ` * :doc:`File Storage ` * :doc:`Identity ` +* :doc:`Key Management ` * :doc:`Load Balancer ` * :doc:`Object Storage ` * :doc:`Resource Search ` @@ -45,6 +46,7 @@ API Reference email file_storage identity + key_management load_balancer object_storage resource_search