Skip to content

Commit cfed3f1

Browse files
author
Art Hall
committed
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.
1 parent 3128755 commit cfed3f1

File tree

4 files changed

+69
-0
lines changed

4 files changed

+69
-0
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,10 @@ A downloadable version of the documentation is include with in the release zip,
8585

8686
__ https://github.com/oracle/oci-python-sdk/releases
8787

88+
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`__.
89+
90+
__ https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/index.html
91+
8892
====
8993
Help
9094
====

docs/api/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,31 @@ Identity
234234
:noindex:
235235

236236

237+
==============
238+
Key Management
239+
==============
240+
241+
--------
242+
Client
243+
--------
244+
245+
.. autoclass:: oci.key_management.key_management_client.KeyManagementClient
246+
:members:
247+
:noindex:
248+
249+
--------
250+
Models
251+
--------
252+
253+
.. automodule:: oci.key_management.models
254+
:special-members: __init__
255+
:members:
256+
:undoc-members:
257+
:imported-members:
258+
:inherited-members:
259+
:noindex:
260+
261+
237262
=============
238263
Load Balancer
239264
=============

docs/api/key_management.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Key Management
2+
==============
3+
4+
.. autosummary::
5+
:toctree: key_management/client
6+
:nosignatures:
7+
:template: autosummary/service_client.rst
8+
9+
oci.key_management.KeyManagementClient
10+
oci.key_management.KeyManagementClientCompositeOperations
11+
12+
--------
13+
Models
14+
--------
15+
16+
.. autosummary::
17+
:toctree: key_management/models
18+
:nosignatures:
19+
:template: autosummary/model_class.rst
20+
21+
oci.key_management.models.CreateKeyDetails
22+
oci.key_management.models.CreateVaultDetails
23+
oci.key_management.models.DecryptDataDetails
24+
oci.key_management.models.DecryptedData
25+
oci.key_management.models.EncryptDataDetails
26+
oci.key_management.models.EncryptedData
27+
oci.key_management.models.GenerateKeyDetails
28+
oci.key_management.models.GeneratedKey
29+
oci.key_management.models.Key
30+
oci.key_management.models.KeyShape
31+
oci.key_management.models.KeySummary
32+
oci.key_management.models.KeyVersion
33+
oci.key_management.models.KeyVersionSummary
34+
oci.key_management.models.ScheduleVaultDeletionDetails
35+
oci.key_management.models.UpdateKeyDetails
36+
oci.key_management.models.UpdateVaultDetails
37+
oci.key_management.models.Vault
38+
oci.key_management.models.VaultSummary

docs/api/landing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ API Reference
1313
* :doc:`Email <email>`
1414
* :doc:`File Storage <file_storage>`
1515
* :doc:`Identity <identity>`
16+
* :doc:`Key Management <key_management>`
1617
* :doc:`Load Balancer <load_balancer>`
1718
* :doc:`Object Storage <object_storage>`
1819
* :doc:`Resource Search <resource_search>`
@@ -45,6 +46,7 @@ API Reference
4546
email
4647
file_storage
4748
identity
49+
key_management
4850
load_balancer
4951
object_storage
5052
resource_search

0 commit comments

Comments
 (0)