openedx.core.djangoapps.zendesk_proxy.v0 package

Submodules

openedx.core.djangoapps.zendesk_proxy.v0.views module

Define request handlers used by the zendesk_proxy djangoapp

class openedx.core.djangoapps.zendesk_proxy.v0.views.ZendeskPassthroughView(**kwargs)

Bases: APIView

An APIView that will take in inputs from an unauthenticated endpoint, and use them to securely create a zendesk ticket.

parser_classes = (<class 'rest_framework.parsers.JSONParser'>,)

post(request)

request body is expected to look like this: {

“name”: “John Q. Student”, “email”: {

“from”: “JohnQStudent@realemailhost.com”, “message”: “I, John Q. Student, am having problems for the following reasons: …”, “subject”: “Help Request”

}, “tags”: [“zendesk_help_request”]

}

throttle_classes = (<class 'openedx.core.djangoapps.zendesk_proxy.v0.views.ZendeskProxyThrottle'>,)

class openedx.core.djangoapps.zendesk_proxy.v0.views.ZendeskProxyThrottle

Bases: SimpleRateThrottle

Custom throttle rates for this particular endpoint’s use case.

get_cache_key(request, view)

By providing a static string here, we are limiting all users to the same combined limit.

Module contents