Stop recording

{
  "type": "object",
  "properties": {
    "mappings": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "This stub mapping's unique identifier"
          },
          "metadata": {
            "type": "object",
            "description": "Arbitrary metadata to be used for e.g. tagging, documentation. Can also be used to find and remove stubs."
          },
          "name": {
            "type": "string",
            "description": "The stub mapping's name"
          },
          "newScenarioState": {
            "type": "string",
            "description": "The new state for the scenario to be updated to after this stub is served."
          },
          "persistent": {
            "type": "boolean",
            "description": "Indicates that the stub mapping should be persisted immediately on create/update/delete and survive resets to default."
          },
          "postServeActions": {
            "type": "object",
            "description": "A map of the names of post serve action extensions to trigger and their parameters."
          },
          "priority": {
            "type": "integer",
            "description": "This stub mapping's priority relative to others. 1 is highest."
          },
          "request": {
            "type": "object",
            "properties": {
              "basicAuthCredentials": {
                "type": "object",
                "description": "Pre-emptive basic auth credentials to match against",
                "required": [
                  "username",
                  "password"
                ],
                "properties": {
                  "password": {
                    "type": "string"
                  },
                  "username": {
                    "type": "string"
                  }
                }
              },
              "bodyPatterns": {
                "type": "array",
                "description": "Request body patterns to match against in the <key>: { \"<predicate>\": \"<value>\" } form",
                "items": {
                  "type": "object"
                }
              },
              "cookies": {
                "type": "object",
                "description": "Cookie patterns to match against in the <key>: { \"<predicate>\": \"<value>\" } form"
              },
              "headers": {
                "type": "object",
                "description": "Header patterns to match against in the <key>: { \"<predicate>\": \"<value>\" } form"
              },
              "method": {
                "type": "string",
                "description": "The HTTP request method e.g. GET"
              },
              "queryParameters": {
                "type": "object",
                "description": "Query parameter patterns to match against in the <key>: { \"<predicate>\": \"<value>\" } form"
              },
              "url": {
                "type": "string",
                "description": "The path and query to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
              },
              "urlPath": {
                "type": "string",
                "description": "The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
              },
              "urlPathPattern": {
                "type": "string",
                "description": "The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
              },
              "urlPattern": {
                "type": "string",
                "description": "The path and query regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be specified."
              }
            }
          },
          "requiredScenarioState": {
            "type": "string",
            "description": "The required state of the scenario in order for this stub to be matched."
          },
          "response": {
            "type": "object"
          },
          "scenarioName": {
            "type": "string",
            "description": "The name of the scenario that this stub mapping is part of"
          },
          "uuid": {
            "type": "string",
            "description": "Alias for the id"
          }
        },
        "additionalProperties": false
      }
    },
    "meta": {
      "type": "object",
      "required": [
        "total"
      ],
      "properties": {
        "total": {
          "type": "integer"
        }
      }
    }
  },
  "additionalProperties": false
}