tracdap.rt.metadata.common
¶
Module Contents¶
Classes¶
Available formats for representing the TRAC metadata. |
|
Explicit versioning of the metadata schema. |
|
Information about a tenant that is set up on the TRAC platform. |
- class tracdap.rt.metadata.common.MetadataFormat¶
Bases:
enum.Enum
Available formats for representing the TRAC metadata.
Use for communication between components, config files metadata stored in the metadata database.
- JSON = [2]¶
- METADATA_FORMAT_NOT_SET = [0]¶
- PROTO = [1]¶
- YAML = [3]¶
- class tracdap.rt.metadata.common.MetadataVersion¶
Bases:
enum.Enum
Explicit versioning of the metadata schema.
A strictly increasing enumeration of metadata versions. The special value CURRENT is always set to the latest version and used by default, in API calls, config files and for storing in the metadata database.
TRAC can use this information identify and handle old metadata found in the metadata database. In future it may also be possible to request old metadata versions in API calls, or to run upgrades of metadata stored in an older metadata format.
- CURRENT = [1]¶
- METADATA_VERSION_NOT_SET = [0]¶
- V1 = [1]¶
- class tracdap.rt.metadata.common.TenantInfo¶
Information about a tenant that is set up on the TRAC platform.
- description¶
A short description of the tenant, suitable for displaying to users in lists.
- Type:
str
- tenantCode¶
Unique code used to identify the tenant, required by most API calls.
- Type:
str