CreateAcceptanceCriterionRequest

Request body for adding an acceptance criterion to a story

AgileBehavior Driven DevelopmentGherkinQuality AssuranceRequirementsTestingUser Stories

Properties

Name	Type	Description
description	string	Plain-language description of the acceptance condition
format	string	Format of the criterion
given	string	Gherkin Given clause
when	string	Gherkin When clause
then	string	Gherkin Then clause
order	integer	Display order position

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.example.com/schemas/create-acceptance-criterion-request.json",
  "title": "CreateAcceptanceCriterionRequest",
  "type": "object",
  "description": "Request body for adding an acceptance criterion to a story",
  "required": [
    "description"
  ],
  "properties": {
    "description": {
      "type": "string",
      "description": "Plain-language description of the acceptance condition"
    },
    "format": {
      "type": "string",
      "description": "Format of the criterion",
      "enum": [
        "plain-text",
        "gherkin",
        "checklist"
      ]
    },
    "given": {
      "type": "string",
      "description": "Gherkin Given clause"
    },
    "when": {
      "type": "string",
      "description": "Gherkin When clause"
    },
    "then": {
      "type": "string",
      "description": "Gherkin Then clause"
    },
    "order": {
      "type": "integer",
      "description": "Display order position"
    }
  }
}