raml.schemas.request-pattern.schema.json Maven / Gradle / Ivy

Go to download
{
    "type": "object",
    "properties": {
        "url": {
            "description": "The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.",
            "type": "string"
        },
        "urlPattern": {
            "description": "The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.",
            "type": "string"
        },
        "urlPath": {
            "description": "The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.",
            "type": "string"
        },
        "urlPathPattern": {
            "description": "The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified.",
            "type": "string"
        },
        "method": {
            "description": "The HTTP request method e.g. GET",
            "type": "string"
        },
        "headers": {
            "description": "Header patterns to match against in the : { \"\": \"\" } form",
            "type": "object"
        },
        "queryParameters": {
            "description": "Query parameter patterns to match against in the : { \"\": \"\" } form",
            "type": "object"
        },
        "cookies": {
            "description": "Cookie patterns to match against in the : { \"\": \"\" } form",
            "type": "object"
        },
        "bodyPatterns": {
            "description": "Request body patterns to match against in the : { \"\": \"\" } form",
            "type": "array",
            "items": {
                "type": "object"
            }
        },
        "basicAuthCredentials": {
            "description": "Pre-emptive basic auth credentials to match against",
            "type": "object",
            "properties": {
                "username": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                }
            },
            "required": [
                "username",
                "password"
            ]
        }
    },

    "example": {
        "method": "POST",
        "url": "/some/thing",
        "headers": {
            "Content-Type": "application/json"
        },
        "bodyPatterns": [
            { "equalToJson": "{ \"numbers\": [1, 2, 3] }" }
        ]
    }
}