Skip to content

Api version

API version handler module for odin-control.

This module implements the API version handler. It allows clients to query the supported API version through HTTP GET requests, returning the version information as JSON.

Tim Nicholls, STFC Detector Systems Software Group.

ApiVersionHandler

Bases: CorsRequestHandler

API version handler to allow client to resolve supported version.

This request handler implements the GET verb to allow a call to the appropriate URI to return the supported API version as JSON.

Source code in src/odin_control/http/handlers/api_version.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
class ApiVersionHandler(CorsRequestHandler):
    """API version handler to allow client to resolve supported version.

    This request handler implements the GET verb to allow a call to the appropriate URI to return
    the supported API version as JSON.
    """

    def get(self):
        """Handle API version GET requests."""
        accept_types = self.request.headers.get('Accept', 'application/json').split(',')
        if "*/*" not in accept_types and 'application/json' not in accept_types:
            self.set_status(406)
            self.write('Requested content types not supported')
            return

        self.write(json.dumps({'version': self.route.api_version}))

get()

Handle API version GET requests.

Source code in src/odin_control/http/handlers/api_version.py 
20
21
22
23
24
25
26
27
28
def get(self):
    """Handle API version GET requests."""
    accept_types = self.request.headers.get('Accept', 'application/json').split(',')
    if "*/*" not in accept_types and 'application/json' not in accept_types:
        self.set_status(406)
        self.write('Requested content types not supported')
        return

    self.write(json.dumps({'version': self.route.api_version}))