cdh.rest package

This module contains an abstraction layer for REST API calls.

It defines the ::class:Resource and ::class:Collection classes, as well as several resources fields in ::mod:fields.

A collection is a list of resources. Collections can only be retrieved at the moment.

A resources is a single entity, which contains fields. A resources can be retrieved on it’s own, or through a collection.

Through the means of fields, both Resources and Collections can be parts of Resources. A collection can only hold a certain resources.

In a less abstract way: a resources is a JSON object, a collection is a JSON list and fields are JSON fields.

For implementation details, see the :class:Resource and :class:Collection classes.

Subpackages

• cdh.rest.client package
  • Subpackages
    • cdh.rest.client.clients package
      • Submodules
    • cdh.rest.client.collections package
      • Submodules
    • cdh.rest.client.resources package
      • Submodules
  • Submodules
    • cdh.rest.client.fields module
    • cdh.rest.client.logging module
    • cdh.rest.client.operations module
    • cdh.rest.client.registry module
• cdh.rest.server package
  • Submodules
    • cdh.rest.server.authenticators module
    • cdh.rest.server.permissions module
    • cdh.rest.server.serializers module
    • cdh.rest.server.settings module
    • cdh.rest.server.token module
    • cdh.rest.server.token_algorithms module

Submodules

• cdh.rest.apps module
• cdh.rest.exceptions module
• cdh.rest.logging module
• cdh.rest.mixins module