deckhand.common.validation_message module¶
-
class
deckhand.common.validation_message.
ValidationMessage
(message='Document validation error.', error=True, name='Deckhand validation error', level='Error', doc_schema='', doc_name='', doc_layer='', diagnostic='')[source]¶ Bases:
object
ValidationMessage per Airship convention: https://github.com/openstack/airship-in-a-bottle/blob/master/doc/source/api-conventions.rst#output-structure # noqa
Construction of
ValidationMessage
message:Parameters: - message (string) – Validation failure message.
- error (boolean) – True or False, if this is an error message.
- name (string) – Identifying name of the validation.
- level (string) – The severity of validation result, as “Error”, “Warning”, or “Info”
- schema (string) – The schema of the document being validated.
- doc_name (string) – The name of the document being validated.
- diagnostic (string) – Information about what lead to the message, or details for resolution.