@unispechq/unispec-schema 0.1.2 → 0.1.5

package/README.md

@@ -1,170 +1,170 @@
-# UniSpec Specification
-
-Official specification of the UniSpec API definition language
-
-## Overview
-
-UniSpec is a modern, multi-protocol API specification format designed to unify REST, GraphQL, WebSocket, and event-driven API documentation under a single, consistent model.
-
-This repository is the single source of truth for the UniSpec format.
-It contains everything required to understand, validate, and evolve the language:
-
-- Machine-readable JSON Schemas
-- Human-readable reference documentation
-- Official examples (REST, GraphQL, WebSocket, mixed APIs)
-- Versioning and compatibility rules
-- Links to RFCs governing format evolution
-
-UniSpec powers all components of the UniSpec platform:
-Core Engine → CLI → Framework Adapters → Registry → Portal → Enterprise extensions.
-
-## Repository Structure
-```pgsql
-unispec-spec/
-├─ schema/            # JSON Schemas defining the UniSpec format
-│  ├─ unispec.schema.json
-│  └─ types/
-│     ├─ service.schema.json
-│     ├─ rest.schema.json
-│     ├─ graphql.schema.json
-│     ├─ websocket.schema.json
-│     ├─ schemas.schema.json
-│     └─ common.schema.json
-│
-├─ examples/          # Real-world examples in YAML/JSON
-│  ├─ simple-rest.yaml
-│  ├─ graphql.yaml
-│  ├─ websocket.yaml
-│  └─ mixed-api.yaml
-│
-├─ reference/         # Human-readable format documentation
-│  ├─ fields.md
-│  ├─ components.md
-│  ├─ versioning.md
-│  └─ style-guide.md
-│
-├─ CHANGELOG.md       # Release notes for UniSpec format versions
-└─ README.md
-```
-
-## Purpose of This Repository
-
-This repo defines the UniSpec language, not its implementation.
-
-### This repository contains:
-
-- Format specification
-- JSON Schemas
-- Examples and documentation
-- Rules for versioning and compatibility
-- Official reference for implementers
-
-### This repository does NOT contain:
-
-- UniSpec Core engine
-- CLI implementation
-- Framework adapters
-- Portal or Registry code
-- Runtime logic
-
-These live in other repositories of the UniSpec organization.
-
-## Format Philosophy
-
-UniSpec is built on the following principles:
-
-1. Multi-protocol by design
-- One format supports:
-- REST
-- GraphQL
-- WebSocket
-- (future) gRPC, AsyncAPI, message buses
-
-2. Developer-first
-- Readable YAML for humans, strict JSON Schema for machines.
-
-3. Strong structure, minimal ambiguity
-- No vague fields or implicit semantics.
-- Every field has a precise definition and validation rules.
-
-4. Extensible
-- Supports custom extensions via x-extensions, similar to OpenAPI but cleaner and more consistent.
-
-5. Transparent evolution
-- All major changes require an approved RFC.
-- Minor changes and clarifications must maintain backward compatibility.
-
-## JSON Schema
-
-The canonical, machine-readable definition of UniSpec lives in the schema/ directory.
-
-### Rules:
-
-- Must follow JSON Schema Draft 2020-12
-- Must use $defs for reusable components
-- Must clearly describe field semantics and constraints
-- All examples must validate against the schema
-- Breaking changes require an RFC and a major version bump
-
-## Examples
-
-The examples/ directory contains official UniSpec examples:
-
-- simple-rest.yaml — minimal REST service
-- graphql.yaml — example of a GraphQL API
-- websocket.yaml — WebSocket channels and messages
-- mixed-api.yaml — service combining REST + GraphQL + WebSocket
-
-All examples are validated as part of CI to ensure correctness.
-
-## Reference Documentation
-
-All human-readable format documentation lives in reference/:
-
-- fields.md — detailed field-by-field description
-- components.md — rules for schema composition and references
-- versioning.md — semantic versioning guidelines
-- style-guide.md — recommended naming and structuring conventions
-
-These documents must be kept in sync with schema changes.
-
-## Versioning
-
-UniSpec follows Semantic Versioning (SemVer):
-
-- MAJOR — breaking changes
-- MINOR — new backward-compatible features
-- PATCH — fixes, clarifications, corrections
-
-All changes must be recorded in CHANGELOG.md.
-
-## RFC Process
-
-Any change that alters:
-
-- structure of the UniSpec format
-- semantics of existing fields
-- compatibility rules
-- supported protocols
-
-must be proposed, discussed, and approved in the
-unispec-rfcs repository before being applied here.
-
-No schema modifications may occur without a corresponding approved RFC.
-
-## Contributing
-
-Contributions are welcome!
-
-To contribute:
-
-1. Read the reference docs.
-2. Review open RFCs or create a new proposal.
-3. Submit a PR with clear explanation and schema validation.
-
-All contributions must preserve backward compatibility unless explicitly approved otherwise.
-
-## License
-
-This repository is open-source and free to implement.
+# UniSpec Specification
+
+Official specification of the UniSpec API definition language
+
+## Overview
+
+UniSpec is a modern, multi-protocol API specification format designed to unify REST, GraphQL, WebSocket, and event-driven API documentation under a single, consistent model.
+
+This repository is the single source of truth for the UniSpec format.
+It contains everything required to understand, validate, and evolve the language:
+
+- Machine-readable JSON Schemas
+- Human-readable reference documentation
+- Official examples (REST, GraphQL, WebSocket, mixed APIs)
+- Versioning and compatibility rules
+- Links to RFCs governing format evolution
+
+UniSpec powers all components of the UniSpec platform:
+Core Engine → CLI → Framework Adapters → Registry → Portal → Enterprise extensions.
+
+## Repository Structure
+```pgsql
+unispec-spec/
+├─ schema/            # JSON Schemas defining the UniSpec format
+│  ├─ unispec.schema.json
+│  └─ types/
+│     ├─ service.schema.json
+│     ├─ rest.schema.json
+│     ├─ graphql.schema.json
+│     ├─ websocket.schema.json
+│     ├─ schemas.schema.json
+│     └─ common.schema.json
+│
+├─ examples/          # Real-world examples in YAML/JSON
+│  ├─ simple-rest.yaml
+│  ├─ graphql.yaml
+│  ├─ websocket.yaml
+│  └─ mixed-api.yaml
+│
+├─ reference/         # Human-readable format documentation
+│  ├─ fields.md
+│  ├─ components.md
+│  ├─ versioning.md
+│  └─ style-guide.md
+│
+├─ CHANGELOG.md       # Release notes for UniSpec format versions
+└─ README.md
+```
+
+## Purpose of This Repository
+
+This repo defines the UniSpec language, not its implementation.
+
+### This repository contains:
+
+- Format specification
+- JSON Schemas
+- Examples and documentation
+- Rules for versioning and compatibility
+- Official reference for implementers
+
+### This repository does NOT contain:
+
+- UniSpec Core engine
+- CLI implementation
+- Framework adapters
+- Portal or Registry code
+- Runtime logic
+
+These live in other repositories of the UniSpec organization.
+
+## Format Philosophy
+
+UniSpec is built on the following principles:
+
+1. Multi-protocol by design
+- One format supports:
+- REST
+- GraphQL
+- WebSocket
+- (future) gRPC, AsyncAPI, message buses
+
+2. Developer-first
+- Readable YAML for humans, strict JSON Schema for machines.
+
+3. Strong structure, minimal ambiguity
+- No vague fields or implicit semantics.
+- Every field has a precise definition and validation rules.
+
+4. Extensible
+- Supports custom extensions via x-extensions, similar to OpenAPI but cleaner and more consistent.
+
+5. Transparent evolution
+- All major changes require an approved RFC.
+- Minor changes and clarifications must maintain backward compatibility.
+
+## JSON Schema
+
+The canonical, machine-readable definition of UniSpec lives in the schema/ directory.
+
+### Rules:
+
+- Must follow JSON Schema Draft 2020-12
+- Must use $defs for reusable components
+- Must clearly describe field semantics and constraints
+- All examples must validate against the schema
+- Breaking changes require an RFC and a major version bump
+
+## Examples
+
+The examples/ directory contains official UniSpec examples:
+
+- simple-rest.yaml — minimal REST service
+- graphql.yaml — example of a GraphQL API
+- websocket.yaml — WebSocket channels and messages
+- mixed-api.yaml — service combining REST + GraphQL + WebSocket
+
+All examples are validated as part of CI to ensure correctness.
+
+## Reference Documentation
+
+All human-readable format documentation lives in reference/:
+
+- fields.md — detailed field-by-field description
+- components.md — rules for schema composition and references
+- versioning.md — semantic versioning guidelines
+- style-guide.md — recommended naming and structuring conventions
+
+These documents must be kept in sync with schema changes.
+
+## Versioning
+
+UniSpec follows Semantic Versioning (SemVer):
+
+- MAJOR — breaking changes
+- MINOR — new backward-compatible features
+- PATCH — fixes, clarifications, corrections
+
+All changes must be recorded in CHANGELOG.md.
+
+## RFC Process
+
+Any change that alters:
+
+- structure of the UniSpec format
+- semantics of existing fields
+- compatibility rules
+- supported protocols
+
+must be proposed, discussed, and approved in the
+unispec-rfcs repository before being applied here.
+
+No schema modifications may occur without a corresponding approved RFC.
+
+## Contributing
+
+Contributions are welcome!
+
+To contribute:
+
+1. Read the reference docs.
+2. Review open RFCs or create a new proposal.
+3. Submit a PR with clear explanation and schema validation.
+
+All contributions must preserve backward compatibility unless explicitly approved otherwise.
+
+## License
+
+This repository is open-source and free to implement.
 The UniSpec format is designed to be an open standard.

package/index.cjs

@@ -1,7 +1,7 @@
-const unispec = require("./schema/unispec.schema.json");
-const manifest = require("./schema/index.json");
-
-module.exports = {
-  unispec,
-  manifest,
-};
+const unispec = require("./schema/unispec.schema.json");
+const manifest = require("./schema/index.json");
+
+module.exports = {
+  unispec,
+  manifest,
+};

package/index.mjs

@@ -1,5 +1,5 @@
-import unispec from "./schema/unispec.schema.json" assert { type: "json" };
-import manifest from "./schema/index.json" assert { type: "json" };
-
-export { unispec, manifest };
-export default { unispec, manifest };
+import unispec from "./schema/unispec.schema.json" assert { type: "json" };
+import manifest from "./schema/index.json" assert { type: "json" };
+
+export { unispec, manifest };
+export default { unispec, manifest };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unispechq/unispec-schema",
-  "version": "0.1.2",
+  "version": "0.1.5",
   "description": "Official UniSpec JSON Schemas",
   "type": "module",
   "main": "index.cjs",

package/schema/index.json

@@ -1,14 +1,14 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "name": "@unispechq/unispec-schema",
-  "description": "Official UniSpec JSON Schemas",
-  "root": "./unispec.schema.json",
-  "types": {
-    "common": "./types/common.schema.json",
-    "graphql": "./types/graphql.schema.json",
-    "rest": "./types/rest.schema.json",
-    "schemas": "./types/schemas.schema.json",
-    "service": "./types/service.schema.json",
-    "websocket": "./types/websocket.schema.json"
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "name": "@unispechq/unispec-schema",
+  "description": "Official UniSpec JSON Schemas",
+  "root": "./unispec.schema.json",
+  "types": {
+    "common": "./types/common.schema.json",
+    "graphql": "./types/graphql.schema.json",
+    "rest": "./types/rest.schema.json",
+    "schemas": "./types/schemas.schema.json",
+    "service": "./types/service.schema.json",
+    "websocket": "./types/websocket.schema.json"
+  }
+}

package/schema/types/common.schema.json

@@ -1,16 +1,16 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/common.schema.json",
-  "title": "Common UniSpec definitions",
-  "$defs": {
-    "Identifier": {
-      "type": "string",
-      "description": "Identifier for services, operations, channels, etc.",
-      "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$"
-    },
-    "Description": {
-      "type": "string",
-      "description": "Human-readable description text."
-    }
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/common.schema.json",
+  "title": "Common UniSpec definitions",
+  "$defs": {
+    "Identifier": {
+      "type": "string",
+      "description": "Identifier for services, operations, channels, etc.",
+      "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$"
+    },
+    "Description": {
+      "type": "string",
+      "description": "Human-readable description text."
+    }
+  }
+}

package/schema/types/graphql.schema.json

@@ -1,58 +1,58 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/graphql.schema.json",
-  "title": "GraphQL API surface",
-  "type": "object",
-  "$defs": {
-    "Operation": {
-      "type": "object",
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "$ref": "./common.schema.json#/$defs/Identifier"
-        },
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "deprecated": {
-          "type": "boolean",
-          "description": "Marks the operation as deprecated.",
-          "default": false
-        },
-        "deprecationReason": {
-          "type": "string",
-          "description": "Human-readable reason for deprecation."
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "properties": {
-    "schema": {
-      "type": "string",
-      "description": "GraphQL schema SDL as a string. Canonical source of type definitions."
-    },
-    "queries": {
-      "type": "array",
-      "description": "Query operations exposed by the GraphQL API.",
-      "items": {
-        "$ref": "#/$defs/Operation"
-      }
-    },
-    "mutations": {
-      "type": "array",
-      "description": "Mutation operations exposed by the GraphQL API.",
-      "items": {
-        "$ref": "#/$defs/Operation"
-      }
-    },
-    "subscriptions": {
-      "type": "array",
-      "description": "Subscription operations exposed by the GraphQL API.",
-      "items": {
-        "$ref": "#/$defs/Operation"
-      }
-    }
-  },
-  "additionalProperties": false
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/graphql.schema.json",
+  "title": "GraphQL API surface",
+  "type": "object",
+  "$defs": {
+    "Operation": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "$ref": "./common.schema.json#/$defs/Identifier"
+        },
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "deprecated": {
+          "type": "boolean",
+          "description": "Marks the operation as deprecated.",
+          "default": false
+        },
+        "deprecationReason": {
+          "type": "string",
+          "description": "Human-readable reason for deprecation."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "schema": {
+      "type": "string",
+      "description": "GraphQL schema SDL as a string. Canonical source of type definitions."
+    },
+    "queries": {
+      "type": "array",
+      "description": "Query operations exposed by the GraphQL API.",
+      "items": {
+        "$ref": "#/$defs/Operation"
+      }
+    },
+    "mutations": {
+      "type": "array",
+      "description": "Mutation operations exposed by the GraphQL API.",
+      "items": {
+        "$ref": "#/$defs/Operation"
+      }
+    },
+    "subscriptions": {
+      "type": "array",
+      "description": "Subscription operations exposed by the GraphQL API.",
+      "items": {
+        "$ref": "#/$defs/Operation"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/schema/types/rest.schema.json

@@ -1,144 +1,144 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/rest.schema.json",
-  "title": "REST API surface",
-  "type": "object",
-  "$defs": {
-    "Route": {
-      "type": "object",
-      "required": ["path", "method"],
-      "properties": {
-        "name": {
-          "$ref": "./common.schema.json#/$defs/Identifier"
-        },
-        "summary": {
-          "type": "string",
-          "description": "Short, human-readable summary of the route."
-        },
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "path": {
-          "type": "string",
-          "description": "URL path template, e.g. /users/{id}."
-        },
-        "method": {
-          "type": "string",
-          "description": "HTTP method in upper-case.",
-          "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"]
-        },
-        "pathParams": {
-          "type": "array",
-          "description": "Path parameters bound from the URL template.",
-          "items": {
-            "$ref": "#/$defs/Parameter"
-          }
-        },
-        "queryParams": {
-          "type": "array",
-          "description": "Query string parameters.",
-          "items": {
-            "$ref": "#/$defs/Parameter"
-          }
-        },
-        "headers": {
-          "type": "array",
-          "description": "HTTP headers relevant for this route.",
-          "items": {
-            "$ref": "#/$defs/Parameter"
-          }
-        },
-        "requestBody": {
-          "$ref": "#/$defs/RequestBody"
-        },
-        "responses": {
-          "type": "object",
-          "description": "HTTP responses keyed by status code (e.g. '200', '404').",
-          "additionalProperties": {
-            "$ref": "#/$defs/Response"
-          }
-        }
-      },
-      "additionalProperties": false
-    },
-    "Parameter": {
-      "type": "object",
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Parameter name as it appears in the API."
-        },
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "required": {
-          "type": "boolean",
-          "description": "Whether this parameter is required.",
-          "default": false
-        },
-        "schemaRef": {
-          "type": "string",
-          "description": "Reference to a reusable schema defined in the service-level schemas section."
-        }
-      },
-      "additionalProperties": false
-    },
-    "MediaType": {
-      "type": "object",
-      "properties": {
-        "schemaRef": {
-          "type": "string",
-          "description": "Reference to a reusable schema used as the content payload."
-        }
-      },
-      "additionalProperties": false
-    },
-    "Content": {
-      "type": "object",
-      "description": "Content keyed by media type, e.g. 'application/json'.",
-      "additionalProperties": {
-        "$ref": "#/$defs/MediaType"
-      }
-    },
-    "RequestBody": {
-      "type": "object",
-      "properties": {
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "required": {
-          "type": "boolean",
-          "description": "Whether a request body is required.",
-          "default": false
-        },
-        "content": {
-          "$ref": "#/$defs/Content"
-        }
-      },
-      "additionalProperties": false
-    },
-    "Response": {
-      "type": "object",
-      "properties": {
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "content": {
-          "$ref": "#/$defs/Content"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "properties": {
-    "routes": {
-      "type": "array",
-      "description": "List of REST routes exposed by the service.",
-      "items": {
-        "$ref": "#/$defs/Route"
-      }
-    }
-  },
-  "additionalProperties": false
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/rest.schema.json",
+  "title": "REST API surface",
+  "type": "object",
+  "$defs": {
+    "Route": {
+      "type": "object",
+      "required": ["path", "method"],
+      "properties": {
+        "name": {
+          "$ref": "./common.schema.json#/$defs/Identifier"
+        },
+        "summary": {
+          "type": "string",
+          "description": "Short, human-readable summary of the route."
+        },
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "path": {
+          "type": "string",
+          "description": "URL path template, e.g. /users/{id}."
+        },
+        "method": {
+          "type": "string",
+          "description": "HTTP method in upper-case.",
+          "enum": ["GET", "POST", "PUT", "PATCH", "DELETE"]
+        },
+        "pathParams": {
+          "type": "array",
+          "description": "Path parameters bound from the URL template.",
+          "items": {
+            "$ref": "#/$defs/Parameter"
+          }
+        },
+        "queryParams": {
+          "type": "array",
+          "description": "Query string parameters.",
+          "items": {
+            "$ref": "#/$defs/Parameter"
+          }
+        },
+        "headers": {
+          "type": "array",
+          "description": "HTTP headers relevant for this route.",
+          "items": {
+            "$ref": "#/$defs/Parameter"
+          }
+        },
+        "requestBody": {
+          "$ref": "#/$defs/RequestBody"
+        },
+        "responses": {
+          "type": "object",
+          "description": "HTTP responses keyed by status code (e.g. '200', '404').",
+          "additionalProperties": {
+            "$ref": "#/$defs/Response"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "Parameter": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Parameter name as it appears in the API."
+        },
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether this parameter is required.",
+          "default": false
+        },
+        "schemaRef": {
+          "type": "string",
+          "description": "Reference to a reusable schema defined in the service-level schemas section."
+        }
+      },
+      "additionalProperties": false
+    },
+    "MediaType": {
+      "type": "object",
+      "properties": {
+        "schemaRef": {
+          "type": "string",
+          "description": "Reference to a reusable schema used as the content payload."
+        }
+      },
+      "additionalProperties": false
+    },
+    "Content": {
+      "type": "object",
+      "description": "Content keyed by media type, e.g. 'application/json'.",
+      "additionalProperties": {
+        "$ref": "#/$defs/MediaType"
+      }
+    },
+    "RequestBody": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "required": {
+          "type": "boolean",
+          "description": "Whether a request body is required.",
+          "default": false
+        },
+        "content": {
+          "$ref": "#/$defs/Content"
+        }
+      },
+      "additionalProperties": false
+    },
+    "Response": {
+      "type": "object",
+      "properties": {
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "content": {
+          "$ref": "#/$defs/Content"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "routes": {
+      "type": "array",
+      "description": "List of REST routes exposed by the service.",
+      "items": {
+        "$ref": "#/$defs/Route"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/schema/types/schemas.schema.json

@@ -1,25 +1,25 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/schemas.schema.json",
-  "title": "Reusable data schemas",
-  "description": "Container for reusable data model definitions (request/response bodies, messages, etc.).",
-  "type": "object",
-  "additionalProperties": {
-    "$ref": "#/$defs/SchemaDefinition"
-  },
-  "$defs": {
-    "SchemaDefinition": {
-      "type": "object",
-      "description": "Named reusable data schema definition.",
-      "properties": {
-        "jsonSchema": {
-          "type": "object",
-          "description": "Embedded JSON Schema Draft 2020-12 definition for this type.",
-          "additionalProperties": true
-        }
-      },
-      "required": ["jsonSchema"],
-      "additionalProperties": false
-    }
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/schemas.schema.json",
+  "title": "Reusable data schemas",
+  "description": "Container for reusable data model definitions (request/response bodies, messages, etc.).",
+  "type": "object",
+  "additionalProperties": {
+    "$ref": "#/$defs/SchemaDefinition"
+  },
+  "$defs": {
+    "SchemaDefinition": {
+      "type": "object",
+      "description": "Named reusable data schema definition.",
+      "properties": {
+        "jsonSchema": {
+          "type": "object",
+          "description": "Embedded JSON Schema Draft 2020-12 definition for this type.",
+          "additionalProperties": true
+        }
+      },
+      "required": ["jsonSchema"],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/types/service.schema.json

@@ -1,36 +1,36 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/service.schema.json",
-  "title": "UniSpec Service",
-  "type": "object",
-  "required": ["name"],
-  "properties": {
-    "name": {
-      "$ref": "./common.schema.json#/$defs/Identifier"
-    },
-    "title": {
-      "type": "string",
-      "description": "Short human-friendly service title."
-    },
-    "description": {
-      "$ref": "./common.schema.json#/$defs/Description"
-    },
-    "protocols": {
-      "type": "object",
-      "description": "Protocol-specific API surfaces exposed by this service.",
-      "properties": {
-        "rest": {
-          "$ref": "./rest.schema.json#"
-        },
-        "graphql": {
-          "$ref": "./graphql.schema.json#"
-        },
-        "websocket": {
-          "$ref": "./websocket.schema.json#"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "additionalProperties": false
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/service.schema.json",
+  "title": "UniSpec Service",
+  "type": "object",
+  "required": ["name"],
+  "properties": {
+    "name": {
+      "$ref": "./common.schema.json#/$defs/Identifier"
+    },
+    "title": {
+      "type": "string",
+      "description": "Short human-friendly service title."
+    },
+    "description": {
+      "$ref": "./common.schema.json#/$defs/Description"
+    },
+    "protocols": {
+      "type": "object",
+      "description": "Protocol-specific API surfaces exposed by this service.",
+      "properties": {
+        "rest": {
+          "$ref": "./rest.schema.json#"
+        },
+        "graphql": {
+          "$ref": "./graphql.schema.json#"
+        },
+        "websocket": {
+          "$ref": "./websocket.schema.json#"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/schema/types/websocket.schema.json

@@ -1,61 +1,61 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/types/websocket.schema.json",
-  "title": "WebSocket API surface",
-  "type": "object",
-  "$defs": {
-    "Message": {
-      "type": "object",
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "$ref": "./common.schema.json#/$defs/Identifier"
-        },
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "schemaRef": {
-          "type": "string",
-          "description": "Reference to a reusable schema describing the message payload."
-        }
-      },
-      "additionalProperties": false
-    },
-    "Channel": {
-      "type": "object",
-      "required": ["name"],
-      "properties": {
-        "name": {
-          "$ref": "./common.schema.json#/$defs/Identifier"
-        },
-        "description": {
-          "$ref": "./common.schema.json#/$defs/Description"
-        },
-        "direction": {
-          "type": "string",
-          "description": "Direction of message flow on this channel.",
-          "enum": ["publish", "subscribe", "both"],
-          "default": "both"
-        },
-        "messages": {
-          "type": "array",
-          "description": "Messages that may be sent or received on this channel.",
-          "items": {
-            "$ref": "#/$defs/Message"
-          }
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "properties": {
-    "channels": {
-      "type": "array",
-      "description": "WebSocket channels/topics exposed by the service.",
-      "items": {
-        "$ref": "#/$defs/Channel"
-      }
-    }
-  },
-  "additionalProperties": false
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/types/websocket.schema.json",
+  "title": "WebSocket API surface",
+  "type": "object",
+  "$defs": {
+    "Message": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "$ref": "./common.schema.json#/$defs/Identifier"
+        },
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "schemaRef": {
+          "type": "string",
+          "description": "Reference to a reusable schema describing the message payload."
+        }
+      },
+      "additionalProperties": false
+    },
+    "Channel": {
+      "type": "object",
+      "required": ["name"],
+      "properties": {
+        "name": {
+          "$ref": "./common.schema.json#/$defs/Identifier"
+        },
+        "description": {
+          "$ref": "./common.schema.json#/$defs/Description"
+        },
+        "direction": {
+          "type": "string",
+          "description": "Direction of message flow on this channel.",
+          "enum": ["publish", "subscribe", "both"],
+          "default": "both"
+        },
+        "messages": {
+          "type": "array",
+          "description": "Messages that may be sent or received on this channel.",
+          "items": {
+            "$ref": "#/$defs/Message"
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "channels": {
+      "type": "array",
+      "description": "WebSocket channels/topics exposed by the service.",
+      "items": {
+        "$ref": "#/$defs/Channel"
+      }
+    }
+  },
+  "additionalProperties": false
+}

package/schema/unispec.schema.json

@@ -1,23 +1,23 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://unispec.dev/schema/unispec.schema.json",
-  "title": "UniSpec document",
-  "description": "Top-level UniSpec document describing a multi-protocol API service.",
-  "type": "object",
-  "required": ["unispecVersion", "service"],
-  "properties": {
-    "unispecVersion": {
-      "type": "string",
-      "description": "UniSpec format version (SemVer)."
-    },
-    "service": {
-      "$ref": "./types/service.schema.json#"
-    },
-    "extensions": {
-      "type": "object",
-      "description": "Custom vendor-specific extensions (x-*) at the document root.",
-      "additionalProperties": true
-    }
-  },
-  "additionalProperties": false
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/unispec.schema.json",
+  "title": "UniSpec document",
+  "description": "Top-level UniSpec document describing a multi-protocol API service.",
+  "type": "object",
+  "required": ["unispecVersion", "service"],
+  "properties": {
+    "unispecVersion": {
+      "type": "string",
+      "description": "UniSpec format version (SemVer)."
+    },
+    "service": {
+      "$ref": "./types/service.schema.json#"
+    },
+    "extensions": {
+      "type": "object",
+      "description": "Custom vendor-specific extensions (x-*) at the document root.",
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": false
+}