@unispechq/unispec-schema 0.2.1 → 0.3.0

package/package.json

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

package/schema/types/rest.schema.json

@@ -57,10 +57,24 @@
           "additionalProperties": {
             "$ref": "#/$defs/Response"
           }
+        },
+        "security": {
+          "type": "array",
+          "description": "Security requirements for this route. Each item represents an alternative set of named security schemes.",
+          "items": {
+            "$ref": "#/$defs/SecurityRequirement"
+          }
         }
       },
       "additionalProperties": false
     },
+    "SecurityRequirement": {
+      "type": "array",
+      "description": "Alternative set of named security schemes applied to an operation.",
+      "items": {
+        "$ref": "./common.schema.json#/$defs/Identifier"
+      }
+    },
     "Parameter": {
       "type": "object",
       "required": ["name"],
@@ -138,6 +152,15 @@
       "items": {
         "$ref": "#/$defs/Route"
       }
+    },
+    "securitySchemes": {
+      "type": "object",
+      "description": "Authentication mechanisms available for this REST surface.",
+      "additionalProperties": {
+        "type": "object",
+        "description": "Security scheme definition (shape is intentionally flexible and may evolve).",
+        "additionalProperties": true
+      }
     }
   },
   "additionalProperties": false

package/schema/types/service.schema.json

@@ -15,6 +15,28 @@
     "description": {
       "$ref": "./common.schema.json#/$defs/Description"
     },
+    "version": {
+      "type": "string",
+      "description": "Service contract version (SemVer)."
+    },
+    "owner": {
+      "type": "string",
+      "description": "Owning team or group identifier."
+    },
+    "tags": {
+      "type": "array",
+      "description": "Simple string tags used for grouping and filtering in tooling.",
+      "items": {
+        "type": "string"
+      }
+    },
+    "links": {
+      "type": "object",
+      "description": "Well-known URLs related to the service (for example, repo, runbook, dashboard).",
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
     "protocols": {
       "type": "object",
       "description": "Protocol-specific API surfaces exposed by this service.",
@@ -30,6 +52,44 @@
         }
       },
       "additionalProperties": false
+    },
+    "schemas": {
+      "$ref": "./schemas.schema.json#"
+    },
+    "environments": {
+      "type": "array",
+      "description": "Deployment environments or entrypoints for the service.",
+      "items": {
+        "type": "object",
+        "required": ["name", "baseUrl"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Short environment name (for example, dev, staging, prod, local)."
+          },
+          "baseUrl": {
+            "type": "string",
+            "format": "uri",
+            "description": "Base URL for the environment."
+          },
+          "region": {
+            "type": "string",
+            "description": "Region identifier (for example, eu-central-1)."
+          },
+          "labels": {
+            "type": "object",
+            "description": "Arbitrary string labels for tooling.",
+            "additionalProperties": {
+              "type": "string"
+            }
+          },
+          "isDefault": {
+            "type": "boolean",
+            "description": "Indicates the default environment for interactive tooling."
+          }
+        },
+        "additionalProperties": false
+      }
     }
   },
   "additionalProperties": false

package/schema/types/websocket.schema.json

@@ -43,6 +43,18 @@
           "items": {
             "$ref": "#/$defs/Message"
           }
+        },
+        "security": {
+          "type": "array",
+          "description": "Security requirements for this channel. Each item represents an alternative set of named security schemes.",
+          "items": {
+            "$ref": "#/$defs/SecurityRequirement"
+          }
+        },
+        "extensions": {
+          "type": "object",
+          "description": "Custom vendor-specific extensions (x-*) for this channel.",
+          "additionalProperties": true
         }
       },
       "additionalProperties": false
@@ -55,6 +67,15 @@
       "items": {
         "$ref": "#/$defs/Channel"
       }
+    },
+    "securitySchemes": {
+      "type": "object",
+      "description": "Authentication mechanisms available for this WebSocket surface.",
+      "additionalProperties": {
+        "type": "object",
+        "description": "Security scheme definition (shape is intentionally flexible and may evolve).",
+        "additionalProperties": true
+      }
     }
   },
   "additionalProperties": false

package/schema/unispec-tests.schema.json

@@ -0,0 +1,318 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://unispec.dev/schema/unispec-tests.schema.json",
+  "title": "UniSpec Tests document",
+  "description": "Executable test cases targeting UniSpec-described services.",
+  "type": "object",
+  "required": ["uniSpecTestsVersion", "target", "tests"],
+  "properties": {
+    "uniSpecTestsVersion": {
+      "type": "string",
+      "description": "UniSpec Tests format version (SemVer)."
+    },
+    "target": {
+      "type": "object",
+      "description": "Service and environment that this test document targets.",
+      "required": ["serviceName"],
+      "properties": {
+        "serviceName": {
+          "type": "string",
+          "description": "Identifier of the service, matching service.name from UniSpec."
+        },
+        "serviceVersion": {
+          "type": "string",
+          "description": "Optional service contract version, matching service.version when provided."
+        },
+        "environment": {
+          "type": "string",
+          "description": "Optional environment name, matching service.environments[].name when provided."
+        }
+      },
+      "additionalProperties": false
+    },
+    "tests": {
+      "type": "array",
+      "description": "List of test cases.",
+      "items": {
+        "$ref": "#/$defs/TestCase"
+      }
+    },
+    "extensions": {
+      "type": "object",
+      "description": "Custom vendor-specific extensions (x-*) at the document root.",
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "TestCase": {
+      "type": "object",
+      "required": ["name", "target", "request", "expect"],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Test identifier, unique within this document."
+        },
+        "description": {
+          "type": "string",
+          "description": "Human-readable description of the test case."
+        },
+        "target": {
+          "$ref": "#/$defs/TestTarget"
+        },
+        "request": {
+          "$ref": "#/$defs/TestRequest"
+        },
+        "expect": {
+          "$ref": "#/$defs/TestExpect"
+        },
+        "tags": {
+          "type": "array",
+          "description": "Tags for grouping and filtering tests.",
+          "items": {
+            "type": "string"
+          }
+        },
+        "extensions": {
+          "type": "object",
+          "description": "Custom vendor-specific extensions (x-*) for this test.",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "TestTarget": {
+      "type": "object",
+      "required": ["protocol", "operationId"],
+      "properties": {
+        "protocol": {
+          "type": "string",
+          "description": "Protocol of the operation under test.",
+          "enum": ["rest", "graphql", "websocket"]
+        },
+        "operationId": {
+          "type": "string",
+          "description": "Operation identifier within the service (for example, REST route name)."
+        },
+        "environment": {
+          "type": "string",
+          "description": "Optional environment name overriding the document-level target.environment."
+        }
+      },
+      "additionalProperties": false
+    },
+    "TestRequest": {
+      "type": "object",
+      "description": "Protocol-specific request definition.",
+      "properties": {
+        "rest": {
+          "$ref": "#/$defs/RestRequest"
+        },
+        "graphql": {
+          "$ref": "#/$defs/GraphQLRequest"
+        },
+        "websocket": {
+          "$ref": "#/$defs/WebSocketRequest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "TestExpect": {
+      "type": "object",
+      "description": "Protocol-specific expectations.",
+      "properties": {
+        "rest": {
+          "$ref": "#/$defs/RestExpect"
+        },
+        "graphql": {
+          "$ref": "#/$defs/GraphQLExpect"
+        },
+        "websocket": {
+          "$ref": "#/$defs/WebSocketExpect"
+        }
+      },
+      "additionalProperties": false
+    },
+    "RestRequest": {
+      "type": "object",
+      "properties": {
+        "params": {
+          "type": "object",
+          "properties": {
+            "path": {
+              "type": "object",
+              "additionalProperties": true
+            },
+            "query": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": false
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": true
+        },
+        "body": {
+          "description": "Request body (arbitrary JSON value)."
+        },
+        "authProfile": {
+          "type": "string",
+          "description": "Identifier of an authentication profile configured in tooling."
+        }
+      },
+      "additionalProperties": false
+    },
+    "RestExpect": {
+      "type": "object",
+      "required": ["status"],
+      "properties": {
+        "status": {
+          "description": "Expected HTTP status code or list of acceptable codes.",
+          "oneOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "integer"
+              }
+            }
+          ]
+        },
+        "headers": {
+          "type": "object",
+          "description": "Expected headers (usually partial match).",
+          "additionalProperties": true
+        },
+        "body": {
+          "$ref": "#/$defs/BodyExpectation"
+        }
+      },
+      "additionalProperties": false
+    },
+    "BodyExpectation": {
+      "type": "object",
+      "properties": {
+        "mode": {
+          "type": "string",
+          "enum": ["exact", "contains", "schemaOnly", "snapshot"],
+          "description": "Assertion mode for the response body."
+        },
+        "json": {
+          "description": "JSON value used for exact or contains mode."
+        },
+        "schemaRef": {
+          "type": "string",
+          "description": "Reference to a schema from service.schemas for schemaOnly mode."
+        }
+      },
+      "additionalProperties": false
+    },
+    "GraphQLRequest": {
+      "type": "object",
+      "properties": {
+        "operationName": {
+          "type": "string"
+        },
+        "query": {
+          "type": "string"
+        },
+        "variables": {
+          "type": "object",
+          "additionalProperties": true
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": true
+        },
+        "authProfile": {
+          "type": "string",
+          "description": "Identifier of an authentication profile configured in tooling."
+        }
+      },
+      "required": ["query"],
+      "additionalProperties": false
+    },
+    "GraphQLExpect": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "description": "Expectations on the data field (exact or partial match)."
+        },
+        "errors": {
+          "description": "Expectations on the errors field."
+        },
+        "bodyMode": {
+          "type": "string",
+          "description": "Optional control over how strictly data and errors are matched."
+        }
+      },
+      "additionalProperties": false
+    },
+    "WebSocketRequest": {
+      "type": "object",
+      "properties": {
+        "channel": {
+          "type": "string",
+          "description": "Channel identifier, matching protocols.websocket.channels[].name."
+        },
+        "direction": {
+          "type": "string",
+          "enum": ["publish", "subscribe", "both"]
+        },
+        "messages": {
+          "type": "array",
+          "description": "Message actions (send/expect) forming a small interaction script.",
+          "items": {
+            "$ref": "#/$defs/WebSocketMessageAction"
+          }
+        },
+        "authProfile": {
+          "type": "string",
+          "description": "Identifier of an authentication profile configured in tooling."
+        }
+      },
+      "required": ["channel"],
+      "additionalProperties": false
+    },
+    "WebSocketMessageAction": {
+      "type": "object",
+      "required": ["type", "messageName"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["send", "expect"],
+          "description": "Whether this action sends or expects a message."
+        },
+        "messageName": {
+          "type": "string",
+          "description": "Name of the message, matching protocols.websocket.channels[].messages[].name."
+        },
+        "payload": {
+          "description": "Payload to send or expected payload structure."
+        }
+      },
+      "additionalProperties": false
+    },
+    "WebSocketExpect": {
+      "type": "object",
+      "properties": {
+        "messages": {
+          "type": "array",
+          "description": "Expected messages to be observed on the channel.",
+          "items": {
+            "$ref": "#/$defs/WebSocketMessageAction"
+          }
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "description": "Timeout for the WebSocket interaction in milliseconds."
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}