Schema: robos:ReviewComment

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

Review Comment robos:ReviewComment

Governed by W3C SHACL shape urn:robos:shape:ReviewCommentShape within the Organization & Teams (robos.org) (robos.org) package store.

robos:content robos:pullRequest robos:filePath

RobOS classification: Projects & work items. These RobOS-owned codes use Schema.org CategoryCode vocabulary.

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Classification Constraint Rule / Validation Message
robos:content content 1..* xsd:string Testing & behavior Review comment must have content.
robos:pullRequest Pull Request 1..* URI (robos:PullRequest) Projects & work items, Source control & artifacts Review comment must link to parent pull request.
robos:filePath File Path 1..* xsd:string Projects & work items, Source control & artifacts Review comment must specify code file path.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:organization:review-comment-sample",
  "@type": [
    "robos:ReviewComment",
    "robos:CodeReviewComment",
    "schema:Comment",
    "oslc:Resource"
  ],
  "dcterms:title": "Sample Review Comment",
  "dcterms:description": "Canonical reference instance for robos:ReviewComment.",
  "robos:package": "organization",
  "robos:namespace": "robos.org",
  "robos:content": "sample docstring content",
  "robos:schemaOrgType": "https://schema.org/Comment",
  "robos:domainStandard": "http://open-services.net/ns/core#Comment",
  "robos:refersFrom": "https://schema.org/Comment"
}

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:organization:review-comment-sample",
        "@type": [
            "robos:ReviewComment",
            "robos:CodeReviewComment",
            "schema:Comment",
            "oslc:Resource"
        ],
        "dcterms:title": "Sample Review Comment",
        "dcterms:description": "Canonical reference instance for robos:ReviewComment.",
        "robos:package": "organization",
        "robos:namespace": "robos.org",
        "robos:content": "sample docstring content",
        "robos:schemaOrgType": "https://schema.org/Comment",
        "robos:domainStandard": "http://open-services.net/ns/core#Comment",
        "robos:refersFrom": "https://schema.org/Comment"
    }
  ],
}));

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