Skip to content

Class: GhaInput

An input that a reusable workflow or an action declares, under the key a caller writes in its with map.

  • NOTE: this is an abstract class and should not be instantiated directly

URI: gha:Input

 classDiagram
    class GhaInput
    click GhaInput href "../GhaInput/"
      GhaRequiredMixin <|-- GhaInput
        click GhaRequiredMixin href "../GhaRequiredMixin/"
      

      GhaInput <|-- GhaWorkflowInput
        click GhaWorkflowInput href "../GhaWorkflowInput/"
      GhaInput <|-- GhaActionInput
        click GhaActionInput href "../GhaActionInput/"
      

      GhaInput : default
        
      GhaInput : description
        
      GhaInput : input_id
        
      GhaInput : required
        
      
Property Value
Class URI gha:Input
Name Cardinality and Range Description Inheritance
description 0..1
String
What the input, output or secret is for, as the file describes it direct
input_id 1
GhaIdentifier
The key a caller writes in its with map direct
default 0..1
String
The value used when a caller supplies none, written as a string even where th… direct
required 0..1
Boolean
Whether a caller must supply a value GhaRequiredMixin
Mapping Type Mapped Value
self gha:Input
native gha:GhaInput
name: GhaInput
description: An input that a reusable workflow or an action declares, under the key
a caller writes in its `with` map.
from_schema: https://w3id.org/lmodel/github-actions
abstract: true
mixins:
- GhaRequiredMixin
slots:
- description
attributes:
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
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
domain_of:
- GhaInput
class_uri: gha:Input
name: GhaInput
description: An input that a reusable workflow or an action declares, under the key
a caller writes in its `with` map.
from_schema: https://w3id.org/lmodel/github-actions
abstract: true
mixins:
- GhaRequiredMixin
attributes:
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: GhaInput
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: GhaInput
domain_of:
- GhaInput
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: GhaInput
domain_of:
- GhaInput
- GhaOutput
- GhaWorkflowSecret
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: GhaInput
domain_of:
- GhaRequiredMixin
range: boolean
class_uri: gha:Input