Stedi::Specification

Stedi::Specification Schema

stedi-specification
AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknownNoForbiddenAllowednoneUnknown

Stedi::Specification Type

object (Stedi::Specification)

Stedi::Specification Examples

Resources:
  StediSpecification:
    Type: Stedi::Specification
    Properties:
      Title: my-spec
      Description: My Specification
      Set: '810'
      Release: X12-004010
      Status: PRIVATE

Stedi::Specification Properties

PropertyTypeRequiredNullableDefined by
TitlestringRequiredcannot be nullStedi::Specification
DescriptionstringOptionalcannot be nullStedi::Specification
SetstringRequiredcannot be nullStedi::Specification
ReleasestringRequiredcannot be nullStedi::Specification
StatusstringRequiredcannot be nullStedi::Specification
Additional PropertiesAnyOptionalcan be null

Title

Title

  • is required

  • Type: string

  • cannot be null

  • defined in: Stedi::Specification

Title Type

string

Description

Description

Description Type

string

Set

Set

Set Type

string

Set Constraints

pattern: the string must match the following regular expression:

^\d{3}$

try pattern

Release

Release

Release Type

string

Release Constraints

pattern: the string must match the following regular expression:

^X12-\d{6}$

try pattern

Status

Status of the specification. Can be public, unlisted or private.

Status

Status Type

string

Status Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"PUBLIC"
"UNLISTED"
"PRIVATE"

Additional Properties

Additional properties are allowed and do not have to follow a specific schema

Stedi::Specification SchemaStedi::Specification Properties