TeDS

# e-commerce-api.tests.yaml
version: "1.0.0"
tests:
  \# Test user registration schema
  api/schemas.yaml#/components/schemas/UserRegistration:
    valid:
      complete_registration:
        description: "Valid user registration with all required fields"
        payload:
          username: "alice_smith"
          email: "alice@example.com"
          password: "SecurePass123!"
          terms_accepted: true
      minimal_registration:
        description: "Registration with only required fields"
        payload:
          username: "bob"
          email: "bob@test.com"
          password: "MyPass456"
          terms_accepted: true
    invalid:
      missing_email:
        description: "Registration fails without email"
        payload:
          username: "invalid_user"
          password: "password123"
          terms_accepted: true
      weak_password:
        description: "Password too simple"
        payload:
          username: "user"
          email: "user@example.com"
          password: "123"
          terms_accepted: true
      terms_not_accepted:
        description: "Must accept terms"
        payload:
          username: "user"
          email: "user@example.com"
          password: "SecurePass123!"
          terms_accepted: false

# Generate comprehensive tests from OpenAPI spec
teds generate api-spec.yaml#/components/schemas
# Creates: api-spec.components+schemas.tests.yaml

# Target specific schemas with JSON Path
teds generate '{"ecommerce-api.yaml": ["$.components.schemas.User*"]}'
# Generates tests for User, UserProfile, UserSettings, etc.

# Generate from schema definitions ($defs)
teds generate '{"product-schema.yaml": ["$[\"$defs\"].*"]}'
# Handles Draft 2019-09+ $defs structure

# Bulk generation for microservices
teds generate microservices/**/*.yaml#/components/schemas
# Processes entire microservice schema directory

# Quick validation for development
teds verify api-tests.yaml
✅ All 47 test cases passed
⚡ Validation completed in 0.8 seconds

# Generate executive summary report
teds verify api-tests.yaml --report-template html \
  --output-file api-validation-report.html
📊 Creates professional HTML report with charts and metrics

# Team dashboard integration
teds verify *.tests.yaml --report-template json \
  --output-file validation-metrics.json
📈 JSON output for dashboard integration

# CI/CD pipeline integration
teds verify schemas/**/*.tests.yaml --fail-fast --quiet
🚀 Perfect for automated deployment gates

🎯 Schema Validation Results
━━━━━━━━━━━━━━━━━━━━━━━━━━━━
User Registration API: ✅ 12/12 tests passed
Product Catalog API:   ✅ 23/23 tests passed
Payment Processing:    ❌ 2/8 tests failed

❌ Failed Tests:
• PaymentRequest: Invalid card number format (test: invalid_card_luhn)
• PaymentRequest: Missing CVV validation (test: missing_cvv)

ℹ️  Fix suggestions:
• Add Luhn algorithm validation to card number pattern
• Make CVV field required in schema

# Step 1: Install TeDS
pip install teds

# Step 2: Verify installation
teds --version
# Output: teds 0.5.1 (spec supported: 1.0-1.0; recommended: 1.0)

# Step 3: Get help anytime
teds --help
teds generate --help
teds verify --help

# api/ecommerce-openapi.yaml
openapi: 3.0.3
info:
  title: E-Commerce API
  version: 1.0.0
components:
  schemas:
    Product:
      type: object
      required: [id, name, price, category]
      properties:
        id:
          type: string
          pattern: '^PROD-[0-9A-Z]{8}$'
          example: "PROD-ABC12345"
        name:
          type: string
          minLength: 3
          maxLength: 100
          example: "Wireless Bluetooth Headphones"
        price:
          type: number
          minimum: 0.01
          maximum: 99999.99
          example: 79.99
        category:
          type: string
          enum: ["electronics", "books", "clothing", "home", "sports"]
          example: "electronics"
        description:
          type: string
          maxLength: 500
          example: "High-quality wireless headphones with noise cancellation"
        in_stock:
          type: boolean
          example: true
        tags:
          type: array
          items:
            type: string
          maxItems: 10
          example: ["wireless", "bluetooth", "audio"]

# Generate test suite from OpenAPI spec
teds generate api/ecommerce-openapi.yaml#/components/schemas

# Output: Creates ecommerce-openapi.components+schemas.tests.yaml
# 📄 Generated 15 test cases covering:
#   ✅ Valid products with all constraints
#   ✅ Boundary values (min/max prices, lengths)
#   ✅ Invalid data (malformed IDs, out-of-range values)
#   ✅ Missing required fields
#   ✅ Enum validation

# Quick validation check
teds verify ecommerce-openapi.components+schemas.tests.yaml

# Sample output:
# 🎯 Testing Product schema...
# ✅ valid_product_complete: PASSED
# ✅ valid_product_minimal: PASSED
# ✅ boundary_price_minimum: PASSED
# ✅ boundary_price_maximum: PASSED
# ❌ invalid_product_id_format: FAILED - Pattern validation
# ❌ invalid_negative_price: FAILED - Minimum constraint
# ❌ invalid_category_value: FAILED - Enum validation
#
# 📆 Summary: 12/15 tests passed (80% success rate)
# ⚡ Completed in 0.3 seconds

# Generate stakeholder report
teds verify ecommerce-openapi.components+schemas.tests.yaml \
  --report-template html \
  --output-file product-validation-report.html

# Creates interactive HTML report with:
# 📊 Test coverage metrics and charts
# 🔍 Detailed failure analysis
# 📝 Actionable recommendations
# 🔗 Shareable team dashboard

[.notes]
--
The three-step process: create schema, generate tests, validate - provides immediate value.
--

// Section 7: Advanced Use Cases
== Advanced Use Cases

=== Complex Multi-Schema Testing

[.subtitle]
*Real-world microservices schema validation*

[source,yaml]

[.notes]
--
This comprehensive example shows how TeDS handles complex microservices architectures with multiple interconnected schemas. Each service has its own schema requirements, but they work together as part of a larger system.

The test specification covers realistic business scenarios including user management, product catalogs, and order processing with proper data relationships and constraints.
--

=== Advanced JSON Path Expressions

[.subtitle]
*Powerful schema targeting and filtering*

[source,bash]

[.two-columns]
--
[.column]
*Pattern Matching Features:*

[%step]
* ✅ **Wildcard selection**: `.*` for all schemas
* ✅ **Prefix matching**: `User*` for User schemas
* ✅ **Conditional filtering**: Filter by properties
* ✅ **Multi-source generation**: Combine different APIs
* ✅ **Legacy support**: `definitions` + `$defs`

[.column]
*Enterprise Use Cases:*

[%step]
* 🏢 **Microservices**: Bulk schema testing
* 🔄 **API versioning**: Target specific versions
* 🎯 **Selective testing**: Test only changed schemas
* 📦 **Multi-environment**: Different schema sets
* 🚀 **CI/CD optimization**: Smart test generation
--

[.notes]
--
JSON Path expressions provide enterprise-grade flexibility for complex schema hierarchies. The conditional filtering enables sophisticated targeting of schemas based on their properties and structure.

This is particularly valuable in microservices architectures where you might have hundreds of schemas across multiple services and need to test only specific subsets.
--

=== Enterprise CI/CD Integration

[.subtitle]
*Production-ready pipeline integration*

*GitHub Actions - Complete Workflow:*

[source,yaml]

version: "1.0.0"
tests:
  ecommerce-api.yaml#/components/schemas/UserRegistration:
    valid:
      complete_user:
        description: "Valid registration with all fields"
        payload:
          username: "alice_smith"
          email: "alice@example.com"
          password: "SecurePass123!"
          terms_accepted: true
          marketing_consent: false
      minimal_user:
        description: "Registration with only required fields"
        payload:
          username: "bob123"
          email: "bob@test.com"
          password: "MySecure99!"
          terms_accepted: true
    invalid:
      weak_password:
        description: "Password missing special character"
        payload:
          username: "user1"
          email: "user@test.com"
          password: "SimplePass123"
          terms_accepted: true
      invalid_email:
        description: "Malformed email address"
        payload:
          username: "testuser"
          email: "not-an-email"
          password: "SecurePass123!"
          terms_accepted: true
      terms_rejected:
        description: "User must accept terms"
        payload:
          username: "rejectuser"
          email: "reject@test.com"
          password: "SecurePass123!"
          terms_accepted: false