Skip to main content

Schemas

Schemas define the structure and format of your test data. They act as blueprints that tell the platform what fields exist and their data types.

Where you'll work with schemas​

  • Schema Selection: Browse, upload, or select schemas for your project
  • Project page: Link schemas to specific projects
  • Library: View all available schemas in your workspace

Understanding schemas​

A schema is like a template that describes:

  • What fields your data will have (e.g., name, email, age)
  • The data type for each field (string, number, date, etc.)
  • Required vs. optional fields
  • Length limits, formats, and other constraints

Example: A user schema might define fields like username (string), email (string), age (number), and registration_date (date).

When to use existing schemas​

Your team may already have schemas you can reuse:

Benefits of reusing schemas:

  • Saves time—no need to create from scratch
  • Ensures consistency across team projects
  • Already validated and tested by your team

How to select an existing schema:

  1. Navigate to Schema Selection
  2. Browse available schemas
  3. Review the schema structure and fields
  4. Select the schema that matches your needs
  5. Link it to your project

When to upload new schemas​

You'll need to upload a new schema when:

  • Testing a new application or feature not yet in the library
  • Working with a unique data structure
  • Your application's data model has changed

Supported schema formats:

  • JSON Schema
  • XML Schema (XSD)
  • OpenAPI specifications
  • WSDL definitions

How to upload a schema:

  1. Navigate to Schema Selection
  2. Click "Upload Schema"
  3. Select your schema file from your computer
  4. Give it a clear, descriptive name
  5. Add a description to help team members understand its purpose
  6. Submit to make it available for use

When to create a schema from scratch (Coming Soon!)​

Typical workflow​

After creating, selecting, or uploading a schema:

  1. Create constraints: Define additional rules for data generation
  2. Generate a test dataset: Produce actual test data based on the schema and constraints
  3. Verify and download: Check the generated data meets your needs

Tips for managing schemas​

  • Use clear names: "Customer-Profile-v2" is better than "schema123"
  • Add descriptions: Explain what the schema is for and when to use it
  • Version your schemas: Include version numbers when schemas evolve
  • Share with your team: Make schemas available to others working on similar projects
  • Document changes: Note what changed between versions