FilesExpand file tree

 master

/

preprocess_spec.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

139 lines (107 loc) · 4.37 KB

 master

/

preprocess_spec.py

Copy path

Top

File metadata and controls

• Code
• Blame

139 lines (107 loc) · 4.37 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

# Copyright 2016 The Kubernetes Authors.

#

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

import operator

import os.path

import sys

from collections import OrderedDict

import urllib3

from constants import KUBERNETES_BRANCH, SPEC_VERSION

# these four constants are shown as part of this example in []:

# "[watch]Pod[List]" is the deprecated version of "[list]Pod?[watch]=True"

WATCH_OP_PREFIX = "watch"

WATCH_OP_SUFFIX = "List"

LIST_OP_PREFIX = "list"

WATCH_QUERY_PARAM_NAME = "watch"

SPEC_URL = 'https://raw.githubusercontent.com/kubernetes/kubernetes/' \

'%s/api/openapi-spec/swagger.json' % KUBERNETES_BRANCH

OUTPUT_PATH = os.path.join(os.path.dirname(__file__), 'swagger.json')

_ops = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch']

class PreprocessingException(Exception):

pass

def _title(s):

if len(s) == 0:

return s

return s[0].upper() + s[1:]

def _to_camel_case(s):

return ''.join(_title(y) for y in s.split("_"))

def apply_func_to_spec_operations(spec, func, *params):

"""Apply func to each operation in the spec.

:param spec: The OpenAPI spec to apply func to.

:param func: the function to apply to the spec's operations. It should be

a func(operation, parent) where operation will be each

operation of the spec and parent would be the parent object of

the given operation.

If the return value of the func is True, then the operation

will be deleted from the spec.

"""

for k, v in spec['paths'].iteritems():

for op in _ops:

if op not in v:

continue

if func(v[op], v, *params):

del v[op]

def _has_property(prop_list, property_name):

for prop in prop_list:

if prop["name"] == property_name:

return True

def remove_watch_operations(op, parent, operation_ids):

op_id = op['operationId']

if not op_id.startswith(WATCH_OP_PREFIX):

return

list_id = (LIST_OP_PREFIX +

op_id.replace(WATCH_OP_SUFFIX, "")[len(WATCH_OP_PREFIX):])

if list_id not in operation_ids:

raise PreprocessingException("Cannot find %s" % list_id)

list_op = operation_ids[list_id]

params = []

if 'parameters' in list_op:

params += list_op['parameters']

if 'parameters' in parent:

params += parent['parameters']

if not _has_property(params, WATCH_QUERY_PARAM_NAME):

raise PreprocessingException("%s has no watch query param" % list_id)

return True

def strip_tags_from_operation_id(operation, _):

operation_id = operation['operationId']

for t in operation['tags']:

operation_id = operation_id.replace(_to_camel_case(t), '')

operation['operationId'] = operation_id

def process_swagger(spec):

apply_func_to_spec_operations(spec, strip_tags_from_operation_id)

operation_ids = {}

apply_func_to_spec_operations(spec, lambda op, _: operator.setitem(

operation_ids, op['operationId'], op))

try:

apply_func_to_spec_operations(

spec, remove_watch_operations, operation_ids)

except PreprocessingException as e:

print(e.message)

# TODO: Kubernetes does not set a version for OpenAPI spec yet,

# remove this when that is fixed.

spec['info']['version'] = SPEC_VERSION

return spec

def main():

pool = urllib3.PoolManager()

with pool.request('GET', SPEC_URL, preload_content=False) as response:

if response.status != 200:

print "Error downloading spec file. Reason: %s" % response.reason

return 1

in_spec = json.load(response, object_pairs_hook=OrderedDict)

out_spec = process_swagger(in_spec)

with open(OUTPUT_PATH, 'w') as out:

json.dump(out_spec, out, sort_keys=False, indent=2,

separators=(',', ': '), ensure_ascii=True)

return 0

sys.exit(main())