name

string

Source representation of the component’s name. Format = single word, only lowercase letters, and may contain hyphens and underscores.

version

string

Version number of the component’s source. Format = x.x.x per semantic versioning guidelines.

description

string

Human readable representation of the component’s name. Typically used in rendered documentation referencing the component.

license

string

List of licenses used within the component’s source. Format = SPDX license expression.

author

string

Identifies author (e.g. owner of source intellectual property). Format (email and website are optional)= Author Name <email address> (website URL)

dependencies

dictionary

string

Per NPM/Yarn. Key = dependency name. Value = Semantic versioning version string.

components

dictionary

Component

Listing of sub-components directly owned by this component. Key = sub-component’s name. Value = sub-component’s data structure.

parts

dictionary

Component List Item

Listing of the component’s parts (and substitutions) defined as sub-components. Key = part’s id. Value = part’s key data.

functions

list

Function

Listing of component functions.

tools

dictionary

Component List Item

Listing of the required tools (and substitutions) defined as sub-components. Key = tool’s id. Value = tool’s key data.

precautions

list

string

Listing of caution statements (e.g. safety warnings) for the component.

assemblySteps

list

Activity Step

Sequence of steps required to assemble the component.

id

string

Part’s ID (or part number). Format = single word, only lowercase letters, and may contain hyphens and underscores.

description

string

Human readable name for the part (not name of the selected component for this part).

descriptionLong

string

Computed value = "{{id}}:\ {{description}}". Used as shortcut in documentation.

descriptionSelected

string

Computed value = "{{id}}:\ {{description}} ({{selectedOption.description}} v{{selectedOption.version}})"

quantity

number

Defines how much of the item is required (whole number or real number depending on item)

quantityUnits

string

Unit of measure for the specified quantity. When specifiying units for whole components use "part".

options

list

string

List of component names defining available substitutions for the part or tool.

selectedOption

integer

Specifies the selected option from the list of component options.

notes

string

Developer comments on this part or tool.

summary

string

Brief overview of the step (optional if step includes details). Can be used as a heading in documentation rendered from the step.

requiredParts

list

string

Optional list of part IDs needed to complete this step.

requiredTools

list

string

Optional list of tool IDs needed to complete this step.

details

string

Multiline formatted text string defining the details of the step (optional if step includes summary). Format is up to user (e.g. list, ordered list, narrative text, some combination).

name

string

Source representation of the parameter’s name. Format is C-style variable naming convention

description

string

Human readable representation of the parameter’s name. Typically used in rendered documentation referencing the parameter.

type

string

Parameter type, may be a base type (e.g. string, int) or a path to a Data Structure

units

string

Unit of measure for the specified quantity.

defaultValue

string

String representation of default parameter value.

constraints

list

string

Each item in the list defines a restriction of the values the parameter may store (e.g., ⇐ 10, enums = 3.14, 42, 1701).

name

string

Source representation of the function’s name. Format is C-style function declaration naming convention

description

string

Human readable representation of the function’s name. Typically used in rendered documentation referencing the function.

inputs

list

Parameter

Listing of acceptable input parameters by this function.

outputs

list

Parameter

Listing of expected output parameters from this function.