The openstack_dashboard.api.rest.utils Module

exception openstack_dashboard.api.rest.utils.AjaxError(http_status, msg)

Bases: exceptions.Exception

class openstack_dashboard.api.rest.utils.CreatedResponse(location, data=None)

Bases: openstack_dashboard.api.rest.utils._RestResponse

class openstack_dashboard.api.rest.utils.JSONResponse(data, status=200, json_encoder=<class 'json.encoder.JSONEncoder'>)

Bases: openstack_dashboard.api.rest.utils._RestResponse

openstack_dashboard.api.rest.utils.ajax(authenticated=True, data_required=False, json_encoder=<class 'json.encoder.JSONEncoder'>)

Provide a decorator to wrap a view method so that it may exist in an entirely AJAX environment:

• data decoded from JSON as input and data coded as JSON as output
• result status is coded in the HTTP status code; any non-2xx response data will be coded as a JSON string, otherwise the response type (always JSON) is specific to the method called.

if authenticated is true then we’ll make sure the current user is authenticated.

If data_required is true then we’ll assert that there is a JSON body present.

The wrapped view method should return either:

• JSON serialisable data
• an object of the django http.HttpResponse subclass (one of JSONResponse or CreatedResponse is suggested)
• nothing

Methods returning nothing (or None explicitly) will result in a 204 “NO CONTENT” being returned to the caller.

openstack_dashboard.api.rest.utils.parse_filters_kwargs(request, client_keywords=None)

Extract REST filter parameters from the request GET args.

Client processes some keywords separately from filters and takes them as separate inputs. This will ignore those keys to avoid potential conflicts.