API Requests

APIRequest

class hyperadmin.apirequests.APIRequest(site, path, url_args, url_kwargs, global_state=None)

An API Request

get_django_request()

META

media_types

get_response_type()

Returns the active response type to be used

Return type:string

get_request_type()

Returns the active request type to be used

Return type:string

get_request_media_type()

Returns the request media type to be used or raises an error

Raises ValueError:  when the requested content type is unrecognized Return type:string

get_response_media_type()

Returns the response media type to be used or raises an error

Raises ValueError:  when the requested content type is unrecognized Return type:string

get_endpoint(urlname)

Returns a bound endpoint matching the urlname

Parameters:urlname (string) – The urlname to find Raises KeyError:  when the urlname does not match any endpoints Return type:Endpoint

record_endpoint(endpoint)

Record the endpoint in our urlname cache

Parameters:resource – Endpoint

get_link_prototypes(endpoint)

Returns the link prototypes to be used by the endpint

Parameters:endpoint – endpoint object Return type:list of link prototypes

get_site()

Returns the bound site

Return type:SiteResource

generate_response(link, state)

Returns a response generated from the response media type

Parameters:

• link – The active link representing the endpoint’s response
• state – The endpoint’s state

Return type:

[Http]Response

generate_options_response(links, state)

Returns an OPTIONS response generated from the response media type

Parameters:

• links – dictionary mapping available HTTP methods to a link
• state – The endpoint’s state

Return type:

[Http]Response

reverse(name, *args, **kwargs)

HTTPAPIRequest

class hyperadmin.apirequests.HTTPAPIRequest(request, **kwargs)

Bases: hyperadmin.apirequests.APIRequest

Represents an API Request spawned from a Django HTTP Request

get_to_meta_map = {'_CONTENT_TYPE': 'CONTENT_TYPE', '_HTTP_ACCEPT': 'HTTP_ACCEPT'}

payload

method

get_django_request()

get_full_path()

user

params

get_session_data_from_request(request)

populate_session_data_from_request(request)

patched_meta(request)

get_passthrough_params(request)

NamespaceAPIRequest

class hyperadmin.apirequests.NamespaceAPIRequest(api_request, **kwargs)

Bases: hyperadmin.apirequests.InternalAPIRequest

user

get_django_request()

Namespace

class hyperadmin.apirequests.Namespace(name, endpoint, state_data={})

Bases: object

Represents alternative data associated with the current api request

Namespaced data is provided by another resource through an internal api request

get_namespaces()

get_prompt()

link

state