Schema: robos:Microservice

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

Microservice robos:Microservice

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

robos:repository robos:ownerTeam dcterms:title

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
robos:repository Git Repository 1..1 xsd:string Microservice must define exactly one repository.
robos:ownerTeam Owner Team 1..* URI (robos:Team) Microservice must define an owner team.
dcterms:title Title / Display Name 1..* xsd:string Microservice must have a title.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:service:billing-api",
  "@type": [
    "oslc_am:Resource",
    "robos:Microservice",
    "schema:SoftwareApplication"
  ],
  "dcterms:title": "Billing API Service",
  "robos:technology": "Go 1.22 / Gin",
  "robos:repository": "github.com/acme/billing-api",
  "robos:package": "services",
  "robos:namespace": "robos.services",
  "robos:ownerTeam": "urn:robos:team:order-processing",
  "robos:usesDatabase": "urn:robos:db:acme-orders-postgres",
  "robos:publishesTo": "urn:robos:broker:acme-event-kafka",
  "robos:hasPipeline": "urn:robos:pipeline:checkout-service-ci",
  "robos:deployedTo": "urn:robos:gitops:checkout-service-argocd",
  "robos:implementsContract": [
    "urn:robos:contract:orders-grpc"
  ],
  "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
  "robos:domainStandard": "https://w3id.org/c4/Container"
}

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:service:billing-api",
        "@type": [
            "oslc_am:Resource",
            "robos:Microservice",
            "schema:SoftwareApplication"
        ],
        "dcterms:title": "Billing API Service",
        "robos:technology": "Go 1.22 / Gin",
        "robos:repository": "github.com/acme/billing-api",
        "robos:package": "services",
        "robos:namespace": "robos.services",
        "robos:ownerTeam": "urn:robos:team:order-processing",
        "robos:usesDatabase": "urn:robos:db:acme-orders-postgres",
        "robos:publishesTo": "urn:robos:broker:acme-event-kafka",
        "robos:hasPipeline": "urn:robos:pipeline:checkout-service-ci",
        "robos:deployedTo": "urn:robos:gitops:checkout-service-argocd",
        "robos:implementsContract": [
            "urn:robos:contract:orders-grpc"
        ],
        "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
        "robos:domainStandard": "https://w3id.org/c4/Container"
    }
  ],
}));

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