raml.schemas.stub-mapping.schema.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wiremock-standalone Show documentation

A web service test double for all occasions

There is a newer version: 3.0.1

{
    "type": "object",
    "properties": {
        "id": {
            "description": "This stub mapping's unique identifier",
            "type": "string"
        },
        "priority": {
            "description": "This stub mapping's priority relative to others. 1 is highest.",
            "type": "integer",
            "minimum": 1
        },
        "persistent": {
            "description": "Indicates that the stub mapping should be persisted immediately on create/update/delete and survive resets to default.",
            "type": "boolean"
        },
        "scenarioName": {
            "descrption": "The name of the scenario that this stub mapping is part of",
            "type": "string"
        },
        "requiredScenarioState": {
            "descrption": "The required state of the scenario in order for this stub to be matched.",
            "type": "string"
        },
        "newScenarioState": {
            "descrption": "The new state for the scenario to be updated to after this stub is served.",
            "type": "string"
        },
        "postServeActions": {
            "descrption": "A map of the names of post serve action extensions to trigger and their parameters.",
            "type": "object"
        },

        "request": {
            "$ref": "request-pattern.schema.json"
        },

        "response": {
            "$ref": "response-definition.schema.json"
        }
    },
    "example": {
        "id": "76ada7b0-49ae-4229-91c4-396a36f18e09",
        "priority": 3,

        "request": {
            "method": "GET",
            "url": "/some/thing",
            "headers": {
                "Accept": "text/plain"
            }
        },
        "response": {
            "status": 200,
            "body": "Hello world!",
            "headers": {
                "Content-Type": "text/plain"
            }
        }
    }
}