Aliases & Base Types
Contact
Contact is the contact information for a person or group
name string Required
name is the preferred descriptor for the contact entity
affiliation string
affiliation is the organization with which the contact entity is associated, such as a team, school, or employer
email Email
email is the preferred email address to reach the contact
social string
social is a social media handle or other profile for the contact, such as GitHub
Actor
Actor represents an entity (human or tool) that can perform actions in evaluations
id string Required
id uniquely identifies the actor and allows this entry to be referenced by other elements
name string Required
name is the name of the actor
type ActorType Required
type specifies the type of entity interacting in the workflow
contact Contact
contact is contact information for the actor
description string
description provides additional context about the actor
uri string
uri is a general URI for the actor information
version string
version is the version of the actor (for tools; if applicable)
ActorType
ActorType specifies what entity is interacting in the workflow
- Type:
string
Email
Email represents a validated email address pattern
- Type:
string - Value:
^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$
Datetime
Datetime represents an ISO 8601 formatted datetime string
- Type:
string - Format:
date - Value:
^\d{4}-\d{2}-\d{2}$
Group
Group represents a classification or grouping that can be used in different contexts with semantic meaning derived from its usage
description string Required
description explains the significance and traits of entries to this group
id string Required
id allows this entry to be referenced by other elements
title string Required
title describes the purpose of this group at a glance