Schema: robos:ConsoleApp

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:ConsoleApp in the applications 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://schema.org/SoftwareApplication (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/SoftwareApplication
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:ConsoleApp, 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

Console App robos:ConsoleApp

Governed by W3C SHACL shape urn:robos:shape:ConsoleAppShape within the Applications (robos.apps) (robos.apps) package store.

dcterms:title robos:repository robos:technology robos:cliCommand

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Console App must have a title.
robos:repository Git Repository 1..* xsd:string Console App must define a repository.
robos:technology Technology Stack 1..* xsd:string Console App must specify technology stack.
robos:cliCommand CLI Binary Command 1..* xsd:string Console App must declare executable CLI command name.

Canonical OSLC JSON-LD Example 

{
  "@id": "urn:robos:console-app:rest-client",
  "@type": [
    "robos:ConsoleApp",
    "oslc_am:Resource",
    "c4:Container",
    "schema:SoftwareApplication"
  ],
  "dcterms:title": "Rest Client CLI",
  "dcterms:description": "Command-line terminal tool providing automated workflows and administration for Rest Client.",
  "robos:repository": "github.com/acme/rest-client",
  "robos:technology": "Node.js 20 / TypeScript",
  "robos:cliCommand": "rest-client",
  "robos:subcommands": [
    {
      "name": "init",
      "description": "Initialize local workspace and credentials"
    },
    {
      "name": "deploy",
      "description": "Deploy artifacts to targeted cluster or environment"
    },
    {
      "name": "status",
      "description": "Inspect health and operational status"
    },
    {
      "name": "logs",
      "description": "Stream aggregated logs with live tail"
    },
    {
      "name": "rollback",
      "description": "Revert to previous revision"
    }
  ],
  "robos:globalFlags": [
    {
      "flag": "--verbose, -v",
      "description": "Enable verbose debug tracing"
    },
    {
      "flag": "--config, -c",
      "description": "Path to configuration manifest"
    },
    {
      "flag": "--output, -o",
      "description": "Output format (json, yaml, text)"
    }
  ],
  "robos:ownerTeam": "urn:robos:team:core-platform",
  "robos:hasProject": "urn:robos:project:enterprise-core",
  "robos:inOrganization": "urn:robos:git-org:acme",
  "robos:localPath": "/home/ndipiazza/source/robos/packages/rest-client",
  "robos:package": "applications",
  "robos:namespace": "robos.applications",
  "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
  "robos:domainStandard": "https://schema.org/SoftwareApplication"
}

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:console-app:rest-client",
        "@type": [
            "robos:ConsoleApp",
            "oslc_am:Resource",
            "c4:Container",
            "schema:SoftwareApplication"
        ],
        "dcterms:title": "Rest Client CLI",
        "dcterms:description": "Command-line terminal tool providing automated workflows and administration for Rest Client.",
        "robos:repository": "github.com/acme/rest-client",
        "robos:technology": "Node.js 20 / TypeScript",
        "robos:cliCommand": "rest-client",
        "robos:subcommands": [
            {
                "name": "init",
                "description": "Initialize local workspace and credentials"
            },
            {
                "name": "deploy",
                "description": "Deploy artifacts to targeted cluster or environment"
            },
            {
                "name": "status",
                "description": "Inspect health and operational status"
            },
            {
                "name": "logs",
                "description": "Stream aggregated logs with live tail"
            },
            {
                "name": "rollback",
                "description": "Revert to previous revision"
            }
        ],
        "robos:globalFlags": [
            {
                "flag": "--verbose, -v",
                "description": "Enable verbose debug tracing"
            },
            {
                "flag": "--config, -c",
                "description": "Path to configuration manifest"
            },
            {
                "flag": "--output, -o",
                "description": "Output format (json, yaml, text)"
            }
        ],
        "robos:ownerTeam": "urn:robos:team:core-platform",
        "robos:hasProject": "urn:robos:project:enterprise-core",
        "robos:inOrganization": "urn:robos:git-org:acme",
        "robos:localPath": "/home/ndipiazza/source/robos/packages/rest-client",
        "robos:package": "applications",
        "robos:namespace": "robos.applications",
        "robos:schemaOrgType": "https://schema.org/SoftwareApplication",
        "robos:domainStandard": "https://schema.org/SoftwareApplication"
    }
  ],
}));

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