vbatts/quay
Archived
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Add back error_message and error_type for backwards-compatibility

Browse source
This commit is contained in:
Evan Cordell 2016-04-13 09:02:24 -04:00
parent 7b44beb1fd
commit e1b3312495
2 changed files with 35 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

58
endpoints/api/discovery.py
View file

@ -180,30 +180,38 @@ def swagger_route_data(include_internal=False, compact=False):
models[response_schema_name] = view_class.schemas[response_schema_name] models[response_schema_name] = view_class.schemas[response_schema_name]
models['ApiError'] = { models['ApiError'] = {
'type': 'object', 'type': 'object',
'properties': { 'properties': {
'status': { 'status': {
'type': 'integer', 'type': 'integer',
'description': 'Status code of the response.' 'description': 'Status code of the response.'
},
'type': {
'type': 'string',
'description': 'Reference to the type of the error.'
},
'detail': {
'type': 'string',
'description': 'Details about the specific instance of the error.'
},
'title': {
'type': 'string',
'description': 'Unique error code to identify the type of error.'
}
}, },
'required': [ 'type': {
'status', 'type': 'string',
'type', 'description': 'Reference to the type of the error.'
'title', },
] 'detail': {
'type': 'string',
'description': 'Details about the specific instance of the error.'
},
'title': {
'type': 'string',
'description': 'Unique error code to identify the type of error.'
},
'error_message': {
'type': 'string',
'description': 'Deprecated; alias for detail'
},
'error_type': {
'type': 'string',
'description': 'Deprecated; alias for detail'
}
},
'required': [
'status',
'type',
'title',
]
} }
responses = { responses = {
@ -224,8 +232,8 @@ def swagger_route_data(include_internal=False, compact=False):
}, },
} }
for status, body in responses.items(): for _, body in responses.items():
body['schema'] = {'$ref': '#/definitions/ApiError'} body['schema'] = {'$ref': '#/definitions/ApiError'}
if method_name == 'DELETE': if method_name == 'DELETE':
responses['204'] = { responses['204'] = {

2
endpoints/exception.py
View file

@ -67,7 +67,9 @@ class ApiException(Exception):
if self.error_description is not None: if self.error_description is not None:
rv['detail'] = self.error_description rv['detail'] = self.error_description
rv['error_message'] = self.error_description # TODO: deprecate
rv['error_type'] = self.error_type.value # TODO: deprecate
rv['title'] = self.error_type.value rv['title'] = self.error_type.value
rv['type'] = url_for('error', error_type=self.error_type.value, _external=True) rv['type'] = url_for('error', error_type=self.error_type.value, _external=True)
rv['status'] = self.status_code rv['status'] = self.status_code