bbfe719349
This PS adds documentation for all the document schemas that are used for ``deckhand-schema-validation`` validations. This will help users to know what their schemas need to look like for Deckhand to accept them. The documentation like most of it is generated automically via sphinx. A docstring was provided under each module schema variable and included inside __all__ because according to docs [0]: "For modules, __all__ will be respected when looking for members; the order of the members will also be the order in __all__." [0] http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-automodule Change-Id: I224f3980dcf877bab400aa505728a332e67709cc
81 lines
2.9 KiB
Python
81 lines
2.9 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# 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.
|
|
|
|
schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'schema': {
|
|
'type': 'string',
|
|
'pattern': '^(deckhand/ValidationPolicy/v[1]{1}(\.[0]{1}){0,1})$'
|
|
},
|
|
'metadata': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'schema': {
|
|
'type': 'string',
|
|
'pattern': '^(metadata/Control/v[1]{1}(\.[0]{1}){0,1})$'
|
|
},
|
|
'name': {'type': 'string'},
|
|
'storagePolicy': {
|
|
'type': 'string',
|
|
'enum': ['encrypted', 'cleartext']
|
|
}
|
|
},
|
|
'additionalProperties': False,
|
|
'required': ['schema', 'name']
|
|
},
|
|
'data': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'validations': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': {
|
|
'type': 'string',
|
|
'pattern': '^.*-(validation|verification)$'
|
|
},
|
|
# 'expiresAfter' is optional.
|
|
'expiresAfter': {'type': 'string'}
|
|
},
|
|
'additionalProperties': False,
|
|
'required': ['name']
|
|
}
|
|
}
|
|
},
|
|
'additionalProperties': True,
|
|
'required': ['validations']
|
|
}
|
|
},
|
|
'additionalProperties': False,
|
|
'required': ['schema', 'metadata', 'data']
|
|
}
|
|
"""JSON schema against which all documents with
|
|
``deckhand/ValidationPolicy/v1`` ``schema`` are validated.
|
|
|
|
.. literalinclude::
|
|
../../deckhand/engine/schema/v1_0/validation_policy_schema.py
|
|
:language: python
|
|
:lines: 15-64
|
|
|
|
This schema is used to sanity-check all ValidationPolicy documents that are
|
|
passed to Deckhand. This schema is only enforced after validation for
|
|
:py:data:`~deckhand.engine.schema.base_schema` has passed. Failure to pass
|
|
this schema will result in an error entry being created for the validation
|
|
with name ``deckhand-schema-validation`` corresponding to the created revision.
|
|
"""
|
|
|
|
__all__ = ['schema']
|