@opensoha/contracts 0.1.4

package/openapi/spec_generated.go

@@ -0,0 +1,23 @@
+// Code generated from OpenSoha contracts. DO NOT EDIT.
+
+package openapi
+
+import _ "embed"
+
+const (
+	Version    = "0.1.4"
+	YAMLSHA256 = "09e3b9d0e56d0fa64dec6ca3a631a15cea6c8837fdcd1efe6866d9f2b7163e1a"
+	JSONSHA256 = "677e1cf4de13bb9888f4af32c773ff47c8937312bcf04da764477b7b3c711aab"
+)
+
+//go:embed soha-api.yaml
+var yamlSpec []byte
+
+//go:embed soha-api.json
+var jsonSpec []byte
+
+// YAML returns a copy of the canonical OpenAPI YAML document.
+func YAML() []byte { return append([]byte(nil), yamlSpec...) }
+
+// JSON returns a copy of the canonical OpenAPI JSON document.
+func JSON() []byte { return append([]byte(nil), jsonSpec...) }

package/openapi/spec_test.go

@@ -0,0 +1,38 @@
+package openapi
+
+import (
+	"crypto/sha256"
+	"encoding/json"
+	"fmt"
+	"testing"
+)
+
+func TestEmbeddedSpecsMatchMetadata(t *testing.T) {
+	for _, test := range []struct {
+		name string
+		body []byte
+		want string
+	}{
+		{name: "yaml", body: YAML(), want: YAMLSHA256},
+		{name: "json", body: JSON(), want: JSONSHA256},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			got := fmt.Sprintf("%x", sha256.Sum256(test.body))
+			if got != test.want {
+				t.Fatalf("sha256 = %s, want %s", got, test.want)
+			}
+		})
+	}
+
+	var document struct {
+		Info struct {
+			Version string `json:"version"`
+		} `json:"info"`
+	}
+	if err := json.Unmarshal(JSON(), &document); err != nil {
+		t.Fatalf("decode embedded JSON: %v", err)
+	}
+	if document.Info.Version != Version {
+		t.Fatalf("info.version = %q, want %q", document.Info.Version, Version)
+	}
+}

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@opensoha/contracts",
+  "version": "0.1.4",
+  "private": false,
+  "description": "Shared OpenSoha API, agent, MCP, skill, event, and auth contracts.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/opensoha/soha-contracts"
+  },
+  "type": "module",
+  "scripts": {
+    "generate": "node scripts/generate-sdk.mjs",
+    "check:generated": "node scripts/generate-sdk.mjs --check",
+    "check:version-sync": "node scripts/check-version-sync.mjs",
+    "check:consumers": "node scripts/check-consumers.mjs",
+    "validate": "node scripts/validate.mjs",
+    "lint:openapi": "node scripts/lint-openapi.mjs",
+    "check:openapi-breaking": "node scripts/check-openapi-breaking.mjs",
+    "check:openapi-loose-boundaries": "node scripts/check-openapi-loose-boundaries.mjs",
+    "check:json-schema-compat": "node scripts/check-json-schema-compat.mjs",
+    "check:openapi-breaking:update": "node scripts/check-openapi-breaking.mjs --update-baseline",
+    "release:artifacts": "node scripts/prepare-release-artifacts.mjs",
+    "release:verify": "node scripts/prepare-release-artifacts.mjs --verify",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "npm run check:version-sync && npm run check:generated && npm run validate && npm run lint:openapi && npm run check:openapi-breaking && npm run check:openapi-loose-boundaries && npm run check:json-schema-compat && npm run typecheck && go test ./..."
+  },
+  "exports": {
+    "./gen/ts/sohaapi": "./gen/ts/sohaapi/index.ts",
+    "./openapi/soha-api.yaml": "./openapi/soha-api.yaml",
+    "./openapi/soha-api.json": "./openapi/soha-api.json",
+    "./capabilities/cluster-capability-matrix.schema.json": "./capabilities/cluster-capability-matrix.schema.json",
+    "./profiles/agent-profile.schema.json": "./profiles/agent-profile.schema.json",
+    "./presets/mcp-preset.schema.json": "./presets/mcp-preset.schema.json",
+    "./governance/approval-request.schema.json": "./governance/approval-request.schema.json",
+    "./governance/audit-log.schema.json": "./governance/audit-log.schema.json",
+    "./agent/agent-protocol.schema.json": "./agent/agent-protocol.schema.json",
+    "./agent/agent-provider-definition.schema.json": "./agent/agent-provider-definition.schema.json",
+    "./agent/agent-provider-registry.schema.json": "./agent/agent-provider-registry.schema.json",
+    "./agent/agent-run-step.schema.json": "./agent/agent-run-step.schema.json",
+    "./agent/agent-observation.schema.json": "./agent/agent-observation.schema.json",
+    "./agent/agent-checkpoint.schema.json": "./agent/agent-checkpoint.schema.json",
+    "./agent/environment-lease.schema.json": "./agent/environment-lease.schema.json",
+    "./agent/environment-snapshot.schema.json": "./agent/environment-snapshot.schema.json",
+    "./agent/agent-provider-runtime-event.schema.json": "./agent/agent-provider-runtime-event.schema.json",
+    "./evaluation/evaluation-dataset.schema.json": "./evaluation/evaluation-dataset.schema.json",
+    "./evaluation/evaluation-run.schema.json": "./evaluation/evaluation-run.schema.json",
+    "./evaluation/evaluation-result.schema.json": "./evaluation/evaluation-result.schema.json",
+    "./runner/operation-lifecycle.schema.json": "./runner/operation-lifecycle.schema.json",
+    "./mcp/gateway-manifest.schema.json": "./mcp/gateway-manifest.schema.json",
+    "./mcp/gateway-capability-baseline.schema.json": "./mcp/gateway-capability-baseline.schema.json",
+    "./skills/skill-manifest.schema.json": "./skills/skill-manifest.schema.json",
+    "./plugins/plugin-manifest.schema.json": "./plugins/plugin-manifest.schema.json",
+    "./plugins/marketplace-catalog.schema.json": "./plugins/marketplace-catalog.schema.json",
+    "./events/event-envelope.schema.json": "./events/event-envelope.schema.json",
+    "./auth/token-claims.schema.json": "./auth/token-claims.schema.json",
+    "./connectors/connector-event-envelope.schema.json": "./connectors/connector-event-envelope.schema.json",
+    "./knowledge/knowledge-base.schema.json": "./knowledge/knowledge-base.schema.json",
+    "./knowledge/knowledge-source.schema.json": "./knowledge/knowledge-source.schema.json",
+    "./knowledge/knowledge-search.schema.json": "./knowledge/knowledge-search.schema.json",
+    "./knowledge/context-envelope.schema.json": "./knowledge/context-envelope.schema.json",
+    "./knowledge/connector-definition.schema.json": "./knowledge/connector-definition.schema.json",
+    "./knowledge/connector-checkpoint.schema.json": "./knowledge/connector-checkpoint.schema.json",
+    "./knowledge/ingestion-job.schema.json": "./knowledge/ingestion-job.schema.json",
+    "./knowledge/ingestion-stage.schema.json": "./knowledge/ingestion-stage.schema.json",
+    "./knowledge/index-publish.schema.json": "./knowledge/index-publish.schema.json",
+    "./knowledge/retrieval-trace.schema.json": "./knowledge/retrieval-trace.schema.json",
+    "./knowledge/graph-revision.schema.json": "./knowledge/graph-revision.schema.json",
+    "./agent/fleet-target.schema.json": "./agent/fleet-target.schema.json",
+    "./agent/provider-rollout.schema.json": "./agent/provider-rollout.schema.json",
+    "./agent/conformance-run.schema.json": "./agent/conformance-run.schema.json",
+    "./agent/environment-template.schema.json": "./agent/environment-template.schema.json",
+    "./agent/multi-agent-plan.schema.json": "./agent/multi-agent-plan.schema.json",
+    "./evaluation/executor-profile.schema.json": "./evaluation/executor-profile.schema.json",
+    "./evaluation/sample-attempt.schema.json": "./evaluation/sample-attempt.schema.json",
+    "./evaluation/replay-plan.schema.json": "./evaluation/replay-plan.schema.json",
+    "./evaluation/gate-policy.schema.json": "./evaluation/gate-policy.schema.json",
+    "./evaluation/gate-decision.schema.json": "./evaluation/gate-decision.schema.json",
+    "./evaluation/feedback-sample.schema.json": "./evaluation/feedback-sample.schema.json",
+    "./memory/memory-record.schema.json": "./memory/memory-record.schema.json",
+    "./memory/memory-policy.schema.json": "./memory/memory-policy.schema.json"
+  },
+  "files": [
+    "COMPATIBILITY.md",
+    "go.mod",
+    "go.sum",
+    "apiresponse",
+    "helmrelease",
+    "resource",
+    "streamlimit",
+    "compat",
+    "examples",
+    "fixtures",
+    "gen",
+    "openapi",
+    "capabilities",
+    "profiles",
+    "presets",
+    "governance",
+    "agent",
+    "evaluation",
+    "runner",
+    "mcp",
+    "skills",
+    "plugins",
+    "events",
+    "auth",
+    "connectors",
+    "knowledge",
+    "memory"
+  ],
+  "devDependencies": {
+    "ajv": "^8.20.0",
+    "ajv-formats": "^3.0.1",
+    "openapi-typescript": "^7.13.0",
+    "typescript": "^5.9.3",
+    "yaml": "^2.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/plugins/marketplace-catalog.schema.json

@@ -0,0 +1,120 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://contracts.opensoha.dev/plugins/marketplace-catalog.schema.json",
+  "title": "OpenSoha Marketplace Catalog",
+  "type": "object",
+  "required": ["schemaVersion", "generatedAt", "sourceId", "plugins"],
+  "properties": {
+    "schemaVersion": { "type": "string", "const": "marketplace.opensoha.io/v1" },
+    "generatedAt": { "type": "string", "format": "date-time" },
+    "sourceId": { "type": "string", "minLength": 1 },
+    "sourceUrl": { "type": "string" },
+    "plugins": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/plugin" }
+    },
+    "advisories": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/advisory" }
+    },
+    "metadata": {
+      "type": "object",
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "plugin": {
+      "type": "object",
+      "required": ["id", "name", "version", "publisher", "type", "source", "manifest"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "name": { "type": "string", "minLength": 1 },
+        "version": { "type": "string", "minLength": 1 },
+        "publisher": { "type": "string", "minLength": 1 },
+        "type": { "type": "string" },
+        "summary": { "type": "string" },
+        "source": { "type": "string" },
+        "sourceId": { "type": "string" },
+        "sourceUrl": { "type": "string" },
+        "riskLevel": { "type": "string" },
+        "latestVersion": { "type": "string" },
+        "categories": { "type": "array", "items": { "type": "string" } },
+        "verified": { "type": "boolean" },
+        "publisherInfo": { "$ref": "#/$defs/publisher" },
+        "compatibility": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        },
+        "versions": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/version" }
+        },
+        "advisories": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/advisory" }
+        },
+        "deprecated": { "type": "boolean" },
+        "suspended": { "type": "boolean" },
+        "manifest": {
+          "type": "object",
+          "additionalProperties": true
+        },
+        "installed": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    },
+    "publisher": {
+      "type": "object",
+      "required": ["id", "name"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "name": { "type": "string", "minLength": 1 },
+        "verified": { "type": "boolean" },
+        "verificationLevel": {
+          "type": "string",
+          "enum": ["official", "verified", "community", "private"]
+        },
+        "url": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "version": {
+      "type": "object",
+      "required": ["version", "manifestUrl"],
+      "properties": {
+        "version": { "type": "string", "minLength": 1 },
+        "manifestUrl": { "type": "string", "minLength": 1 },
+        "packageUrl": { "type": "string" },
+        "checksum": { "type": "string" },
+        "signature": { "type": "string" },
+        "publishedAt": { "type": "string", "format": "date-time" },
+        "deprecated": { "type": "boolean" },
+        "suspended": { "type": "boolean" },
+        "minSohaVersion": { "type": "string" },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "additionalProperties": false
+    },
+    "advisory": {
+      "type": "object",
+      "required": ["id", "severity", "summary"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "severity": {
+          "type": "string",
+          "enum": ["low", "medium", "high", "critical"]
+        },
+        "summary": { "type": "string", "minLength": 1 },
+        "url": { "type": "string" },
+        "publishedAt": { "type": "string", "format": "date-time" },
+        "affectedVersions": { "type": "array", "items": { "type": "string" } },
+        "withdrawn": { "type": "boolean" }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false
+}

package/plugins/observability-log-query-v1.schema.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://contracts.opensoha.dev/plugins/observability-log-query-v1.schema.json",
+  "title": "OpenSoha Observability Provider logs.query v1",
+  "description": "Versioned request and response contract for an observability provider logs.query action.",
+  "oneOf": [
+    { "$ref": "#/$defs/Request" },
+    { "$ref": "#/$defs/Response" }
+  ],
+  "$defs": {
+    "Request": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocolVersion", "providerKey", "sourceId", "config", "query"],
+      "properties": {
+        "protocolVersion": { "const": "v1" },
+        "providerKey": { "type": "string", "pattern": "^[a-z][a-z0-9._-]*$" },
+        "sourceId": { "type": "string", "minLength": 1 },
+        "config": { "type": "object", "additionalProperties": true },
+        "credentials": {
+          "type": "object",
+          "propertyNames": { "pattern": "^[a-z][a-z0-9._-]*$" },
+          "additionalProperties": { "type": "string" }
+        },
+        "query": { "$ref": "#/$defs/Query" }
+      }
+    },
+    "Query": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["scope", "timeFrom", "timeTo", "limit", "direction"],
+      "properties": {
+        "scope": { "$ref": "#/$defs/Scope" },
+        "timeFrom": { "type": "string", "format": "date-time" },
+        "timeTo": { "type": "string", "format": "date-time" },
+        "query": { "type": "string" },
+        "terms": { "type": "array", "items": { "type": "string" } },
+        "severities": { "type": "array", "items": { "type": "string" } },
+        "limit": { "type": "integer", "minimum": 1 },
+        "direction": { "type": "string", "enum": ["forward", "backward"] },
+        "pageToken": { "type": "string" }
+      }
+    },
+    "Scope": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "clusterId": { "type": "string" },
+        "namespace": { "type": "string" },
+        "service": { "type": "string" },
+        "workload": { "type": "string" },
+        "pod": { "type": "string" },
+        "container": { "type": "string" },
+        "containers": { "type": "array", "uniqueItems": true, "items": { "type": "string" } }
+      }
+    },
+    "Response": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["records", "truncated"],
+      "properties": {
+        "sourceId": { "type": "string" },
+        "records": { "type": "array", "items": { "$ref": "#/$defs/Record" } },
+        "nextPageToken": { "type": "string" },
+        "truncated": { "type": "boolean" },
+        "queryCost": { "type": "object", "additionalProperties": true },
+        "errorKind": { "type": "string" }
+      }
+    },
+    "Record": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["timestamp", "message"],
+      "properties": {
+        "timestamp": { "type": "string", "format": "date-time" },
+        "severity": { "type": "string" },
+        "message": { "type": "string" },
+        "service": { "type": "string" },
+        "workload": { "type": "string" },
+        "namespace": { "type": "string" },
+        "clusterId": { "type": "string" },
+        "pod": { "type": "string" },
+        "container": { "type": "string" },
+        "attributes": { "type": "object", "additionalProperties": true }
+      }
+    }
+  }
+}