CreateScenarioRequest

Request body for creating a BDD scenario

AgileBehavior Driven DevelopmentGherkinQuality AssuranceRequirementsTestingUser Stories

Properties

Name	Type	Description
storyId	string	ID of the parent user story
criterionId	string	ID of the linked acceptance criterion
title	string	Scenario title
featureFile	string	Feature file path
gherkin	string	Full Gherkin scenario text

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.example.com/schemas/create-scenario-request.json",
  "title": "CreateScenarioRequest",
  "type": "object",
  "description": "Request body for creating a BDD scenario",
  "required": [
    "storyId",
    "title",
    "featureFile",
    "gherkin"
  ],
  "properties": {
    "storyId": {
      "type": "string",
      "description": "ID of the parent user story"
    },
    "criterionId": {
      "type": "string",
      "description": "ID of the linked acceptance criterion"
    },
    "title": {
      "type": "string",
      "description": "Scenario title"
    },
    "featureFile": {
      "type": "string",
      "description": "Feature file path"
    },
    "gherkin": {
      "type": "string",
      "description": "Full Gherkin scenario text"
    }
  }
}