Skip to content

Class: InterfaceDefinition

Modular interface definition referencing an external schema.

URI: calm:InterfaceDefinition

 classDiagram
    class InterfaceDefinition
    click InterfaceDefinition href "../InterfaceDefinition/"
      InterfaceDefinition : config

      InterfaceDefinition : definition_url

      InterfaceDefinition : unique_id

Class Properties

Property Value
Class URI calm:InterfaceDefinition

Slots

Name Cardinality and Range Description Inheritance
unique_id 1
String
Stable opaque identifier used to cross-link CALM elements direct
definition_url 1
String
URI of the external schema this interface configuration conforms to direct
config 1
Metadata
Inline configuration of how the control requirement schema is met direct

Usages

used by used in type used
Node interfaces range InterfaceDefinition
NodeInterface interfaces range InterfaceDefinition
NodeMoment interfaces range InterfaceDefinition

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self calm:InterfaceDefinition
native calm:InterfaceDefinition
related gist:Network
close ocsf:NetworkInterface

LinkML Source

Direct

name: InterfaceDefinition
description: Modular interface definition referencing an external schema.
in_subset:
- interface_defs
from_schema: https://w3id.org/lmodel/calm
close_mappings:
- ocsf:NetworkInterface
related_mappings:
- gist:Network
slots:
- unique_id
- definition_url
- config
slot_usage:
  config:
    name: config
    required: true
class_uri: calm:InterfaceDefinition

Induced

name: InterfaceDefinition
description: Modular interface definition referencing an external schema.
in_subset:
- interface_defs
from_schema: https://w3id.org/lmodel/calm
close_mappings:
- ocsf:NetworkInterface
related_mappings:
- gist:Network
slot_usage:
  config:
    name: config
    required: true
attributes:
  unique_id:
    name: unique_id
    description: Stable opaque identifier used to cross-link CALM elements.
    from_schema: https://w3id.org/lmodel/calm
    aliases:
    - unique-id
    rank: 1000
    slot_uri: schema:identifier
    identifier: true
    owner: InterfaceDefinition
    domain_of:
    - Node
    - Relationship
    - Decorator
    - Flow
    - InterfaceDefinition
    - InterfaceType
    range: string
    required: true
  definition_url:
    name: definition_url
    description: URI of the external schema this interface configuration conforms
      to
    from_schema: https://w3id.org/lmodel/calm
    aliases:
    - definition-url
    rank: 1000
    slot_uri: schema:url
    owner: InterfaceDefinition
    domain_of:
    - InterfaceDefinition
    range: string
    required: true
  config:
    name: config
    description: Inline configuration of how the control requirement schema is met
    from_schema: https://w3id.org/lmodel/calm
    rank: 1000
    owner: InterfaceDefinition
    domain_of:
    - ControlDetail
    - InterfaceDefinition
    range: Metadata
    required: true
class_uri: calm:InterfaceDefinition