Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

# -*- encoding: utf-8 -*- 

# 

# Copyright © 2012 New Dream Network, LLC (DreamHost) 

# 

# Licensed under the Apache License, Version 2.0 (the "License"); you may 

# not use this file except in compliance with the License. You may obtain 

# a copy of the License at 

# 

#      http://www.apache.org/licenses/LICENSE-2.0 

# 

# Unless required by applicable law or agreed to in writing, software 

# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 

# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 

# License for the specific language governing permissions and limitations 

# under the License. 

 

import pecan 

from pecan import rest 

from wsme import types as wtypes 

import wsmeext.pecan as wsme_pecan 

 

from magnum.api.controllers import base 

from magnum.api.controllers import link 

from magnum.api.controllers import v1 

 

 

class Version(base.APIBase): 

    """An API version representation.""" 

 

    id = wtypes.text 

    """The ID of the version, also acts as the release number""" 

 

    links = [link.Link] 

    """A Link that point to a specific version of the API""" 

 

    @staticmethod 

    def convert(id): 

        version = Version() 

        version.id = id 

        version.links = [link.Link.make_link('self', pecan.request.host_url, 

                                             id, '', bookmark=True)] 

        return version 

 

 

class Root(base.APIBase): 

 

    name = wtypes.text 

    """The name of the API""" 

 

    description = wtypes.text 

    """Some information about this API""" 

 

    versions = [Version] 

    """Links to all the versions available in this API""" 

 

    default_version = Version 

    """A link to the default version of the API""" 

 

    @staticmethod 

    def convert(): 

        root = Root() 

        root.name = "OpenStack Magnum API" 

        root.description = ("Magnum is an OpenStack project which aims to " 

                            "provide container management.") 

        root.versions = [Version.convert('v1')] 

        root.default_version = Version.convert('v1') 

        return root 

 

 

class RootController(rest.RestController): 

 

    _versions = ['v1'] 

    """All supported API versions""" 

 

    _default_version = 'v1' 

    """The default API version""" 

 

    v1 = v1.Controller() 

 

    @wsme_pecan.wsexpose(Root) 

    def get(self): 

        # NOTE: The reason why convert() it's being called for every 

        #       request is because we need to get the host url from 

        #       the request object to make the links. 

        return Root.convert() 

 

    @pecan.expose() 

    def _route(self, args): 

        """Overrides the default routing behavior. 

 

        It redirects the request to the default version of the magnum API 

        if the version number is not specified in the url. 

        """ 

 

        if args[0] and args[0] not in self._versions: 

            args = [self._default_version] + args 

        return super(RootController, self)._route(args)