Skip to content

Commit

Permalink
fix(docs): schema links (#204)
Browse files Browse the repository at this point in the history
  • Loading branch information
domire8 authored Jan 10, 2025
1 parent 9f87c98 commit f1b308a
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ components, as they provide no meaningful behavior if directly instantiated.

<!-- FIXME: link to the schema on GitHub once it is on main; relative paths will break if the doc is versioned -->
The expected structure of the signal description is defined by
the [Signal Description JSON schema](../../../../schemas/signals/schema/signal.schema.json).
the [Signal Description JSON schema](../../../../schemas/interfaces/schema/common/signal.schema.json).

Component inputs and outputs are described with a signal name and type, matching the name and type in the implementation
when using the respective `add_input` or `add_output` function. Additionally, a human-readable display name and
Expand Down Expand Up @@ -136,14 +136,14 @@ An example description of a component with one input and one output, both as joi

<!-- FIXME: link to the schemas on GitHub once they are on main; relative paths will break if the doc is versioned -->
The expected structure of the parameter description is defined by
the [Parameter Description JSON schema](../../../../schemas/parameters/schema/parameter.schema.json).
the [Parameter Description JSON schema](../../../../schemas/interfaces/schema/common/parameter.schema.json).

Parameters contain a value of a certain type, described by the `parameter_type` property. Valid parameter types are
defined in the [Parameter Type JSON schema](../../../../schemas/parameters/schema/parameter_type.schema.json).
defined in the [Parameter Type JSON schema](../../../../schemas/interfaces/schema/common/parameter_type.schema.json).

If the `parameter_type` property is `state`, then the `parameter_state_type` property must also be defined as a member
of the enumeration
in [Encoded State Type JSON schema](../../../../schemas/parameters/schema/encoded_state_type.schema.json).
in [Encoded State Type JSON schema](../../../../schemas/interfaces/schema/common/encoded_state_type.schema.json).

Parameters generally have a default value which renders them optional in some cases. When a parameter has no valid
default state and must be set by the user for the component to function, the `default_value` property in the component
Expand Down

0 comments on commit f1b308a

Please sign in to comment.