Schema: robos:MessageTopic

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:MessageTopic in the core-platform package store.

Table of contents

  1. Specification Metadata
  2. Upstream Schema Basis (Refers From) & Global Standards Provenance
  3. Entity Relationship & Schema Context
  4. Property Constraints & SHACL Rules
  5. Canonical OSLC JSON-LD Example
  6. Programmatic SHACL Validation

Specification Metadata


Upstream Schema Basis (Refers From) & Global Standards Provenance

This RobOS schema is modeled after and directly aligns with two levels of global standards:


Entity Relationship & Schema Context

Message Topic robos:MessageTopic

Governed by W3C SHACL shape urn:robos:shape:MessageTopicShape within the Core Platform (robos.core) (robos.platform) package store.

dcterms:title robos:topicName robos:broker

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Message Topic must have a title.
robos:topicName Topic / Queue Name 1..* xsd:string Message Topic must specify topic name.
robos:broker Parent Message Broker 1..* URI (robos:MessageBroker) Message Topic must link to parent message broker.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:core-platform:message-topic-sample",
  "@type": [
    "robos:MessageTopic",
    "robos:MessageQueue",
    "robos:EventTopic",
    "schema:BroadcastChannel",
    "oslc:Resource"
  ],
  "dcterms:title": "Sample Message Topic",
  "dcterms:description": "Canonical reference instance for robos:MessageTopic.",
  "robos:package": "core-platform",
  "robos:namespace": "robos.platform",
  "robos:topicName": "sample-events-v1",
  "robos:broker": "urn:robos:broker:acme-kafka",
  "robos:schemaOrgType": "https://schema.org/BroadcastChannel",
  "robos:domainStandard": "https://kafka.apache.org/documentation/#intro_concepts_and_terms",
  "robos:refersFrom": "https://schema.org/BroadcastChannel"
}

Programmatic SHACL Validation

const { SHACLValidator } = require('/usr/local/share/robos/robos-graph/lib/shacl-validator');
const { OSLCGraphParser, OSLC_CONTEXT } = require('/usr/local/share/robos/robos-graph/lib/oslc-parser');

const validator = new SHACLValidator();
const result = validator.validateGraph(new OSLCGraphParser({
  "@context": OSLC_CONTEXT,
  "robos:nodes": [
    {
        "@id": "urn:robos:core-platform:message-topic-sample",
        "@type": [
            "robos:MessageTopic",
            "robos:MessageQueue",
            "robos:EventTopic",
            "schema:BroadcastChannel",
            "oslc:Resource"
        ],
        "dcterms:title": "Sample Message Topic",
        "dcterms:description": "Canonical reference instance for robos:MessageTopic.",
        "robos:package": "core-platform",
        "robos:namespace": "robos.platform",
        "robos:topicName": "sample-events-v1",
        "robos:broker": "urn:robos:broker:acme-kafka",
        "robos:schemaOrgType": "https://schema.org/BroadcastChannel",
        "robos:domainStandard": "https://kafka.apache.org/documentation/#intro_concepts_and_terms",
        "robos:refersFrom": "https://schema.org/BroadcastChannel"
    }
  ],
}));

console.log("Conforms:", result.conforms); // Expected: true