Skip to content

Class: HookPayloadSpec

Specification of a hook payload model.

URI: mellea:HookPayloadSpec

 classDiagram
    class HookPayloadSpec
    click HookPayloadSpec href "../HookPayloadSpec/"
      ModelElement <|-- HookPayloadSpec
        click ModelElement href "../ModelElement/"

      HookPayloadSpec : coverage_scope





        HookPayloadSpec --> "*" CoverageScopeEnum : coverage_scope
        click CoverageScopeEnum href "../CoverageScopeEnum/"



      HookPayloadSpec : description

      HookPayloadSpec : element_kind





        HookPayloadSpec --> "0..1" ElementKindEnum : element_kind
        click ElementKindEnum href "../ElementKindEnum/"



      HookPayloadSpec : hook_type





        HookPayloadSpec --> "*" HookTypeEnum : hook_type
        click HookTypeEnum href "../HookTypeEnum/"



      HookPayloadSpec : id

      HookPayloadSpec : lifecycle_role

      HookPayloadSpec : module_path

      HookPayloadSpec : name

      HookPayloadSpec : package_kind





        HookPayloadSpec --> "0..1" PackageKindEnum : package_kind
        click PackageKindEnum href "../PackageKindEnum/"



      HookPayloadSpec : source_file

      HookPayloadSpec : tags

Inheritance

Slots

Name Cardinality and Range Description Inheritance
hook_type *
HookTypeEnum		 Slot describing the hook type direct
lifecycle_role 0..1
String		 Slot describing the lifecycle role direct
id 1
Uriorcurie		 Stable identifier for a schema element NamedElement
name 1
String		 Human-readable name NamedElement
description 0..1
String		 Narrative description of the element NamedElement
module_path 0..1
PythonDottedPath		 Python module path where this element is defined NamedElement
source_file 0..1
RepositoryRelativePath		 Source file relative to repository root NamedElement
package_kind 0..1
PackageKindEnum		 Package bucket NamedElement
element_kind 0..1
ElementKindEnum		 Kind of Python declaration NamedElement
coverage_scope *
CoverageScopeEnum		 Where this element surfaces (source/API/CLI/example/test) NamedElement
tags *
String		 Free-form classification tags NamedElement

Usages

used by used in type used
PluginSpec payload_model range HookPayloadSpec

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self mellea:HookPayloadSpec
native mellea:HookPayloadSpec
related nexus:Fact, attack:DataComponent, gist_linkml:ContentExpression, iso27001:InformationSecurityEvent, mcp:MetaObject, spdx:Annotation

LinkML Source

Direct

name: HookPayloadSpec
description: Specification of a hook payload model.
in_subset:
- observability
from_schema: https://w3id.org/lmodel/mellea
related_mappings:
- nexus:Fact
- attack:DataComponent
- gist_linkml:ContentExpression
- iso27001:InformationSecurityEvent
- mcp:MetaObject
- spdx:Annotation
is_a: ModelElement
slots:
- hook_type
- lifecycle_role

Induced

name: HookPayloadSpec
description: Specification of a hook payload model.
in_subset:
- observability
from_schema: https://w3id.org/lmodel/mellea
related_mappings:
- nexus:Fact
- attack:DataComponent
- gist_linkml:ContentExpression
- iso27001:InformationSecurityEvent
- mcp:MetaObject
- spdx:Annotation
is_a: ModelElement
attributes:
  hook_type:
    name: hook_type
    description: Slot describing the hook type.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - PluginSpec
    - HookPayloadSpec
    range: HookTypeEnum
    multivalued: true
  lifecycle_role:
    name: lifecycle_role
    description: Slot describing the lifecycle role.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - HookPayloadSpec
    - MethodSpec
    range: string
  id:
    name: id
    description: Stable identifier for a schema element.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: uriorcurie
    required: true
  name:
    name: name
    description: Human-readable name.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    slot_uri: schema:name
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: string
    required: true
  description:
    name: description
    description: Narrative description of the element.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    slot_uri: schema:description
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: string
  module_path:
    name: module_path
    description: Python module path where this element is defined.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: PythonDottedPath
  source_file:
    name: source_file
    description: Source file relative to repository root.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: RepositoryRelativePath
  package_kind:
    name: package_kind
    description: Package bucket.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: PackageKindEnum
  element_kind:
    name: element_kind
    description: Kind of Python declaration.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: ElementKindEnum
  coverage_scope:
    name: coverage_scope
    description: Where this element surfaces (source/API/CLI/example/test).
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: CoverageScopeEnum
    multivalued: true
  tags:
    name: tags
    description: Free-form classification tags.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: HookPayloadSpec
    domain_of:
    - NamedElement
    range: string
    multivalued: true