Class: ProgrammingInterface
A product that is a programming interface (API) to a resource.
classDiagram
class ProgrammingInterface
click ProgrammingInterface href "ProgrammingInterface/.html"
Product <|-- ProgrammingInterface
click Product href "Product/.html"
ProgrammingInterface : category
ProgrammingInterface : collection
ProgrammingInterface --> "*" CollectionEnum : collection
click CollectionEnum href "CollectionEnum/.html"
ProgrammingInterface : compatibility
ProgrammingInterface --> "*" StandardCompatibility : compatibility
click StandardCompatibility href "StandardCompatibility/.html"
ProgrammingInterface : compression
ProgrammingInterface --> "0..1" CompressionEnum : compression
click CompressionEnum href "CompressionEnum/.html"
ProgrammingInterface : connection_url
ProgrammingInterface : contacts
ProgrammingInterface --> "*" Contact : contacts
click Contact href "Contact/.html"
ProgrammingInterface : creation_date
ProgrammingInterface : curators
ProgrammingInterface --> "*" Contact : curators
click Contact href "Contact/.html"
ProgrammingInterface : description
ProgrammingInterface : dump_format
ProgrammingInterface --> "0..1" DumpFormatEnum : dump_format
click DumpFormatEnum href "DumpFormatEnum/.html"
ProgrammingInterface : format
ProgrammingInterface --> "0..1" FormatEnum : format
click FormatEnum href "FormatEnum/.html"
ProgrammingInterface : id
ProgrammingInterface : infores_id
ProgrammingInterface : is_neo4j
ProgrammingInterface : is_public
ProgrammingInterface : last_modified_date
ProgrammingInterface : latest_version
ProgrammingInterface : layout
ProgrammingInterface : license
ProgrammingInterface --> "0..1" License : license
click License href "License/.html"
ProgrammingInterface : name
ProgrammingInterface : original_source
ProgrammingInterface --> "*" SourceAssociation : original_source
click SourceAssociation href "SourceAssociation/.html"
ProgrammingInterface : produced_by
ProgrammingInterface --> "*" ProcessProduct : produced_by
click ProcessProduct href "ProcessProduct/.html"
ProgrammingInterface : product_file_size
ProgrammingInterface : product_url
ProgrammingInterface : repository
ProgrammingInterface : secondary_source
ProgrammingInterface --> "*" SourceAssociation : secondary_source
click SourceAssociation href "SourceAssociation/.html"
ProgrammingInterface : tags
ProgrammingInterface --> "*" TagEnum : tags
click TagEnum href "TagEnum/.html"
ProgrammingInterface : versions
ProgrammingInterface : warnings
Inheritance
- NamedThing
- Product
- ProgrammingInterface
- Product
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| is_public | 0..1 Boolean |
Whether the API is publicly accessible, or requires only publicly provided cr… | direct |
| is_neo4j | 0..1 Boolean |
Whether the API is for a Neo4j database | direct |
| connection_url | 0..1 Uriorcurie |
A URL specific to the product | direct |
| name | 1 String |
The human-readable name of the product | Product |
| description | 0..1 String |
A description of the product | Product |
| original_source | * SourceAssociation |
The original source(s) of the product, with the provenance relation describin… | Product |
| secondary_source | * SourceAssociation |
The source(s) of the product, other than its original source, with the proven… | Product |
| product_url | 0..1 Uriorcurie |
The URL of the product | Product |
| product_file_size | 0..1 Integer |
The size of the product file, in bytes | Product |
| produced_by | * ProcessProduct |
The process(es) that produced the product, referred to by the identifier of e… | Product |
| repository | 0..1 Uriorcurie |
A main version control repository for the product | Product |
| license | 0..1 License |
The license of the product | Product |
| compression | 0..1 CompressionEnum |
The type of compression used with the product | Product |
| contacts | * Contact |
The contact points for the product | Product |
| curators | * Contact |
The curator(s) of the product | Product |
| tags | * TagEnum |
Tags associated with the product | Product |
| infores_id | 0..1 String |
The Infores ID of the product | Product |
| compatibility | * StandardCompatibility |
A list of standards that the product conforms to | Product |
| format | 0..1 FormatEnum |
The format or serialization of the product | Product |
| dump_format | 0..1 DumpFormatEnum |
The format of a dump of the product as a file | Product |
| versions | * String |
A list of names of versions of the product | Product |
| latest_version | 0..1 String |
The latest version of the product, or the most recent version curated in the … | Product |
| id | 1 String |
The identifier of an entity | NamedThing |
| category | 0..1 CategoryType |
The category of the entity | NamedThing |
| warnings | * String |
A list of warnings about an item to be displayed in the interface | NamedThing |
| collection | * CollectionEnum |
A collection of entries in the registry | NamedThing |
| layout | 0..1 String |
The layout of the entity | NamedThing |
| creation_date | 0..1 Datetime |
The date the entry was created | NamedThing |
| last_modified_date | 0..1 Datetime |
The date the entry was last modified | NamedThing |
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | kgr:ProgrammingInterface |
| native | kgr:ProgrammingInterface |
LinkML Source
Direct
```yaml
name: ProgrammingInterface
description: A product that is a programming interface (API) to a resource.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
is_a: Product
attributes:
is_public:
name: is_public
description: Whether the API is publicly accessible, or requires only publicly
provided credentials.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
domain_of:
- ProgrammingInterface
range: boolean
is_neo4j:
name: is_neo4j
description: Whether the API is for a Neo4j database.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
domain_of:
- ProgrammingInterface
range: boolean
connection_url:
name: connection_url
description: A URL specific to the product. For example, a URL to a specific Neo4j
database. Do not include a prefix.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
domain_of:
- ProgrammingInterface
range: uriorcurie
```
Induced
```yaml
name: ProgrammingInterface
description: A product that is a programming interface (API) to a resource.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
is_a: Product
attributes:
is_public:
name: is_public
description: Whether the API is publicly accessible, or requires only publicly
provided credentials.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: is_public
owner: ProgrammingInterface
domain_of:
- ProgrammingInterface
range: boolean
is_neo4j:
name: is_neo4j
description: Whether the API is for a Neo4j database.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: is_neo4j
owner: ProgrammingInterface
domain_of:
- ProgrammingInterface
range: boolean
connection_url:
name: connection_url
description: A URL specific to the product. For example, a URL to a specific Neo4j
database. Do not include a prefix.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: connection_url
owner: ProgrammingInterface
domain_of:
- ProgrammingInterface
range: uriorcurie
name:
name: name
description: The human-readable name of the product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: name
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: string
required: true
description:
name: description
description: A description of the product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: description
owner: ProgrammingInterface
domain_of:
- Resource
- Product
- Organization
- Usage
range: string
original_source:
name: original_source
description: The original source(s) of the product, with the provenance relation
describing how the product relates to each source. This may be the parent resource
or another resource. This may also be a specific product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: original_source
owner: ProgrammingInterface
domain_of:
- Product
range: SourceAssociation
multivalued: true
inlined: true
inlined_as_list: true
secondary_source:
name: secondary_source
description: The source(s) of the product, other than its original source, with
the provenance relation describing how the product relates to each source. This
may be an Aggregator or another resource. This may also be a specific product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: secondary_source
owner: ProgrammingInterface
domain_of:
- Product
range: SourceAssociation
multivalued: true
inlined: true
inlined_as_list: true
product_url:
name: product_url
description: The URL of the product. This may be a link to download a specific
file, a base URL to an API, or a link to a graphical interface.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: product_url
owner: ProgrammingInterface
domain_of:
- Product
range: uriorcurie
product_file_size:
name: product_file_size
description: The size of the product file, in bytes. The build process will attempt
to determine this based on the file header and populate the metadata where possible.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: product_file_size
owner: ProgrammingInterface
domain_of:
- Product
range: integer
produced_by:
name: produced_by
description: The process(es) that produced the product, referred to by the identifier
of each process.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: produced_by
owner: ProgrammingInterface
domain_of:
- Product
range: ProcessProduct
multivalued: true
repository:
name: repository
description: A main version control repository for the product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: repository
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: uriorcurie
license:
name: license
description: The license of the product. This may differ from that of the parent
resource.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: license
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: License
inlined: true
compression:
name: compression
description: The type of compression used with the product. If this is not specified,
it is assumed to be uncompressed.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: compression
owner: ProgrammingInterface
domain_of:
- Product
range: CompressionEnum
contacts:
name: contacts
description: The contact points for the product. May be an individual or organization.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: contacts
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: Contact
multivalued: true
curators:
name: curators
description: The curator(s) of the product. May be an individual or organization.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: curators
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: Contact
multivalued: true
tags:
name: tags
description: Tags associated with the product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: tags
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: TagEnum
multivalued: true
infores_id:
name: infores_id
description: The Infores ID of the product. Do not include the 'infores' prefix.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
alias: infores_id
owner: ProgrammingInterface
domain_of:
- Resource
- Product
range: string
compatibility:
name: compatibility
description: A list of standards that the product conforms to. This is not the
same as its serialization/format.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: compatibility
owner: ProgrammingInterface
domain_of:
- Product
range: StandardCompatibility
multivalued: true
inlined: true
format:
name: format
description: The format or serialization of the product. Generally corresponds
to the file extension.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: format
owner: ProgrammingInterface
domain_of:
- Product
range: FormatEnum
dump_format:
name: dump_format
description: The format of a dump of the product as a file. Note the product may
also be compressed.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: dump_format
owner: ProgrammingInterface
domain_of:
- Product
range: DumpFormatEnum
versions:
name: versions
description: A list of names of versions of the product.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
exact_mappings:
- schema:version
- dcterms:hasVersion
rank: 1000
alias: versions
owner: ProgrammingInterface
domain_of:
- Product
range: string
multivalued: true
latest_version:
name: latest_version
description: The latest version of the product, or the most recent version curated
in the registry. If the product is available at a permanent link, this may be
something like "latest".
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: latest_version
owner: ProgrammingInterface
domain_of:
- Product
range: string
id:
name: id
description: The identifier of an entity. This is used to identify it within the
registry.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
slot_uri: dcterms:identifier
identifier: true
alias: id
owner: ProgrammingInterface
domain_of:
- NamedThing
- Organization
range: string
required: true
category:
name: category
description: The category of the entity. This should be identical to its class
name.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
is_a: type
domain: NamedThing
alias: category
owner: ProgrammingInterface
domain_of:
- NamedThing
- Contact
range: category_type
warnings:
name: warnings
description: A list of warnings about an item to be displayed in the interface.
These should primarily warn users about unavailable resources, broken links,
and other obstacles to using a resource.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: warnings
owner: ProgrammingInterface
domain_of:
- NamedThing
range: string
multivalued: true
inlined: true
inlined_as_list: true
collection:
name: collection
description: A collection of entries in the registry. This is used to group related
entries together. This is multivalued to allow for multiple collections.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: collection
owner: ProgrammingInterface
domain_of:
- NamedThing
range: CollectionEnum
multivalued: true
layout:
name: layout
description: The layout of the entity. This is used to determine how to display
the entity in the web interface. For resources, this is generally 'resource_detail'.
For products, this is generally 'product_detail'. If a value for this slot is
not specified, pages won't contain anything from their header metadata.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: layout
owner: ProgrammingInterface
domain_of:
- NamedThing
- Organization
range: string
creation_date:
name: creation_date
description: The date the entry was created. This is used to determine the age
of the entity. It should be in ISO 8601 format, e.g., 2024-02-12T00:00:00Z.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: creation_date
owner: ProgrammingInterface
domain_of:
- NamedThing
- Organization
range: datetime
last_modified_date:
name: last_modified_date
description: The date the entry was last modified. It should be in ISO 8601 format,
e.g., 2024-02-12T00:00:00Z.
from_schema: https://w3id.org/knowledge-graph-hub/kg_registry_schema
rank: 1000
alias: last_modified_date
owner: ProgrammingInterface
domain_of:
- NamedThing
- Organization
range: datetime
```