offering-protocol 0.1.0__py3-none-any.whl

offering_protocol/core/schemas/authentication-requirement.schema.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/authentication-requirement.schema.json",
+  "title": "ODP Authentication Requirement",
+  "type": "string",
+  "enum": [
+    "not-required",
+    "optional",
+    "required"
+  ]
+}

offering_protocol/core/schemas/capability-identifier.schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/capability-identifier.schema.json",
+  "title": "ODP Service-local capability identifier",
+  "type": "string",
+  "minLength": 1,
+  "maxLength": 64,
+  "pattern": "^[A-Za-z0-9._~-]+$"
+}

offering_protocol/core/schemas/capability-link.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/capability-link.schema.json",
+  "title": "ODP linked capability source",
+  "type": "object",
+  "required": [
+    "href"
+  ],
+  "properties": {
+    "href": {
+      "$ref": "resource-reference.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/collection-search-request.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/collection-search-request.schema.json",
+  "title": "ODP Collection search request",
+  "type": "object",
+  "required": [
+    "odp_version"
+  ],
+  "anyOf": [
+    {
+      "required": [
+        "query"
+      ]
+    },
+    {
+      "required": [
+        "parent_id"
+      ]
+    }
+  ],
+  "properties": {
+    "odp_version": {
+      "const": "1.0"
+    },
+    "query": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "\\S"
+    },
+    "parent_id": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "local-resource-identifier.schema.json"
+        }
+      ]
+    },
+    "limit": {
+      "$ref": "page-limit.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/collection.schema.json

@@ -0,0 +1,72 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/collection.schema.json",
+  "title": "ODP Full Collection Representation",
+  "type": "object",
+  "required": [
+    "odp_version",
+    "id",
+    "name"
+  ],
+  "properties": {
+    "auth_expands": {
+      "const": true
+    },
+    "odp_version": {
+      "const": "1.0"
+    },
+    "id": {
+      "$ref": "local-resource-identifier.schema.json"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "images": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "items": {
+        "$ref": "resource-image.schema.json"
+      }
+    },
+    "language": {
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 35
+    },
+    "localizations": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 2,
+        "maxLength": 35
+      }
+    },
+    "parent_ids": {
+      "allOf": [
+        {
+          "$ref": "local-resource-identifier-list.schema.json"
+        },
+        {
+          "minItems": 1
+        }
+      ]
+    },
+    "web_url": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "search_capabilities": {
+      "$ref": "search-capabilities.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/detail-fields.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/detail-fields.schema.json",
+  "title": "ODP detail fields",
+  "description": "An exhaustive bounded list of fields present in a Full Representation and omitted from a Terse Representation.",
+  "type": "array",
+  "minItems": 1,
+  "maxItems": 32,
+  "uniqueItems": true,
+  "items": {
+    "type": "string",
+    "minLength": 1,
+    "maxLength": 256,
+    "pattern": "^(?:/(?:[\\x20-\\x2E\\x30-\\x7D]|~[01])*)+$"
+  }
+}

offering_protocol/core/schemas/enrollment-protocol.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/enrollment-protocol.schema.json",
+  "title": "ODP Enrollment Protocol Descriptor",
+  "type": "object",
+  "required": [
+    "name"
+  ],
+  "properties": {
+    "name": {
+      "const": "aep"
+    }
+  },
+  "additionalProperties": false
+}

offering_protocol/core/schemas/filter-capability-source.schema.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-capability-source.schema.json",
+  "title": "ODP Filter Definition source",
+  "type": "object",
+  "oneOf": [
+    {
+      "required": [
+        "inline"
+      ],
+      "not": {
+        "required": [
+          "linked"
+        ]
+      }
+    },
+    {
+      "required": [
+        "linked"
+      ],
+      "not": {
+        "required": [
+          "inline"
+        ]
+      }
+    }
+  ],
+  "properties": {
+    "inline": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {
+        "$ref": "filter-definition.schema.json"
+      }
+    },
+    "linked": {
+      "$ref": "capability-link.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/filter-definition-page.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-definition-page.schema.json",
+  "title": "ODP Filter Definition page",
+  "type": "object",
+  "required": [
+    "odp_version",
+    "items"
+  ],
+  "properties": {
+    "odp_version": {
+      "const": "1.0"
+    },
+    "items": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "$ref": "filter-definition.schema.json"
+      }
+    },
+    "next": {
+      "$ref": "resource-reference.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/filter-definition.schema.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-definition.schema.json",
+  "title": "ODP Filter Definition",
+  "type": "object",
+  "required": [
+    "id",
+    "title",
+    "description",
+    "type",
+    "operators"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "type": {
+      "$ref": "filter-type.schema.json"
+    },
+    "operators": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 7,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "filter-operator.schema.json"
+      }
+    },
+    "unit": {
+      "$ref": "filter-unit.schema.json"
+    },
+    "refinable": {
+      "const": true
+    }
+  },
+  "if": {
+    "required": [
+      "refinable"
+    ]
+  },
+  "then": {
+    "properties": {
+      "operators": {
+        "contains": {
+          "enum": [
+            "eq",
+            "in"
+          ]
+        }
+      }
+    }
+  }
+}

offering_protocol/core/schemas/filter-expression.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-expression.schema.json",
+  "title": "ODP Filter Expression",
+  "type": "object",
+  "required": [
+    "id",
+    "operator",
+    "value"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "operator": {
+      "$ref": "filter-operator.schema.json"
+    },
+    "value": {
+      "oneOf": [
+        {
+          "type": [
+            "string",
+            "boolean",
+            "integer",
+            "number"
+          ]
+        },
+        {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": {
+            "type": [
+              "string",
+              "boolean",
+              "integer",
+              "number"
+            ]
+          }
+        }
+      ]
+    }
+  }
+}

offering_protocol/core/schemas/filter-operator.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-operator.schema.json",
+  "title": "ODP filter operator",
+  "enum": [
+    "eq",
+    "in",
+    "lt",
+    "lte",
+    "gt",
+    "gte",
+    "exists"
+  ]
+}

offering_protocol/core/schemas/filter-type.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-type.schema.json",
+  "title": "ODP filter value type",
+  "enum": [
+    "string",
+    "boolean",
+    "integer",
+    "number",
+    "decimal",
+    "date",
+    "date-time"
+  ]
+}

offering_protocol/core/schemas/filter-unit.schema.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/filter-unit.schema.json",
+  "title": "ODP filter unit",
+  "oneOf": [
+    {
+      "type": "object",
+      "required": [
+        "system",
+        "code"
+      ],
+      "properties": {
+        "system": {
+          "const": "ucum"
+        },
+        "code": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "system",
+        "code",
+        "title"
+      ],
+      "properties": {
+        "system": {
+          "const": "service"
+        },
+        "code": {
+          "$ref": "capability-identifier.schema.json"
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        }
+      }
+    }
+  ]
+}

offering_protocol/core/schemas/http-action-target.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/http-action-target.schema.json",
+  "title": "ODP compact HTTP Action target",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "href",
+    "method"
+  ],
+  "properties": {
+    "href": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "method": {
+      "enum": [
+        "GET",
+        "POST"
+      ]
+    },
+    "request": {
+      "$ref": "action-request.schema.json"
+    },
+    "response_content_types": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 8,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 255
+      }
+    }
+  }
+}

offering_protocol/core/schemas/invalid-parameter.schema.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/invalid-parameter.schema.json",
+  "title": "ODP invalid parameter",
+  "type": "object",
+  "required": [
+    "in",
+    "name",
+    "reason"
+  ],
+  "properties": {
+    "in": {
+      "enum": [
+        "query",
+        "body",
+        "header",
+        "path"
+      ]
+    },
+    "name": {
+      "type": "string",
+      "maxLength": 256
+    },
+    "reason": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "in": {
+            "const": "body"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "name": {
+            "pattern": "^(?:|/(?:[^~/]|~[01])*)*$"
+          }
+        }
+      },
+      "else": {
+        "properties": {
+          "name": {
+            "minLength": 1
+          }
+        }
+      }
+    }
+  ]
+}

offering_protocol/core/schemas/local-resource-identifier-list.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/local-resource-identifier-list.schema.json",
+  "title": "ODP local resource identifier list",
+  "type": "array",
+  "uniqueItems": true,
+  "items": {
+    "$ref": "local-resource-identifier.schema.json"
+  }
+}

offering_protocol/core/schemas/local-resource-identifier.schema.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/local-resource-identifier.schema.json",
+  "title": "ODP local resource identifier",
+  "description": "A path-safe Service-created identifier scoped by Service origin and resource type.",
+  "type": "string",
+  "minLength": 1,
+  "maxLength": 128,
+  "pattern": "^(?!\\.{1,2}$)[A-Za-z0-9._~-]+$"
+}

offering_protocol/core/schemas/mcp-endpoint.schema.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/mcp-endpoint.schema.json",
+  "title": "ODP MCP Endpoint Descriptor",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "type",
+    "url"
+  ],
+  "properties": {
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "type": {
+      "const": "streamable-http"
+    },
+    "url": {
+      "$ref": "resource-reference.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/offering-search-request.schema.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/offering-search-request.schema.json",
+  "title": "ODP Offering search request",
+  "type": "object",
+  "required": [
+    "odp_version"
+  ],
+  "anyOf": [
+    {
+      "required": [
+        "query"
+      ]
+    },
+    {
+      "required": [
+        "filters"
+      ]
+    }
+  ],
+  "dependentRequired": {
+    "include_descendants": [
+      "collection_id"
+    ]
+  },
+  "properties": {
+    "odp_version": {
+      "const": "1.0"
+    },
+    "query": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "pattern": "\\S"
+    },
+    "filters": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "filter-expression.schema.json"
+      }
+    },
+    "collection_id": {
+      "$ref": "local-resource-identifier.schema.json"
+    },
+    "include_descendants": {
+      "type": "boolean",
+      "default": false
+    },
+    "sort": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "refinements": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "capability-identifier.schema.json"
+      }
+    },
+    "limit": {
+      "$ref": "page-limit.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/offering-search-response.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/offering-search-response.schema.json",
+  "title": "ODP Offering search response",
+  "allOf": [
+    {
+      "$ref": "page-envelope.schema.json"
+    }
+  ],
+  "properties": {
+    "refinements": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "items": {
+        "$ref": "refinement-group.schema.json"
+      }
+    }
+  }
+}