Skip to content
github-actions

Class: GhaActionInput

An input under an action’s inputs key.

URI: gha:ActionInput

 classDiagram
    class GhaActionInput
    click GhaActionInput href "../GhaActionInput/"
      GhaInput <|-- GhaActionInput
        click GhaInput href "../GhaInput/"
      
      GhaActionInput : default
        
      GhaActionInput : deprecation_message
        
      GhaActionInput : description
        
      GhaActionInput : input_id
        
      GhaActionInput : required

Inheritance

Section titled “Inheritance”

Class Properties

Section titled “Class Properties”
Property Value
Class URI gha:ActionInput

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
deprecation_message 0..1
String		 The message GitHub shows a workflow that still passes the input, the file’s `… direct
description 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

Section titled “Usages”
used by used in type used
GhaAction inputs range GhaActionInput

See Also

Section titled “See Also”

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self gha:ActionInput
native gha:GhaActionInput

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: GhaActionInput
description: An input under an action's `inputs` key.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputs
is_a: GhaInput
slot_usage:
  description:
    name: description
    required: true
attributes:
  deprecation_message:
    name: deprecation_message
    description: The message GitHub shows a workflow that still passes the input,
      the file's `deprecationMessage`; present only when the input is deprecated.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_action
    see_also:
    - https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputsinput_iddeprecationmessage
    rank: 1000
    domain_of:
    - GhaActionInput
class_uri: gha:ActionInput

Induced

Section titled “Induced”
name: GhaActionInput
description: An input under an action's `inputs` key.
from_schema: https://w3id.org/lmodel/github-actions
see_also:
- https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputs
is_a: GhaInput
slot_usage:
  description:
    name: description
    required: true
attributes:
  deprecation_message:
    name: deprecation_message
    description: The message GitHub shows a workflow that still passes the input,
      the file's `deprecationMessage`; present only when the input is deprecated.
    from_schema: https://w3id.org/lmodel/github-actions/github_actions_action
    see_also:
    - https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax#inputsinput_iddeprecationmessage
    rank: 1000
    owner: GhaActionInput
    domain_of:
    - GhaActionInput
    range: string
  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: GhaActionInput
    domain_of:
    - GhaInput
    - GhaOutput
    - GhaWorkflowSecret
    range: string
    required: true
  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: GhaActionInput
    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: GhaActionInput
    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: GhaActionInput
    domain_of:
    - GhaRequiredMixin
    range: boolean
class_uri: gha:ActionInput