Schema: robos:DocSection

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:DocSection in the documentation 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:

  • Universal Schema.org Class: https://schema.org/Article (100% interoperability with search engines, web indexers, and general AI reasoning)
  • Specialized Domain Standard: https://schema.org/Article (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/Article
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:DocSection, they MUST adhere to and base their output on this referred schema object and universal Schema.org parent class, extending it with RobOS SDLC properties.

Entity Relationship & Schema Context

Doc Section robos:DocSection

Governed by W3C SHACL shape urn:robos:shape:DocSectionShape within the Documentation & Diagrams (robos.docs) (robos.docs) package store.

dcterms:title robos:sectionId robos:docPage

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Documentation Section must have a title.
robos:sectionId Doc Section Anchor 1..* xsd:string Documentation Section must specify section identifier or anchor.
robos:docPage Parent Documentation Page 1..* URI (robos:DocumentationPage) Documentation Section must link to parent documentation page.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:documentation:doc-section-sample",
  "@type": [
    "robos:DocSection",
    "schema:Article",
    "oslc:Resource"
  ],
  "dcterms:title": "Sample Doc Section",
  "dcterms:description": "Canonical reference instance for robos:DocSection.",
  "robos:package": "documentation",
  "robos:namespace": "robos.docs",
  "robos:sectionId": "overview",
  "robos:docPage": "urn:robos:doc:architecture-overview",
  "robos:schemaOrgType": "https://schema.org/Article",
  "robos:domainStandard": "https://schema.org/Article",
  "robos:refersFrom": "https://schema.org/Article"
}

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:documentation:doc-section-sample",
        "@type": [
            "robos:DocSection",
            "schema:Article",
            "oslc:Resource"
        ],
        "dcterms:title": "Sample Doc Section",
        "dcterms:description": "Canonical reference instance for robos:DocSection.",
        "robos:package": "documentation",
        "robos:namespace": "robos.docs",
        "robos:sectionId": "overview",
        "robos:docPage": "urn:robos:doc:architecture-overview",
        "robos:schemaOrgType": "https://schema.org/Article",
        "robos:domainStandard": "https://schema.org/Article",
        "robos:refersFrom": "https://schema.org/Article"
    }
  ],
}));

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