Class: GhaWorkflowInput

An input under a reusable workflow’s on.workflow_call.inputs key.

URI: gha:WorkflowInput

 classDiagram
    class GhaWorkflowInput
    click GhaWorkflowInput href "../GhaWorkflowInput/"
      GhaInput <|-- GhaWorkflowInput
        click GhaInput href "../GhaInput/"
      
      GhaWorkflowInput : default
        
      GhaWorkflowInput : description
        
      GhaWorkflowInput : input_id
        
      GhaWorkflowInput : input_type
        
          
    
        
        
        GhaWorkflowInput --> "1" GhaWorkflowInputType : input_type
        click GhaWorkflowInputType href "../GhaWorkflowInputType/"
    

        
      GhaWorkflowInput : required
        
      

Inheritance

• GhaInput [ GhaRequiredMixin]
  • GhaWorkflowInput

Class Properties

Property	Value
Class URI	gha:WorkflowInput

Slots

Name	Cardinality and Range	Description	Inheritance
input_type	1 GhaWorkflowInputType	The input’s type, which a reusable workflow’s input must state	direct
description	0..1 String	What the input, output or secret is for, as the file describes it	GhaInput
input_id	1 GhaIdentifier	The key a caller writes in its with map	GhaInput
default	0..1 String	The value used when a caller supplies none, written as a string even where th…	GhaInput
required	0..1 Boolean	Whether a caller must supply a value	GhaRequiredMixin

Usages

used by	used in	type	used
GhaReusableWorkflow	inputs	range	GhaWorkflowInput

See Also

• https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputs

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/github-actions

Mappings

Mapping Type	Mapped Value
self	gha:WorkflowInput
native	gha:GhaWorkflowInput

LinkML Source

Direct

name: GhaWorkflowInput
description: An input under a reusable workflow's `on.workflow_call.inputs` key.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputs
is_a: GhaInput
attributes:
  input_type:
    name: input_type
    description: The input's `type`, which a reusable workflow's input must state.
      Named input_type because a knowledge bundle reads `type` as the class of the
      concept.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_workflow
    see_also:
    - https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputsinput_idtype
    rank: 1000
    domain_of:
    - GhaWorkflowInput
    range: GhaWorkflowInputType
    required: true
class_uri: gha:WorkflowInput

Induced

name: GhaWorkflowInput
description: An input under a reusable workflow's `on.workflow_call.inputs` key.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputs
is_a: GhaInput
attributes:
  input_type:
    name: input_type
    description: The input's `type`, which a reusable workflow's input must state.
      Named input_type because a knowledge bundle reads `type` as the class of the
      concept.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_workflow
    see_also:
    - https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_callinputsinput_idtype
    rank: 1000
    owner: GhaWorkflowInput
    domain_of:
    - GhaWorkflowInput
    range: GhaWorkflowInputType
    required: true
  description:
    name: description
    description: What the input, output or secret is for, as the file describes it.
    comments:
    - It means what LOKF's description means and carries the same IRI, so lokf adapt
      folds it into LOKF's slot and a knowledge bundle reads one description key.
    from_schema: https://w3id.org/lmodel/github-actions
    rank: 1000
    slot_uri: schema:description
    owner: GhaWorkflowInput
    domain_of:
    - GhaInput
    - GhaOutput
    - GhaWorkflowSecret
    range: string
  input_id:
    name: input_id
    description: The key a caller writes in its `with` map.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_core
    rank: 1000
    owner: GhaWorkflowInput
    domain_of:
    - GhaInput
    range: gha_identifier
    required: true
  default:
    name: default
    description: The value used when a caller supplies none, written as a string even
      where the input's type is a boolean or a number.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_core
    rank: 1000
    owner: GhaWorkflowInput
    domain_of:
    - GhaInput
    range: string
  required:
    name: required
    description: Whether a caller must supply a value.
    comments:
    - 'An attribute rather than a slot: it carries LOKF''s IRI for required, and lokf
      adapt keeps an attribute''s name, where it would rename a slot that shares one
      with lokf.yaml.'
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_core
    rank: 1000
    slot_uri: schema:valueRequired
    owner: GhaWorkflowInput
    domain_of:
    - GhaRequiredMixin
    range: boolean
class_uri: gha:WorkflowInput