Class: ApiFieldSpec

Specification of a single field in an API model.

 classDiagram
    class ApiFieldSpec
    click ApiFieldSpec href "../ApiFieldSpec/"
      NamedElement <|-- ApiFieldSpec
        click NamedElement href "../NamedElement/"

      ApiFieldSpec : allows_null

      ApiFieldSpec : coverage_scope





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



      ApiFieldSpec : description

      ApiFieldSpec : element_kind





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



      ApiFieldSpec : field_name

      ApiFieldSpec : field_type

      ApiFieldSpec : id

      ApiFieldSpec : module_path

      ApiFieldSpec : name

      ApiFieldSpec : package_kind





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



      ApiFieldSpec : required_field

      ApiFieldSpec : source_file

      ApiFieldSpec : tags

Inheritance

NamedElement
- ApiFieldSpec

Slots

Name	Cardinality and Range	Description	Inheritance
field_name	0..1 String	Slot describing the field name	direct
field_type	0..1 String	Slot describing the field type	direct
required_field	0..1 Boolean	Slot describing the required field	direct
allows_null	0..1 Boolean	Slot describing the allows null	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
ApiModelSpec	has_field	range	ApiFieldSpec

In Subsets

InterfaceSurface

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/lmodel/mellea

Mappings

Mapping Type	Mapped Value
self	mellea:ApiFieldSpec
native	mellea:ApiFieldSpec
related	spdx:DictionaryEntry
close	gist_linkml:Component

LinkML Source

Direct

name: ApiFieldSpec
description: Specification of a single field in an API model.
in_subset:
- interface_surface
from_schema: https://w3id.org/lmodel/mellea
close_mappings:
- gist_linkml:Component
related_mappings:
- spdx:DictionaryEntry
is_a: NamedElement
slots:
- field_name
- field_type
- required_field
- allows_null

Induced

name: ApiFieldSpec
description: Specification of a single field in an API model.
in_subset:
- interface_surface
from_schema: https://w3id.org/lmodel/mellea
close_mappings:
- gist_linkml:Component
related_mappings:
- spdx:DictionaryEntry
is_a: NamedElement
attributes:
  field_name:
    name: field_name
    description: Slot describing the field name.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiFieldSpec
    domain_of:
    - ApiFieldSpec
    range: string
  field_type:
    name: field_type
    description: Slot describing the field type.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiFieldSpec
    domain_of:
    - ApiFieldSpec
    range: string
  required_field:
    name: required_field
    description: Slot describing the required field.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiFieldSpec
    domain_of:
    - ApiFieldSpec
    range: boolean
  allows_null:
    name: allows_null
    description: Slot describing the allows null.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiFieldSpec
    domain_of:
    - ApiFieldSpec
    range: boolean
  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: ApiFieldSpec
    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: ApiFieldSpec
    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: ApiFieldSpec
    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: ApiFieldSpec
    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: ApiFieldSpec
    domain_of:
    - NamedElement
    range: RepositoryRelativePath
  package_kind:
    name: package_kind
    description: Package bucket.
    from_schema: https://w3id.org/lmodel/mellea
    rank: 1000
    owner: ApiFieldSpec
    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: ApiFieldSpec
    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: ApiFieldSpec
    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: ApiFieldSpec
    domain_of:
    - NamedElement
    range: string
    multivalued: true