Projet

Général

Profil

0001-utils-include-type-of-params-in-endpoint-documentati.patch

Valentin Deniaud, 09 décembre 2019 17:53

Télécharger (2,05 ko)

Voir les différences: 

Subject: [PATCH] utils: include type of params in endpoint documentation
 (#38328)


 passerelle/utils/api.py | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)
passerelle/utils/api.py
155 155 
            if param == 'post_data':
156 156 
                continue
157 157 
            param_info = {'name': param}
158 
            if self.parameters and param in self.parameters and self.parameters[param].get('description'):
159 
                param_info['description'] = self.parameters[param].get('description')
158 
            if self.parameters and param in self.parameters:
159 
                info = self.parameters[param]
160 
                if info.get('description'):
161 
                    param_info['description'] = info['description']
162 
                if 'type' in info:
163 
                    typ = info['type']
164 
                    if typ == 'int':
165 
                        param_info['type'] = 'integer'
166 
                    elif typ == 'bool':
167 
                        param_info['type'] = 'boolean'
168 
                    else:
169 
                        param_info['type'] = typ
160 170 
            if param in defaults:
171 
                value = defaults[param]
161 172 
                param_info['optional'] = True
162 
                param_info['default_value'] = defaults[param]
173 
                param_info['default_value'] = value
174 
                if 'type' not in param_info:
175 
                    if isinstance(value, bool):
176 
                        param_info['type'] = 'boolean'
177 
                    elif isinstance(value, int):
178 
                        param_info['type'] = 'integer'
179 
                    elif isinstance(value, float):
180 
                        param_info['type'] = 'float'
163 181 
            params.append(param_info)
164 182 
        return params
165 
-