Schema: robos:Contract

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

Contract robos:Contract

Governed by W3C SHACL shape urn:robos:shape:ContractShape within the Services & Contracts (robos.services) (robos.services) package store.

robos:specFile robos:protocol

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
robos:specFile Specification File 1..* xsd:string Contract must specify a specification file path.
robos:protocol Protocol / Standard 1..* xsd:string Contract must declare a protocol (OpenAPI, Pact, etc.).

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:contract:orders-grpc",
  "@type": [
    "robos:Contract",
    "robos:ProtobufContract",
    "robos:GRPCContract",
    "schema:DigitalDocument"
  ],
  "dcterms:title": "Acme Orders gRPC Protobuf Contract",
  "dcterms:description": "High-performance binary gRPC interface definition for transactional order lifecycle.",
  "robos:protocol": "grpc-protobuf",
  "robos:specFile": "proto/orders/v1/orders.proto",
  "robos:packageName": "acme.orders.v1",
  "robos:rpcMethods": [
    "CreateOrder",
    "GetOrderStatus",
    "CancelOrder",
    "StreamOrderEvents"
  ],
  "robos:package": "services",
  "robos:namespace": "robos.services",
  "robos:schemaOrgType": "https://schema.org/DigitalDocument",
  "robos:domainStandard": "http://open-services.net/ns/am#Resource"
}

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:contract:orders-grpc",
        "@type": [
            "robos:Contract",
            "robos:ProtobufContract",
            "robos:GRPCContract",
            "schema:DigitalDocument"
        ],
        "dcterms:title": "Acme Orders gRPC Protobuf Contract",
        "dcterms:description": "High-performance binary gRPC interface definition for transactional order lifecycle.",
        "robos:protocol": "grpc-protobuf",
        "robos:specFile": "proto/orders/v1/orders.proto",
        "robos:packageName": "acme.orders.v1",
        "robos:rpcMethods": [
            "CreateOrder",
            "GetOrderStatus",
            "CancelOrder",
            "StreamOrderEvents"
        ],
        "robos:package": "services",
        "robos:namespace": "robos.services",
        "robos:schemaOrgType": "https://schema.org/DigitalDocument",
        "robos:domainStandard": "http://open-services.net/ns/am#Resource"
    }
  ],
}));

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