WireMock Scenarios API

openapi: 3.0.0
info:
  title: WireMock Admin Near Misses Scenarios API
  description: The WireMock Admin REST API provides programmatic control over a running WireMock server instance. It supports creating, updating, and deleting stub mappings; querying the request journal; recording and replaying real API traffic; managing stateful scenarios; and performing system operations such as reset and shutdown. Available under the /__admin/ path prefix on any running WireMock instance.
  version: 2.35.0
  contact:
    name: WireMock Community
    url: https://wiremock.org/
servers:
- url: http://localhost:8080
  description: Local WireMock server instance
tags:
- name: Scenarios
  description: Scenarios support modelling of stateful behaviour
  externalDocs:
    description: User documentation
    url: http://wiremock.org/docs/stateful-behaviour/
paths:
  /__admin/scenarios:
    get:
      summary: Get All Scenarios
      tags:
      - Scenarios
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  scenarios:
                    type: array
                    items:
                      $ref: schemas/scenario.yaml
          description: All scenarios
  /__admin/scenarios/reset:
    post:
      summary: Reset the State of All Scenarios
      tags:
      - Scenarios
      responses:
        '200':
          description: Successfully reset
externalDocs:
  description: WireMock User Documentation
  url: https://wiremock.org/docs/