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

#!/usr/bin/env python 

# -*- coding: utf-8 -*- 

 

############################################################################### 

#  Copyright 2013 Kitware Inc. 

# 

#  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. 

############################################################################### 

 

from ..api_docs import Describe 

 

apis = [] 

 

apis.append({ 

    'path': '/assetstore', 

    'resource': 'file', 

    'operations': [{ 

        'httpMethod': 'POST', 

        'nickname': 'createAssetstore', 

        'responseClass': 'Assetstore', 

        'summary': 'Create a new assetstore.', 

        'parameters': [ 

            Describe.param('name', "Unique name for the assetstore."), 

            Describe.param('type', "Type of the assetstore.", 

                           dataType='integer') 

            ], 

        'errorResponses': [ 

            Describe.errorResponse(), 

            Describe.errorResponse('Write access was denied on the parent', 403) 

            ] 

        }, { 

        'httpMethod': 'GET', 

        'nickname': 'listAssetstores', 

        'responseClass': 'Assetstore', 

        'summary': 'List assetstores.', 

        'parameters': [ 

            Describe.param( 

                'limit', "Result set size limit (default=50).", required=False, 

                dataType='integer'), 

            Describe.param( 

                'offset', "Offset into result set (default=0).", required=False, 

                dataType='integer'), 

            Describe.param( 

                'sort', "Field to sort the assetstore list by (default=name)", 

                required=False), 

            Describe.param( 

                'sortdir', "1 for ascending, -1 for descending (default=1)", 

                required=False, dataType='integer') 

            ], 

        'errorResponses': [ 

            Describe.errorResponse(), 

            Describe.errorResponse('You are not an administrator.', 403) 

            ] 

        }] 

    }) 

 

Describe.declareApi('assetstore', apis=apis)