Specmatic Configuration
Configuration file for Specmatic, a contract-driven testing tool
| Type | object |
|---|---|
| File match |
specmatic.json
specmatic.yaml
specmatic.yml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/specmatic-configuration/latest.json |
| Source | https://www.schemastore.org/specmatic.json |
Validate with Lintel
npx @lintel/lintel checkConfiguration file for Specmatic, a contract-driven testing tool https://specmatic.io/documentation/
Properties
All of
Definitions
1 nested properties
7 nested properties
8 nested properties
3 nested properties
Configuration version for Specmatic
Array of contract configurations
Authentication configuration
2 nested properties
Path to file containing bearer token
Environment variable name containing bearer token
Azure DevOps pipeline configuration
4 nested properties
Pipeline provider type
Azure DevOps organization name
Azure DevOps project name
Pipeline definition ID
Environment-specific configurations
Custom hooks configuration
Repository information
2 nested properties
Repository provider type
Name of the collection
Report generation configuration
Security configuration
Test execution configuration
6 nested properties
Configuration for resiliency tests
1 nested properties
Level of resiliency tests to enable
Whether to validate response values
Whether to allow extensible schema validation
Test timeout in milliseconds
Whether to enable strict mode for contract testing
3 nested properties
Stub/mock server configuration
8 nested properties
Whether to enable generative stubbing
Delay to add to stub responses in milliseconds
Path to dictionary file for generative stubbing
Whether to include mandatory and requested keys in response
Timeout for stub server startup in milliseconds
Hot reload configuration
Whether to enable strict mode for stubbing
3 nested properties
Virtual service configuration
1 nested properties
List of keys that cannot be patched
List of example file paths
Workflow configuration for ID management
1 nested properties
ID operation configurations
Whether to ignore inline examples in specifications
Path to additional example parameters file
Pattern for selecting attributes in API responses
2 nested properties
Default fields to include
Query parameter key for field selection
Whether all patterns are mandatory
Default values for patterns
Whether to disable telemetry data collection
Defines a contract source and its provides/consumes configuration.
Git contract source details.
3 nested properties
URL of the git repository.
Branch name in the git repository.
Filesystem contract source details.
1 nested properties
Directory path for contract files.
Web contract source details.
1 nested properties
Base URL for web-hosted contract files.
List of specs provided for testing. Each entry can be a string or an object.
List of specs consumed for stubbing. Each entry can be a string or an object.
Authentication configuration
Path to file containing bearer token
Environment variable name containing bearer token
Azure DevOps pipeline configuration
Pipeline provider type
Azure DevOps organization name
Azure DevOps project name
Pipeline definition ID
Environment-specific configuration
Base URLs for different services
Environment variables
Repository information
Repository provider type
Name of the collection
Configuration for a specific report formatter
Type of report formatter
Layout style for the report
Whether to generate a lite version of the report
Title for the report
Path to logo image for the report
Alt text for the logo
Heading for the report
Directory to output the report
Configuration for different report types
API coverage report configuration
OpenAPI coverage configuration
2 nested properties
Success criteria for API coverage
3 nested properties
Minimum coverage percentage threshold
Maximum number of missed endpoints allowed
Whether to enforce the success criteria
List of endpoints to exclude from coverage
OpenAPI coverage configuration
Success criteria for API coverage
3 nested properties
Minimum coverage percentage threshold
Maximum number of missed endpoints allowed
Whether to enforce the success criteria
List of endpoints to exclude from coverage
Success criteria for API coverage
Minimum coverage percentage threshold
Maximum number of missed endpoints allowed
Whether to enforce the success criteria
OpenAPI security configuration
Security scheme configurations
Configuration for a security scheme
Type of security scheme
Authentication token
Authentication value
Test execution configuration
Configuration for resiliency tests
1 nested properties
Level of resiliency tests to enable
Whether to validate response values
Whether to allow extensible schema validation
Test timeout in milliseconds
Whether to enable strict mode for contract testing
3 nested properties
Configuration for resiliency tests
Level of resiliency tests to enable
Stub/mock server configuration
Whether to enable generative stubbing
Delay to add to stub responses in milliseconds
Path to dictionary file for generative stubbing
Whether to include mandatory and requested keys in response
Timeout for stub server startup in milliseconds
Hot reload configuration
Whether to enable strict mode for stubbing
3 nested properties
Virtual service configuration
List of keys that cannot be patched
Workflow configuration for ID management
ID operation configurations
Configuration for ID operations in workflow
JSONPath expression to extract ID
JSONPath expression to use extracted ID
Pattern for selecting attributes in API responses
Default fields to include
Query parameter key for field selection
A single spec path.