Schema: robos:InteractiveWalkthrough

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:InteractiveWalkthrough 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/Guide (100% interoperability with search engines, web indexers, and general AI reasoning)
  • Specialized Domain Standard: https://schema.org/Guide (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/Guide
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:InteractiveWalkthrough, 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

Interactive Walkthrough robos:InteractiveWalkthrough

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

dcterms:title robos:slug robos:targetApp

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Interactive Walkthrough must have a title.
robos:slug URL / Document Slug 1..* xsd:string Interactive Walkthrough must declare a unique slug.
robos:targetApp Target RobOS Application 1..* xsd:string Interactive Walkthrough must link to a target RobOS application or component.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:walkthrough:remote-execution",
  "@type": [
    "oslc_am:Resource",
    "robos:InteractiveWalkthrough",
    "schema:Guide"
  ],
  "dcterms:title": "Remote Execution Studio Interactive Guided Tour",
  "robos:slug": "remote-execution-studio-tour",
  "dcterms:description": "Guided developer walkthrough on inspecting REAPI distributed build clusters, Bazel configurations, and cache metrics.",
  "robos:targetApp": "remote-execution-studio",
  "robos:walkthroughPath": "docs/big-wins/remote-execution-studio.md",
  "robos:videoPath": "assets/videos/walkthroughs/re-studio-demo.mp4",
  "robos:stepsCount": 7,
  "robos:package": "documentation",
  "robos:namespace": "robos.docs",
  "robos:schemaOrgType": "https://schema.org/Guide",
  "robos:domainStandard": "https://schema.org/Guide"
}

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:walkthrough:remote-execution",
        "@type": [
            "oslc_am:Resource",
            "robos:InteractiveWalkthrough",
            "schema:Guide"
        ],
        "dcterms:title": "Remote Execution Studio Interactive Guided Tour",
        "robos:slug": "remote-execution-studio-tour",
        "dcterms:description": "Guided developer walkthrough on inspecting REAPI distributed build clusters, Bazel configurations, and cache metrics.",
        "robos:targetApp": "remote-execution-studio",
        "robos:walkthroughPath": "docs/big-wins/remote-execution-studio.md",
        "robos:videoPath": "assets/videos/walkthroughs/re-studio-demo.mp4",
        "robos:stepsCount": 7,
        "robos:package": "documentation",
        "robos:namespace": "robos.docs",
        "robos:schemaOrgType": "https://schema.org/Guide",
        "robos:domainStandard": "https://schema.org/Guide"
    }
  ],
}));

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