provenaclient.utils.registry_endpoints
Created Date: Thursday June 6th 2024 +1000 Author: Peter Baker —– Last Modified: Thursday June 6th 2024 1:39:55 pm +1000 Modified By: Peter Baker —– Description: Set of route maps for the Registry API used to help generate routes from subtype + Action combinations. —– HISTORY: Date By Comments ———- — ———————————————————
Attributes
Classes
str(object='') -> str |
Functions
|
Generates a fully formed registry URL given the below params |
Module Contents
- class provenaclient.utils.registry_endpoints.RegistryAction[source]
Bases:
str
,enum.Enum
str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str
Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.
- FETCH = 'FETCH'
- UPDATE = 'UPDATE'
- CREATE = 'CREATE'
- LIST = 'LIST'
- SEED = 'SEED'
- VERSION = 'VERSION'
- SCHEMA = 'SCHEMA'
- UI_SCHEMA = 'UI_SCHEMA'
- VALIDATE = 'VALIDATE'
- AUTH_EVALUATE = 'AUTH_EVALUATE'
- AUTH_CONFIGURATION = 'AUTH_CONFIGURATION'
- AUTH_ROLES = 'AUTH_ROLES'
- LOCK = 'LOCK'
- UNLOCK = 'UNLOCK'
- REVERT = 'REVERT'
- LOCK_HISTORY = 'LOCK_HISTORY'
- DELETE = 'DELETE'
- provenaclient.utils.registry_endpoints.action_postfixes: Dict[RegistryAction, str]
- provenaclient.utils.registry_endpoints.subtype_route_prefixes: Dict[ProvenaInterfaces.RegistryModels.ItemSubType, str]
- provenaclient.utils.registry_endpoints.subtype_action_to_endpoint(base: str, action: RegistryAction, item_subtype: ProvenaInterfaces.RegistryModels.ItemSubType) str [source]
Generates a fully formed registry URL given the below params
- Parameters:
base (str) – The URL base e.g. https://registry.provena.com
action (RegistryAction) – The action to be taken, see enum
item_subtype (ItemSubType) – The subtype to get the route for
- Returns:
The fully formed URL
- Return type:
str