Skip to content

Class: ApiModelSpec

Specification of an HTTP API wire model.

URI: mellea:ApiModelSpec

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

      ApiModelSpec : coverage_scope





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



      ApiModelSpec : description

      ApiModelSpec : element_kind





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



      ApiModelSpec : has_field





        ApiModelSpec --> "*" ApiFieldSpec : has_field
        click ApiFieldSpec href "../ApiFieldSpec/"



      ApiModelSpec : id

      ApiModelSpec : module_path

      ApiModelSpec : name

      ApiModelSpec : openai_object_type

      ApiModelSpec : package_kind





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



      ApiModelSpec : request_or_response





        ApiModelSpec --> "0..1" RequestResponseEnum : request_or_response
        click RequestResponseEnum href "../RequestResponseEnum/"



      ApiModelSpec : source_file

      ApiModelSpec : tags

Inheritance

Slots

Name Cardinality and Range Description Inheritance
request_or_response 0..1
RequestResponseEnum
Slot describing the request or response direct
openai_object_type 0..1
String
Slot describing the openai object type direct
has_field *
ApiFieldSpec
Slot describing the has field 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
CliCommandSpec input_model range ApiModelSpec
CliCommandSpec output_model range ApiModelSpec

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self mellea:ApiModelSpec
native mellea:ApiModelSpec
related nexus:Input, mcp:JSONRPCRequest, mcp:JSONRPCResponse
close gist_linkml:Specification

LinkML Source

Direct

name: ApiModelSpec
description: Specification of an HTTP API wire model.
in_subset:
- interface_surface
from_schema: https://w3id.org/lmodel/mellea
close_mappings:
- gist_linkml:Specification
related_mappings:
- nexus:Input
- mcp:JSONRPCRequest
- mcp:JSONRPCResponse
is_a: ModelElement
slots:
- request_or_response
- openai_object_type
- has_field

Induced

name: ApiModelSpec
description: Specification of an HTTP API wire model.
in_subset:
- interface_surface
from_schema: https://w3id.org/lmodel/mellea
close_mappings:
- gist_linkml:Specification
related_mappings:
- nexus:Input
- mcp:JSONRPCRequest
- mcp:JSONRPCResponse
is_a: ModelElement
attributes:
  request_or_response:
    name: request_or_response
    description: Slot describing the request or response.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiModelSpec
    domain_of:
    - ApiModelSpec
    range: RequestResponseEnum
  openai_object_type:
    name: openai_object_type
    description: Slot describing the openai object type.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiModelSpec
    domain_of:
    - ApiModelSpec
    range: string
  has_field:
    name: has_field
    description: Slot describing the has field.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiModelSpec
    domain_of:
    - ApiModelSpec
    range: ApiFieldSpec
    multivalued: true
    inlined: true
    inlined_as_list: true
  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: ApiModelSpec
    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: ApiModelSpec
    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: ApiModelSpec
    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: ApiModelSpec
    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: ApiModelSpec
    domain_of:
    - NamedElement
    range: RepositoryRelativePath
  package_kind:
    name: package_kind
    description: Package bucket.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiModelSpec
    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: ApiModelSpec
    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: ApiModelSpec
    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: ApiModelSpec
    domain_of:
    - NamedElement
    range: string
    multivalued: true