Simcraft Docs

OSDL Conformance Manifest

A conformance module and its test cases.

Generated from spec/schemas/osdl.conformance.schema.json · https://osdl.dev/schemas/0.1/osdl.conformance.schema.json

Document root#

FieldTypeDescription
$schema string
osdlrequired "0.1"
kindrequired "core" | "library" | "contract"
idrequired moduleId
versionrequired version
extends array<moduleReference>
casesrequired array<case>
assertions array<assertion>

Definitions#

moduleId#

string pattern ^[a-z][a-z0-9-]*$

version#

string pattern ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$

moduleReference#

string pattern ^[a-z][a-z0-9-]*@(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(?:-(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*)(?:\.(?:0|[1-9][0-9]*|[0-9A-Za-z-]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\+[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?$

case#

FieldTypeDescription
idrequired string min length 1
description string
inputrequired input
expectedrequired expected

input#

FieldTypeDescription
formatrequired "osdl" | "machine"
pathrequired string min length 1

expected#

FieldTypeDescription
results string min length 1
events string min length 1
trace string min length 1

assertion#

FieldTypeDescription
caserequired string min length 1
results resultAssertion
events artifactAssertion
trace artifactAssertion

resultAssertion#

FieldTypeDescription
path string min length 1
comparisonrequired object

artifactAssertion#

FieldTypeDescription
pathrequired string min length 1