Skip to content

Commit

Permalink
update references in docs (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
myuwono committed Feb 20, 2017
1 parent 7e4e39f commit 65a1595
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 42 deletions.
42 changes: 2 additions & 40 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,51 +12,13 @@
See the License for the specific language governing permissions and
limitations under the License.
API
API Client
====

The `covata.delta.api` module provides a set of tools for executing REST
calls to Delta API.

DeltaApiClient
--------------

The Delta API Client is an abstraction over the Delta API for execution of
requests and responses.

.. currentmodule:: covata.delta

.. autoclass:: DeltaApiClient
:members:

.. currentmodule:: covata.delta.api

Requests ApiClient
~~~~~~~~~~~~~~~~~~

An implementation of ``DeltaApiClient`` abstract base class using ``Requests``.

.. autoclass:: RequestsApiClient
:show-inheritance:
:members:

CVTSigner
---------

The Delta CVT Signer is a utility class for signing outbound requests using
the CVT1 signing scheme.

.. autoclass:: CVTSigner
:members:

RequestsCVTSigner
~~~~~~~~~~~~~~~~~

An authentication interceptor for ``Requests`` library.
This interceptor generates and inserts an Authorization header into the
request based on the CVT1 signing scheme. A date header will also be added
to the request.

.. autoclass:: RequestsCVTSigner
:show-inheritance:
.. autoclass:: ApiClient
:members:
4 changes: 2 additions & 2 deletions docs/crypto.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ DeltaKeyStore
The ``DeltaKeyStore`` provides the interface for a key-storage
backend of choice.

.. currentmodule:: covata.delta
.. currentmodule:: covata.delta.keystore

.. autoclass:: DeltaKeyStore
:members:
Expand All @@ -39,7 +39,7 @@ Implementation of the ``DeltaKeyStore`` abstract base class using the file
system. Private keys are saved in the file system as encrypted PEM formats
and are only decrypted in memory on read.

.. currentmodule:: covata.delta.crypto
.. currentmodule:: covata.delta.keystore

.. autoclass:: FileSystemKeyStore
:show-inheritance:
Expand Down

0 comments on commit 65a1595

Please sign in to comment.