Contact

Stable

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

Entity

Stable

Entity represents a human or tool

id string Required

id uniquely identifies the entity and allows this entry to be referenced by other elements

name string Required

name is the name of the entity

type EntityType Required

type specifies the type of entity interacting in the workflow

description string

description provides additional context about the entity

uri string

uri is a general URI for the entity information

version string

version is the version of the entity (for tools; if applicable)

Actor

Stable

Actor represents an entity (human or tool) that performs actions in evaluations

contact Contact

contact is contact information for the actor

Resource

Stable

Resource represents an entity that exists in the system and can be evaluated

environment string

environment describes where the resource exists (e.g., production, staging, development, specific region)

owner Contact

owner is the contact information for the person or group responsible for managing or owning this resource

EntityType

EntityType 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

Stable

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

RACI

Stable

RACI defines the roles responsible for managing an artifact

accountable array[Contact] Required

accountable identifies the entity ultimately accountable for the outcome

responsible array[Contact] Required

responsible identifies the entities responsible for executing work to manage or mitigate the artifact

consulted array[Contact]

consulted identifies entities whose input is required when assessing or responding to the artifact

informed array[Contact]

informed identifies entities that should be notified about changes to the artifact status

Lifecycle

Lifecycle represents the lifecycle state of a guideline, control, or assessment requirement

  • Type: string

Catalog

Stable

Catalog describes a set of topically-associated entries

metadata Metadata Required

metadata provides detailed data about this catalog

title string Required

title describes the purpose of this catalog at a glance

extends array[ArtifactMapping]

extends references catalogs that this catalog builds upon

groups array[Group]

groups contains a list of groups that can be referenced by entries in this catalog

imports array[MultiEntryMapping]

Log

Stable

Log describes a set of recorded entries from a measurement activity

metadata Metadata Required

metadata provides detailed data about this log

target Resource Required

target identifies the resource being evaluated

ArtifactType

ArtifactType identifies the kind of Gemara artifact for unambiguous parsing

  • Type: string

EntryType

EntryType enumerates the atomic units within Gemara artifacts that can participate in mappings

  • Type: string

ConfidenceLevel

ConfidenceLevel indicates the evaluator’s confidence level in an assessment result.

  • Type: string