Schema: robos:DocString

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

Doc String robos:DocString

Governed by W3C SHACL shape urn:robos:shape:DocStringShape within the Testing, Quality & BDD (robos.testing) (robos.testing) package store.

robos:content robos:step

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
robos:content content 1..* xsd:string DocString must define text content.
robos:step step 1..* xsd:string DocString must link to parent scenario step.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:docstring:checkout-payload",
  "@type": [
    "robos:DocString",
    "schema:Text"
  ],
  "robos:step": "urn:robos:step:checkout-payload-docstring",
  "robos:content": "{\n  \"cartId\": \"cart-9821\",\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\"\n}",
  "robos:contentType": "application/json",
  "robos:package": "testing",
  "robos:namespace": "robos.testing",
  "robos:refersFrom": "https://cucumber.io/docs/gherkin/reference/#doc-strings",
  "robos:schemaOrgType": "https://schema.org/Text",
  "robos:domainStandard": "https://cucumber.io/docs/gherkin/reference/#doc-strings"
}

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:docstring:checkout-payload",
        "@type": [
            "robos:DocString",
            "schema:Text"
        ],
        "robos:step": "urn:robos:step:checkout-payload-docstring",
        "robos:content": "{\n  \"cartId\": \"cart-9821\",\n  \"currency\": \"USD\",\n  \"paymentMethod\": \"credit_card\"\n}",
        "robos:contentType": "application/json",
        "robos:package": "testing",
        "robos:namespace": "robos.testing",
        "robos:refersFrom": "https://cucumber.io/docs/gherkin/reference/#doc-strings",
        "robos:schemaOrgType": "https://schema.org/Text",
        "robos:domainStandard": "https://cucumber.io/docs/gherkin/reference/#doc-strings"
    }
  ],
}));

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