Keystone API Validation using JSD

example_usage.py

endpoint_schema = Endpoint(required=True)
resource_to_validate = endpoint_schema.__class__.__name__.lower()
@validation.validated(endpoint_schema.json(), resource_to_validate)

final_example.py

endpoint_schema = Endpoint(required=True)
@validation.validated(endpoint_schema) # validation handles calling .json()
                                       # and figuring out the class name

project_create_schema.py

{
    "additionalProperties": true,
    "properties": {
        "description": {
            "type": [
                "string",
                "null"
            ]
        },
        "domain_id": {
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[a-zA-Z0-9-]+$",
            "type": "string"
        },
        "enabled": {
            "enum": [
                true,
                false
            ],
            "type": "boolean"
        },
        "name": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
        }
    },
    "required": [
        "name"
    ],
    "type": "object"
}

project_jsd.py

import jsd


class Project(jsd.Object):

    description = jsd.String()
    domain_id = jsd.String()
    enabled = jsd.Boolean()
    name = jsd.String(required=True)

project_jsd_output.py

{
    "properties": {
        "description": {
            "type": [
                "string",
                "null"
            ]
        },
        "domain_id": {
            "type": [
                "string",
                "null"
            ]
        },
        "enabled": {
            "type": [
                "boolean",
                "null"
            ]
        },
        "name": {
            "type": "string"
        }
    },
    "required": [
        "name"
    ],
    "type": "object"
}

project_update_schema.py

{
    "additionalProperties": true,
    "minProperties": 1,
    "properties": {
        "description": {
            "type": [
                "string",
                "null"
            ]
        },
        "domain_id": {
            "maxLength": 64,
            "minLength": 1,
            "pattern": "^[a-zA-Z0-9-]+$",
            "type": "string"
        },
        "enabled": {
            "enum": [
                true,
                false
            ],
            "type": "boolean"
        },
        "name": {
            "maxLength": 64,
            "minLength": 1,
            "type": "string"
        }
    },
    "type": "object"
}

url_endpoint_jsd.py

import jsd


class Url(jsd.String):
    min_length = 0
    max_length = 255
    pattern = '^[a-zA-Z0-9-]+$'


class Endpoint(jsd.Object):
    enabled = jsd.Boolean()
    interface = jsd.String(required=True)
    region_id = jsd.String()
    service_id = jsd.String(required=True)
    url = Url(required=True)

url_jsd.py

import jsd


class Url(jsd.String):
    min_length = 0
    max_length = 255
    pattern = '^[a-zA-Z0-9-]+$'

url_jsd_output.py

url = {
    'type': 'string',
    'minLength': 0,
    'maxLength': 225,
    'pattern': '^[a-zA-Z0-9-]+$'
}