Skip to content

metadata

Metadata specific shared across all horde APIs.

These classes can be inherited and new values added to them to support new APIs' metadata. See the horde_sdk.generic_api.generic_clients module for more information.

GenericHeaderFields

Bases: StrEnum

StrEnum for data that may be passed in the header of a request.

Maps the python object's field name which matches to a comparable header. This implies that fields with these names are always passed in the header of a request.

Pass this in to a GenericClient initializer if implementing a new API. See an existing API's metadata.py module.

Source code in horde_sdk/generic_api/metadata.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class GenericHeaderFields(StrEnum):
    """`StrEnum` for data that may be passed in the header of a request.

    Maps the python object's field name which matches to a comparable header. This implies that fields with these
    names are *always* passed in the header of a request.

    Pass this in to a GenericClient initializer if implementing a new API. See an existing API's `metadata.py` module.
    """

    apikey = auto()
    accept = auto()
    # X_Fields = "X-Fields" # TODO?
    client_agent = auto()

apikey class-attribute instance-attribute 

apikey = auto()

accept class-attribute instance-attribute 

accept = auto()

client_agent class-attribute instance-attribute 

client_agent = auto()

GenericAcceptTypes

Bases: StrEnum

StrEnum for supported values for the header parameter 'accept'.

Pass this in to a GenericClient initializer if implementing a new API. See an existing API's metadata.py module.

Source code in horde_sdk/generic_api/metadata.py 
30
31
32
33
34
35
36
class GenericAcceptTypes(StrEnum):
    """`StrEnum` for supported values for the header parameter 'accept'.

    Pass this in to a GenericClient initializer if implementing a new API. See an existing API's `metadata.py` module.
    """

    json = "application/json"

json class-attribute instance-attribute 

json = 'application/json'

GenericPathFields

Bases: StrEnum

StrEnum for data that may be passed as part of a URL path (before the query string).

Used to replace path parameters like /api/v1/{path_field} with the value of the field. This implies that fields with these names are always passed in the path of a request.

Pass this in to a GenericClient initializer if implementing a new API. See an existing API's metadata.py module.

Source code in horde_sdk/generic_api/metadata.py 
40
41
42
43
44
45
46
47
class GenericPathFields(StrEnum):
    """`StrEnum` for data that may be passed as part of a URL path (before the query string).

    Used to replace path parameters like `/api/v1/{path_field}` with the value of the field. This implies that fields
    with these names are *always* passed in the path of a request.

    Pass this in to a GenericClient initializer if implementing a new API. See an existing API's `metadata.py` module.
    """

GenericQueryFields

Bases: StrEnum

StrEnum for data that may be passed as part of a URL query (after the ?).

Used to replace query parameters like /api/v1/resource?query_field=value with the value of the field. This implies that fields with these names are always passed in the query of a request.

Pass this in to a GenericClient initializer if implementing a new API. See an existing API's metadata.py module.

Source code in horde_sdk/generic_api/metadata.py 
50
51
52
53
54
55
56
57
class GenericQueryFields(StrEnum):
    """`StrEnum` for data that may be passed as part of a URL query (after the `?`).

    Used to replace query parameters like `/api/v1/resource?query_field=value` with the value of the field.
    This implies that fields with these names are *always* passed in the query of a request.

    Pass this in to a GenericClient initializer if implementing a new API. See an existing API's `metadata.py` module.
    """