@documentation-robotics/cli 0.1.0

package/dist/schemas/bundled/06-api-layer.schema.json

@@ -0,0 +1,1743 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://example.com/schemas/06-api-layer.schema.json",
+  "title": "API Layer Layer Schema",
+  "description": "Defines REST API contracts using OpenAPI 3.0, specifying endpoints, operations, request/response schemas, and security requirements.",
+  "layerMetadata": {
+    "layerId": "06-api-layer",
+    "layerName": "API Layer",
+    "intraLayerRelationshipSupport": true,
+    "crossLayerRelationshipSupport": true,
+    "relationshipCatalogVersion": "2.1.0"
+  },
+  "intraLayerRelationships": {
+    "$comment": "Relationships between entities within this layer. References relationship-catalog.json by ID.",
+    "allowed": [
+      {
+        "relationshipTypeId": "composition",
+        "sourceTypes": ["Components", "OpenAPIDocument", "Operation"],
+        "targetTypes": ["Paths", "Responses", "Schema"],
+        "examples": [
+          {
+            "source": "OpenAPIDocument",
+            "target": "Paths",
+            "description": "API document composes paths object defining all endpoints",
+            "layer": "06-api"
+          },
+          {
+            "source": "Operation",
+            "target": "Responses",
+            "description": "API operation composes its responses object",
+            "layer": "06-api"
+          },
+          {
+            "source": "Components",
+            "target": "Schema",
+            "description": "Components object composes reusable schema definitions",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "aggregation",
+        "sourceTypes": ["OpenAPIDocument", "Operation"],
+        "targetTypes": ["SecurityRequirement", "Server", "Tag"],
+        "examples": [
+          {
+            "source": "OpenAPIDocument",
+            "target": "Server",
+            "description": "API document aggregates server definitions",
+            "layer": "06-api"
+          },
+          {
+            "source": "OpenAPIDocument",
+            "target": "Tag",
+            "description": "API document aggregates tag definitions for operation grouping",
+            "layer": "06-api"
+          },
+          {
+            "source": "Operation",
+            "target": "SecurityRequirement",
+            "description": "Operation aggregates its security requirements",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "specialization",
+        "sourceTypes": ["Schema"],
+        "targetTypes": ["Schema"],
+        "examples": [
+          {
+            "source": "Schema",
+            "target": "Schema",
+            "description": "API schema specializes another via allOf/oneOf/anyOf composition",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "realization",
+        "sourceTypes": ["ApplicationService", "Goal", "Outcome"],
+        "targetTypes": ["BusinessService", "Goal", "Value"],
+        "examples": [
+          {
+            "source": "Goal",
+            "target": "Value",
+            "description": "Goal realizes value for stakeholders",
+            "layer": "01-motivation"
+          },
+          {
+            "source": "Outcome",
+            "target": "Goal",
+            "description": "Outcome realizes achievement of goal",
+            "layer": "01-motivation"
+          },
+          {
+            "source": "ApplicationService",
+            "target": "BusinessService",
+            "description": "Application service realizes business service capability"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "association",
+        "sourceTypes": ["Contact", "License"],
+        "targetTypes": ["OpenAPIDocument"],
+        "examples": [
+          {
+            "source": "Contact",
+            "target": "OpenAPIDocument",
+            "description": "Contact is associated with API document for support",
+            "layer": "06-api"
+          },
+          {
+            "source": "License",
+            "target": "OpenAPIDocument",
+            "description": "License is associated with API document for legal terms",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "triggering",
+        "sourceTypes": ["Operation"],
+        "targetTypes": ["Callback"],
+        "examples": [
+          {
+            "source": "Operation",
+            "target": "Callback",
+            "description": "API operation triggers callback webhooks on events",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "serving",
+        "sourceTypes": ["SecurityScheme"],
+        "targetTypes": ["Operation"],
+        "examples": [
+          {
+            "source": "SecurityScheme",
+            "target": "Operation",
+            "description": "Security scheme serves operations requiring authentication",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "access",
+        "sourceTypes": ["BusinessProcess", "CoverageRequirement", "TestCaseSketch"],
+        "targetTypes": ["BusinessObject", "InputPartitionSelection", "InputSelection"],
+        "examples": [
+          {
+            "source": "BusinessProcess",
+            "target": "BusinessObject",
+            "description": "Business process accesses business object data"
+          },
+          {
+            "source": "TestCaseSketch",
+            "target": "InputSelection",
+            "description": "Test sketch accesses input selections for test execution",
+            "layer": "12-testing"
+          },
+          {
+            "source": "CoverageRequirement",
+            "target": "InputPartitionSelection",
+            "description": "Requirement accesses partition selections for coverage",
+            "layer": "12-testing"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "reference",
+        "sourceTypes": ["Link", "Operation", "Parameter", "Schema"],
+        "targetTypes": ["Operation", "Schema", "Tag"],
+        "examples": [
+          {
+            "source": "Schema",
+            "target": "Schema",
+            "description": "API schema references another schema via $ref",
+            "layer": "06-api"
+          },
+          {
+            "source": "Parameter",
+            "target": "Schema",
+            "description": "Parameter references a schema for its data type",
+            "layer": "06-api"
+          },
+          {
+            "source": "Link",
+            "target": "Operation",
+            "description": "Link references target operation via operationId for HATEOAS",
+            "layer": "06-api"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "depends-on",
+        "sourceTypes": ["ApplicationService", "TestCaseSketch"],
+        "targetTypes": ["ContextVariation", "DataObject", "OutcomeCategory"],
+        "examples": [
+          {
+            "source": "ApplicationService",
+            "target": "DataObject",
+            "description": "Application service depends on data object"
+          },
+          {
+            "source": "TestCaseSketch",
+            "target": "ContextVariation",
+            "description": "Test sketch depends on context for execution environment",
+            "layer": "12-testing"
+          },
+          {
+            "source": "TestCaseSketch",
+            "target": "OutcomeCategory",
+            "description": "Test sketch depends on expected outcome category",
+            "layer": "12-testing"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "supports-goals",
+        "sourceTypes": ["BusinessService", "Operation"],
+        "targetTypes": ["Goal"],
+        "examples": [
+          {
+            "source": "BusinessService",
+            "sourceLayer": "02-business",
+            "target": "Goal",
+            "targetLayer": "01-motivation",
+            "value": "goal-revenue-growth",
+            "description": "Payment service supports revenue growth goal"
+          },
+          {
+            "source": "Operation",
+            "sourceLayer": "06-api",
+            "target": "Goal",
+            "targetLayer": "01-motivation",
+            "value": "goal-customer-satisfaction",
+            "description": "GET /products operation supports customer satisfaction goal"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "fulfills-requirements",
+        "sourceTypes": ["ApplicationService", "Operation"],
+        "targetTypes": ["Requirement"],
+        "examples": [
+          {
+            "source": "ApplicationService",
+            "target": "Requirement",
+            "description": "OAuth service fulfills authentication requirement"
+          },
+          {
+            "source": "Operation",
+            "sourceLayer": "06-api",
+            "target": "Requirement",
+            "targetLayer": "01-motivation",
+            "value": "req-product-creation-capability",
+            "description": "POST /products operation fulfills product creation requirement"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "governed-by-principles",
+        "sourceTypes": ["APIOperation"],
+        "targetTypes": ["Principle"],
+        "examples": [
+          {
+            "source": "APIOperation",
+            "target": "Principle",
+            "description": "REST API governed by RESTful design principles"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "constrainedby",
+        "sourceTypes": ["APIOperation"],
+        "targetTypes": ["Constraint"],
+        "examples": [
+          {
+            "source": "APIOperation",
+            "target": "Constraint",
+            "description": "API operation constrained by rate limit"
+          }
+        ]
+      },
+      {
+        "relationshipTypeId": "traces",
+        "sourceTypes": ["APIOperation"],
+        "targetTypes": ["DistributedTrace"],
+        "examples": [
+          {
+            "source": "APIOperation",
+            "target": "DistributedTrace",
+            "description": "API operation participates in distributed trace"
+          }
+        ]
+      }
+    ]
+  },
+  "crossLayerRelationships": {
+    "$comment": "Relationships to/from entities in other layers",
+    "outgoing": [
+      {
+        "id": "apm-criticality",
+        "predicate": "apm-criticality",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "11-apm",
+        "targetTypes": ["Criticality"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-apm-criticality",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "enum [low, medium, high, critical] (optional)",
+        "examples": []
+      },
+      {
+        "id": "apm-sla-target-availability",
+        "predicate": "sla-target-availability",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "11-apm",
+        "targetTypes": ["SlaTargetAvailability"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "apm.sla-target-availability",
+        "cardinality": "single",
+        "format": "percentage",
+        "strength": "medium",
+        "required": false,
+        "description": "string (e.g., \"99.95%\", \"99.99%\", optional)",
+        "examples": [
+          {
+            "elementType": "TechnologyService",
+            "elementId": "container-platform",
+            "elementName": "container-platform",
+            "fieldPath": "apm.sla-target-availability",
+            "value": "99.95%",
+            "layer": "05-technology"
+          },
+          {
+            "elementType": "TechnologyService",
+            "elementId": "database-service",
+            "elementName": "database-service",
+            "fieldPath": "apm.sla-target-availability",
+            "value": "99.99%",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "apm-sla-target-latency",
+        "predicate": "sla-target-latency",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "11-apm",
+        "targetTypes": ["SlaTargetLatency"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "apm.sla-target-latency",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string (e.g., \"200ms\", \"500ms\", optional)",
+        "examples": [
+          {
+            "elementType": "TechnologyService",
+            "elementId": "database-service",
+            "elementName": "database-service",
+            "fieldPath": "apm.sla-target-latency",
+            "value": "10ms",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "apm-trace",
+        "predicate": "apm-trace",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "11-apm",
+        "targetTypes": ["Trace"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-apm-trace",
+        "cardinality": "single",
+        "format": "string",
+        "strength": "medium",
+        "required": false,
+        "description": "boolean (optional)",
+        "examples": []
+      },
+      {
+        "id": "archimate-ref",
+        "predicate": "archimate-ref",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "04-application",
+        "targetTypes": ["Element"],
+        "sourceTypes": ["OpenAPIDocument", "Operation", "SecurityScheme"],
+        "fieldPath": "x-archimate-ref",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string (Element.id reference to ApplicationService)",
+        "examples": []
+      },
+      {
+        "id": "business-apm-business-metrics",
+        "predicate": "business-metrics",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "02-business",
+        "targetTypes": ["BusinessMetric"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "apm.business-metrics",
+        "cardinality": "array",
+        "format": "reference",
+        "strength": "medium",
+        "required": false,
+        "description": "comma-separated business metric IDs this service tracks",
+        "examples": [
+          {
+            "elementType": "BusinessProcess",
+            "elementId": "order-process",
+            "elementName": "Order Fulfillment Process",
+            "fieldPath": "apm.business-metrics",
+            "value": "metric-order-fulfillment-time,metric-order-success-rate",
+            "layer": "02-business"
+          }
+        ]
+      },
+      {
+        "id": "business-interface-ref",
+        "predicate": "business-interface-ref",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "02-business",
+        "targetTypes": ["BusinessInterface"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-business-interface-ref",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string (BusinessInterface.id, optional)",
+        "examples": []
+      },
+      {
+        "id": "business-service-ref",
+        "predicate": "business-service-ref",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "02-business",
+        "targetTypes": ["BusinessService"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-business-service-ref",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string (BusinessService.id, optional)",
+        "examples": []
+      },
+      {
+        "id": "database-column",
+        "predicate": "database-column",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "07-data-model",
+        "targetTypes": ["Column"],
+        "sourceTypes": ["Schema"],
+        "fieldPath": "x-database-column",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string",
+        "examples": []
+      },
+      {
+        "id": "database-table",
+        "predicate": "database-table",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "07-data-model",
+        "targetTypes": ["Table"],
+        "sourceTypes": ["Schema", "SecurityScheme"],
+        "fieldPath": "x-database-table",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "medium",
+        "required": false,
+        "description": "string",
+        "examples": []
+      },
+      {
+        "id": "motivation-constrained-by",
+        "predicate": "constrained-by",
+        "inversePredicate": "constrains",
+        "targetLayer": "01-motivation",
+        "targetTypes": ["ConstrainedBy"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "motivation.constrained-by",
+        "cardinality": "array",
+        "format": "reference",
+        "strength": "medium",
+        "required": false,
+        "description": "string[] (Constraint IDs for regulatory/compliance, optional)",
+        "examples": [
+          {
+            "elementType": "Node",
+            "elementId": "k8s-cluster",
+            "elementName": "k8s-cluster",
+            "fieldPath": "motivation.constrained-by",
+            "value": "constraint-aws-infrastructure,constraint-budget-500k",
+            "layer": "05-technology"
+          },
+          {
+            "elementType": "Node",
+            "elementId": "postgres-cluster",
+            "elementName": "postgres-cluster",
+            "fieldPath": "motivation.constrained-by",
+            "value": "constraint-no-proprietary-databases",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "motivation-fulfills-requirements",
+        "predicate": "fulfills-requirements",
+        "inversePredicate": "fulfilled-by",
+        "targetLayer": "01-motivation",
+        "targetTypes": ["FulfillsRequirement"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "motivation.fulfills-requirements",
+        "cardinality": "array",
+        "format": "reference",
+        "strength": "high",
+        "required": false,
+        "description": "comma-separated Requirement IDs this function fulfills",
+        "examples": [
+          {
+            "elementType": "Node",
+            "elementId": "k8s-cluster",
+            "elementName": "k8s-cluster",
+            "fieldPath": "motivation.fulfills-requirements",
+            "value": "req-horizontal-scaling,req-99-95-availability",
+            "layer": "05-technology"
+          },
+          {
+            "elementType": "Node",
+            "elementId": "postgres-cluster",
+            "elementName": "postgres-cluster",
+            "fieldPath": "motivation.fulfills-requirements",
+            "value": "req-acid-compliance,req-replication",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "motivation-governed-by-principles",
+        "predicate": "governed-by-principles",
+        "inversePredicate": "governs",
+        "targetLayer": "01-motivation",
+        "targetTypes": ["GovernedByPrinciple"],
+        "sourceTypes": ["OpenAPIDocument", "Operation", "SecurityScheme"],
+        "fieldPath": "motivation.governed-by-principles",
+        "cardinality": "array",
+        "format": "reference",
+        "strength": "high",
+        "required": false,
+        "description": "BusinessService governed by Principles",
+        "examples": [
+          {
+            "elementType": "BusinessService",
+            "elementId": "order-service",
+            "elementName": "Order Processing Service",
+            "fieldPath": "motivation.governed-by-principles",
+            "value": "principle-customer-first,principle-automation",
+            "layer": "02-business"
+          },
+          {
+            "elementType": "ApplicationService",
+            "elementId": "product-service",
+            "elementName": "product-service",
+            "fieldPath": "motivation.governed-by-principles",
+            "value": "principle-api-first,principle-cloud-native",
+            "layer": "04-application"
+          }
+        ]
+      },
+      {
+        "id": "motivation-supports-goals",
+        "predicate": "supports-goals",
+        "inversePredicate": "supported-by",
+        "targetLayer": "01-motivation",
+        "targetTypes": ["SupportsGoal"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "motivation.supports-goals",
+        "cardinality": "array",
+        "format": "reference",
+        "strength": "high",
+        "required": false,
+        "description": "BusinessService supports Goals",
+        "examples": [
+          {
+            "elementType": "BusinessService",
+            "elementId": "order-service",
+            "elementName": "Order Processing Service",
+            "fieldPath": "motivation.supports-goals",
+            "value": "goal-customer-satisfaction,goal-revenue-growth",
+            "layer": "02-business"
+          },
+          {
+            "elementType": "ApplicationService",
+            "elementId": "product-service",
+            "elementName": "product-service",
+            "fieldPath": "motivation.supports-goals",
+            "value": "goal-product-catalog-accuracy,goal-customer-satisfaction",
+            "layer": "04-application"
+          }
+        ]
+      },
+      {
+        "id": "security-classification",
+        "predicate": "classification",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "03-security",
+        "targetTypes": ["Classification"],
+        "sourceTypes": ["Artifact"],
+        "fieldPath": "security.classification",
+        "cardinality": "single",
+        "format": "string",
+        "strength": "low",
+        "required": false,
+        "description": "Links to Classification in target layer",
+        "examples": [
+          {
+            "elementType": "Artifact",
+            "elementId": "product-db",
+            "elementName": "product-db",
+            "fieldPath": "security.classification",
+            "value": "internal",
+            "layer": "05-technology"
+          },
+          {
+            "elementType": "Artifact",
+            "elementId": "customer-db",
+            "elementName": "customer-db",
+            "fieldPath": "security.classification",
+            "value": "restricted",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "security-encrypted",
+        "predicate": "encrypted",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "03-security",
+        "targetTypes": ["Encrypted"],
+        "sourceTypes": ["Schema"],
+        "fieldPath": "x-encrypted",
+        "cardinality": "single",
+        "format": "string",
+        "strength": "medium",
+        "required": false,
+        "description": "boolean",
+        "examples": []
+      },
+      {
+        "id": "security-pii",
+        "predicate": "pii",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "03-security",
+        "targetTypes": ["Pii"],
+        "sourceTypes": ["Schema"],
+        "fieldPath": "security.pii",
+        "cardinality": "single",
+        "format": "boolean",
+        "strength": "medium",
+        "required": false,
+        "description": "contains personally identifiable information",
+        "examples": [
+          {
+            "elementType": "Artifact",
+            "elementId": "customer-db",
+            "elementName": "customer-db",
+            "fieldPath": "security.pii",
+            "value": "true",
+            "layer": "05-technology"
+          }
+        ]
+      },
+      {
+        "id": "security-required-permissions",
+        "predicate": "required-permissions",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "03-security",
+        "targetTypes": ["Permission"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-required-permissions",
+        "cardinality": "array",
+        "format": "duration",
+        "strength": "critical",
+        "required": false,
+        "description": "string[] (Permission.name[], optional)",
+        "examples": []
+      },
+      {
+        "id": "security-resource",
+        "predicate": "security-resource",
+        "inversePredicate": "referenced-by",
+        "targetLayer": "03-security",
+        "targetTypes": ["SecureResource"],
+        "sourceTypes": ["Operation", "SecurityScheme"],
+        "fieldPath": "x-security-resource",
+        "cardinality": "single",
+        "format": "duration",
+        "strength": "critical",
+        "required": false,
+        "description": "string (SecureResource.resource, optional)",
+        "examples": []
+      }
+    ],
+    "incoming": []
+  },
+  "type": "object",
+  "properties": {
+    "open-api-documents": {
+      "type": "array",
+      "description": "Collection of OpenAPIDocument entities",
+      "items": {
+        "$ref": "#/definitions/OpenAPIDocument"
+      }
+    },
+    "infos": {
+      "type": "array",
+      "description": "Collection of Info entities",
+      "items": {
+        "$ref": "#/definitions/Info"
+      }
+    },
+    "servers": {
+      "type": "array",
+      "description": "Collection of Server entities",
+      "items": {
+        "$ref": "#/definitions/Server"
+      }
+    },
+    "pathses": {
+      "type": "array",
+      "description": "Collection of Paths entities",
+      "items": {
+        "$ref": "#/definitions/Paths"
+      }
+    },
+    "path-items": {
+      "type": "array",
+      "description": "Collection of PathItem entities",
+      "items": {
+        "$ref": "#/definitions/PathItem"
+      }
+    },
+    "operations": {
+      "type": "array",
+      "description": "Collection of Operation entities",
+      "items": {
+        "$ref": "#/definitions/Operation"
+      }
+    },
+    "parameters": {
+      "type": "array",
+      "description": "Collection of Parameter entities",
+      "items": {
+        "$ref": "#/definitions/Parameter"
+      }
+    },
+    "request-bodies": {
+      "type": "array",
+      "description": "Collection of RequestBody entities",
+      "items": {
+        "$ref": "#/definitions/RequestBody"
+      }
+    },
+    "responseses": {
+      "type": "array",
+      "description": "Collection of Responses entities",
+      "items": {
+        "$ref": "#/definitions/Responses"
+      }
+    },
+    "responses": {
+      "type": "array",
+      "description": "Collection of Response entities",
+      "items": {
+        "$ref": "#/definitions/Response"
+      }
+    },
+    "media-types": {
+      "type": "array",
+      "description": "Collection of MediaType entities",
+      "items": {
+        "$ref": "#/definitions/MediaType"
+      }
+    },
+    "componentses": {
+      "type": "array",
+      "description": "Collection of Components entities",
+      "items": {
+        "$ref": "#/definitions/Components"
+      }
+    },
+    "schemas": {
+      "type": "array",
+      "description": "Collection of Schema entities",
+      "items": {
+        "$ref": "#/definitions/Schema"
+      }
+    },
+    "tags": {
+      "type": "array",
+      "description": "Collection of Tag entities",
+      "items": {
+        "$ref": "#/definitions/Tag"
+      }
+    },
+    "external-documentations": {
+      "type": "array",
+      "description": "Collection of ExternalDocumentation entities",
+      "items": {
+        "$ref": "#/definitions/ExternalDocumentation"
+      }
+    },
+    "contacts": {
+      "type": "array",
+      "description": "Collection of Contact entities",
+      "items": {
+        "$ref": "#/definitions/Contact"
+      }
+    },
+    "licenses": {
+      "type": "array",
+      "description": "Collection of License entities",
+      "items": {
+        "$ref": "#/definitions/License"
+      }
+    },
+    "server-variables": {
+      "type": "array",
+      "description": "Collection of ServerVariable entities",
+      "items": {
+        "$ref": "#/definitions/ServerVariable"
+      }
+    },
+    "headers": {
+      "type": "array",
+      "description": "Collection of Header entities",
+      "items": {
+        "$ref": "#/definitions/Header"
+      }
+    },
+    "links": {
+      "type": "array",
+      "description": "Collection of Link entities",
+      "items": {
+        "$ref": "#/definitions/Link"
+      }
+    },
+    "callbacks": {
+      "type": "array",
+      "description": "Collection of Callback entities",
+      "items": {
+        "$ref": "#/definitions/Callback"
+      }
+    },
+    "examples": {
+      "type": "array",
+      "description": "Collection of Example entities",
+      "items": {
+        "$ref": "#/definitions/Example"
+      }
+    },
+    "encodings": {
+      "type": "array",
+      "description": "Collection of Encoding entities",
+      "items": {
+        "$ref": "#/definitions/Encoding"
+      }
+    },
+    "o-auth-flowses": {
+      "type": "array",
+      "description": "Collection of OAuthFlows entities",
+      "items": {
+        "$ref": "#/definitions/OAuthFlows"
+      }
+    },
+    "o-auth-flows": {
+      "type": "array",
+      "description": "Collection of OAuthFlow entities",
+      "items": {
+        "$ref": "#/definitions/OAuthFlow"
+      }
+    },
+    "security-schemes": {
+      "type": "array",
+      "description": "Collection of SecurityScheme entities",
+      "items": {
+        "$ref": "#/definitions/SecurityScheme"
+      }
+    }
+  },
+  "definitions": {
+    "ParameterLocation": {
+      "type": "string",
+      "enum": ["query", "header", "path", "cookie"]
+    },
+    "ParameterStyle": {
+      "type": "string",
+      "enum": ["matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject"]
+    },
+    "SecurityType": {
+      "type": "string",
+      "enum": ["apiKey", "http", "oauth2", "openIdConnect"]
+    },
+    "OpenAPIDocument": {
+      "type": "object",
+      "description": "Root of an OpenAPI specification file",
+      "required": ["id", "name", "openapi", "info", "servers", "paths", "security", "tags"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "openapi": {
+          "type": "string",
+          "minLength": 1
+        },
+        "info": {
+          "type": "string",
+          "minLength": 1
+        },
+        "servers": {
+          "type": "string",
+          "minLength": 1
+        },
+        "paths": {
+          "type": "string",
+          "minLength": 1
+        },
+        "components": {
+          "type": "string",
+          "minLength": 1
+        },
+        "security": {
+          "type": "string",
+          "minLength": 1
+        },
+        "tags": {
+          "type": "string",
+          "minLength": 1
+        },
+        "externalDocs": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Info": {
+      "type": "object",
+      "description": "Metadata about the API",
+      "required": ["id", "name", "title", "version", "termsOfService"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        },
+        "termsOfService": {
+          "type": "string",
+          "minLength": 1
+        },
+        "contact": {
+          "type": "string",
+          "minLength": 1
+        },
+        "license": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Server": {
+      "type": "object",
+      "description": "Server where the API is available",
+      "required": ["id", "name", "url", "variables"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "variables": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Paths": {
+      "type": "object",
+      "description": "Available API endpoints and operations",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "PathItem": {
+      "type": "object",
+      "description": "Operations available on a path",
+      "required": ["id", "name", "servers", "parameters"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "servers": {
+          "type": "string",
+          "minLength": 1
+        },
+        "parameters": {
+          "type": "string",
+          "minLength": 1
+        },
+        "x-source-reference": {
+          "$ref": "common/source-references.schema.json#/definitions/SourceReference",
+          "description": "Source code reference using OpenAPI x- extension pattern. This pattern is used for OpenAPI-style layers (API, Data Model, Datastore) to maintain compatibility with OpenAPI tooling, as opposed to the nested properties.source.reference pattern used in ArchiMate-style layers (Application, Technology)."
+        }
+      }
+    },
+    "Operation": {
+      "type": "object",
+      "description": "Single API operation (HTTP method on a path)",
+      "required": ["id", "name", "operationId", "summary", "description", "tags"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "operationId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "tags": {
+          "type": "string",
+          "minLength": 1
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "parameters": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "requestBody": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "responses": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "callbacks": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "security": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "x-source-reference": {
+          "$ref": "common/source-references.schema.json#/definitions/SourceReference",
+          "description": "Source code reference using OpenAPI x- extension pattern. This pattern is used for OpenAPI-style layers (API, Data Model, Datastore) to maintain compatibility with OpenAPI tooling, as opposed to the nested properties.source.reference pattern used in ArchiMate-style layers (Application, Technology)."
+        }
+      }
+    },
+    "Parameter": {
+      "type": "object",
+      "description": "Parameter for an operation",
+      "required": ["id", "name", "in", "required"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "in": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "allowEmptyValue": {
+          "type": "boolean"
+        }
+      }
+    },
+    "RequestBody": {
+      "type": "object",
+      "description": "Request payload for an operation",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "required": {
+          "type": "boolean"
+        }
+      }
+    },
+    "Responses": {
+      "type": "object",
+      "description": "Possible responses from an operation",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Response": {
+      "type": "object",
+      "description": "Single response definition",
+      "required": ["id", "name", "description"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "MediaType": {
+      "type": "object",
+      "description": "Media type and schema for request/response body",
+      "required": ["id", "name", "contentType"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "contentType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "example": {
+          "type": "string",
+          "minLength": 1
+        },
+        "schema": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "examples": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "encoding": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Components": {
+      "type": "object",
+      "description": "Reusable component definitions",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "schemas": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "responses": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "parameters": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "examples": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "requestBodies": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "headers": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "securitySchemes": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "links": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        },
+        "callbacks": {
+          "type": "array",
+          "description": "Contains relationship",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "Schema": {
+      "type": "object",
+      "description": "Data type definition (JSON Schema subset)",
+      "required": ["id", "name", "type", "format"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "type": {
+          "type": "string",
+          "minLength": 1
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "format": {
+          "type": "string",
+          "minLength": 1
+        },
+        "default": {
+          "type": "string",
+          "minLength": 1
+        },
+        "enum": {
+          "type": "string",
+          "minLength": 1
+        },
+        "nullable": {
+          "type": "boolean"
+        }
+      }
+    },
+    "Tag": {
+      "type": "object",
+      "description": "A metadata label used to group and categorize API operations for documentation organization. Enables logical grouping of endpoints in generated API documentation.",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "ExternalDocumentation": {
+      "type": "object",
+      "description": "A reference to external documentation resources (URLs, wikis, guides) that provide additional context beyond the inline API specification. Links API elements to comprehensive documentation.",
+      "required": ["id", "url"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Contact": {
+      "type": "object",
+      "description": "Contact information for the API owner or maintainer, including name, email, and URL. Enables consumers to reach out for support or collaboration.",
+      "required": ["id", "url", "email", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1
+        },
+        "email": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "License": {
+      "type": "object",
+      "description": "Specifies the legal license under which the API is provided, including license name and URL to full terms. Clarifies usage rights for API consumers.",
+      "required": ["id", "name", "url"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "url": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "ServerVariable": {
+      "type": "object",
+      "description": "A variable placeholder in server URL templates that can be substituted at runtime. Enables dynamic server addressing for different environments or tenants.",
+      "required": ["id", "name", "default", "enum"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "default": {
+          "type": "string",
+          "minLength": 1
+        },
+        "enum": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Header": {
+      "type": "object",
+      "description": "Defines HTTP header parameters for requests or responses, specifying name, schema, required status, and description. Documents header-based communication requirements.",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "required": {
+          "type": "boolean"
+        },
+        "deprecated": {
+          "type": "boolean"
+        },
+        "allowEmptyValue": {
+          "type": "boolean"
+        }
+      }
+    },
+    "Link": {
+      "type": "object",
+      "description": "Describes a relationship between API responses and subsequent operations, enabling hypermedia-driven API navigation. Supports HATEOAS design patterns.",
+      "required": ["id", "name", "operationId", "operationRef"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "operationId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "operationRef": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Callback": {
+      "type": "object",
+      "description": "Defines a webhook or callback URL pattern where the API will send asynchronous notifications. Enables event-driven integrations and async workflows.",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Example": {
+      "type": "object",
+      "description": "Provides sample values for request bodies, responses, or parameters. Improves documentation clarity and enables automated testing or mocking.",
+      "required": ["id", "name", "summary", "description", "value", "externalValue"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "value": {
+          "type": "string",
+          "minLength": 1
+        },
+        "externalValue": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "Encoding": {
+      "type": "object",
+      "description": "Specifies serialization details for multipart request body properties, including content-type, headers, and encoding style. Handles complex content negotiation.",
+      "required": ["id", "propertyName", "contentType", "style"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "propertyName": {
+          "type": "string",
+          "minLength": 1
+        },
+        "contentType": {
+          "type": "string",
+          "minLength": 1
+        },
+        "style": {
+          "type": "string",
+          "minLength": 1
+        },
+        "explode": {
+          "type": "boolean"
+        },
+        "allowReserved": {
+          "type": "boolean"
+        }
+      }
+    },
+    "OAuthFlows": {
+      "type": "object",
+      "description": "Configuration for OAuth 2.0 authentication flows (implicit, password, clientCredentials, authorizationCode), specifying authorization URLs, token URLs, and scopes. Defines OAuth security implementation.",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "OAuthFlow": {
+      "type": "object",
+      "description": "Individual OAuth 2.0 flow configuration",
+      "required": ["authorizationUrl", "tokenUrl", "scopes"],
+      "properties": {
+        "authorizationUrl": {
+          "type": "string",
+          "minLength": 1
+        },
+        "tokenUrl": {
+          "type": "string",
+          "minLength": 1
+        },
+        "refreshUrl": {
+          "type": "string",
+          "minLength": 1
+        },
+        "scopes": {
+          "type": "object"
+        }
+      }
+    },
+    "SecurityScheme": {
+      "type": "object",
+      "description": "Security mechanism for the API",
+      "required": ["id", "type", "name", "in", "scheme", "bearerFormat"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid",
+          "minLength": 1
+        },
+        "type": {
+          "type": "string",
+          "minLength": 1
+        },
+        "description": {
+          "type": "string",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1
+        },
+        "in": {
+          "type": "string",
+          "minLength": 1
+        },
+        "scheme": {
+          "type": "string",
+          "minLength": 1
+        },
+        "bearerFormat": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    }
+  }
+}