offering-protocol 0.1.0__py3-none-any.whl

offering_protocol/core/schemas/service-branding.schema.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-branding.schema.json",
+  "title": "ODP Service branding",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "icon",
+    "logo"
+  ],
+  "properties": {
+    "icon": {
+      "$ref": "service-branding-image.schema.json"
+    },
+    "logo": {
+      "$ref": "service-branding-image.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/service-document.schema.json

@@ -0,0 +1,337 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-document.schema.json",
+  "title": "ODP Service Document",
+  "type": "object",
+  "required": [
+    "odp_version",
+    "name",
+    "description",
+    "language",
+    "localizations",
+    "operations",
+    "http"
+  ],
+  "properties": {
+    "odp_version": {
+      "const": "1.0"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "documentation_url": {
+      "$ref": "resource-reference.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
+      }
+    },
+    "mcp": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "mcp-endpoint.schema.json"
+      }
+    },
+    "keywords": {
+      "type": "array",
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 64,
+        "pattern": "^\\S(?:[\\s\\S]*\\S)?$"
+      }
+    },
+    "branding": {
+      "$ref": "service-branding.schema.json"
+    },
+    "operations": {
+      "type": "array",
+      "minItems": 2,
+      "maxItems": 7,
+      "allOf": [
+        {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "list-offerings"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          }
+        },
+        {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "get-offering"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          }
+        }
+      ],
+      "items": {
+        "$ref": "operation-descriptor.schema.json"
+      }
+    },
+    "http": {
+      "type": "object",
+      "required": [
+        "endpoint_base"
+      ],
+      "properties": {
+        "endpoint_base": {
+          "type": "string",
+          "maxLength": 2048,
+          "pattern": "^/(?!/)[A-Za-z0-9._~!$&'()*+,;=:@%/-]*$"
+        },
+        "openapi": {
+          "$ref": "service-openapi.schema.json"
+        }
+      }
+    },
+    "protocols": {
+      "$ref": "service-protocols.schema.json"
+    },
+    "payment_origins": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "items": {
+        "$ref": "service-origin.schema.json"
+      }
+    },
+    "search_capabilities": {
+      "$ref": "search-capabilities.schema.json"
+    },
+    "status_url": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "support_url": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "website_url": {
+      "$ref": "resource-reference.schema.json"
+    }
+  },
+  "allOf": [
+    {
+      "$ref": "#/$defs/unique-operation-names"
+    },
+    {
+      "if": {
+        "properties": {
+          "operations": {
+            "contains": {
+              "properties": {
+                "authentication": {
+                  "enum": [
+                    "optional",
+                    "required"
+                  ]
+                }
+              },
+              "required": [
+                "authentication"
+              ]
+            }
+          }
+        },
+        "required": [
+          "operations"
+        ]
+      },
+      "then": {
+        "properties": {
+          "protocols": {
+            "required": [
+              "enrollment"
+            ]
+          }
+        },
+        "required": [
+          "protocols"
+        ]
+      }
+    }
+  ],
+  "$defs": {
+    "unique-operation-names": {
+      "allOf": [
+        {
+          "$ref": "#/$defs/at-most-one-get-collection"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-get-offering"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-list-collection-offerings"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-list-collections"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-list-offerings"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-search-collections"
+        },
+        {
+          "$ref": "#/$defs/at-most-one-search-offerings"
+        }
+      ]
+    },
+    "at-most-one-get-collection": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "get-collection"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-get-offering": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "get-offering"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-list-collection-offerings": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "list-collection-offerings"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-list-collections": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "list-collections"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-list-offerings": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "list-offerings"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-search-collections": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "search-collections"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    "at-most-one-search-offerings": {
+      "properties": {
+        "operations": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "search-offerings"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    }
+  }
+}

offering_protocol/core/schemas/service-openapi.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-openapi.schema.json",
+  "title": "ODP Service OpenAPI reference",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "url"
+  ],
+  "properties": {
+    "url": {
+      "$ref": "resource-reference.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/service-origin.schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-origin.schema.json",
+  "title": "ODP Service origin",
+  "description": "The canonical serialized origin of the final ODP Service Document URL.",
+  "type": "string",
+  "format": "uri",
+  "pattern": "^(?:https://(?![^/?#]*@)(?:[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?|\\[[0-9a-f:]+\\])(?::(?!443$)[0-9]{1,5})?|http://(?:localhost|127\\.0\\.0\\.1|\\[::1\\])(?::(?!80$)[0-9]{1,5})?)$"
+}

offering_protocol/core/schemas/service-protocols.schema.json

@@ -0,0 +1,101 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-protocols.schema.json",
+  "title": "ODP Service protocol support",
+  "type": "object",
+  "minProperties": 1,
+  "properties": {
+    "enrollment": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "enrollment-protocol.schema.json"
+      }
+    },
+    "payments": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 2,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "payment-protocol.schema.json"
+      }
+    },
+    "trust": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "trust-protocol.schema.json"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "properties": {
+        "payments": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "mpp"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    {
+      "properties": {
+        "payments": {
+          "contains": {
+            "properties": {
+              "name": {
+                "const": "x402"
+              }
+            },
+            "required": [
+              "name"
+            ]
+          },
+          "minContains": 0,
+          "maxContains": 1
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "payments": {
+            "contains": {
+              "properties": {
+                "authentication": {
+                  "const": "required"
+                }
+              },
+              "required": [
+                "authentication"
+              ]
+            }
+          }
+        },
+        "required": [
+          "payments"
+        ]
+      },
+      "then": {
+        "required": [
+          "enrollment"
+        ]
+      }
+    }
+  ],
+  "additionalProperties": false
+}

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

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

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

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

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

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/sort-definition.schema.json",
+  "title": "ODP Sort Definition",
+  "type": "object",
+  "required": [
+    "id",
+    "title",
+    "description",
+    "keys"
+  ],
+  "properties": {
+    "id": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "keys": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 3,
+      "items": {
+        "$ref": "sort-key.schema.json"
+      }
+    }
+  }
+}

offering_protocol/core/schemas/sort-key.schema.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/sort-key.schema.json",
+  "title": "ODP Sort Key",
+  "type": "object",
+  "required": [
+    "filter_id",
+    "direction",
+    "missing"
+  ],
+  "properties": {
+    "filter_id": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "direction": {
+      "enum": [
+        "ascending",
+        "descending"
+      ]
+    },
+    "missing": {
+      "enum": [
+        "first",
+        "last"
+      ]
+    }
+  }
+}

offering_protocol/core/schemas/top-level-document.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/top-level-document.schema.json",
+  "title": "ODP top-level document",
+  "description": "The version-bearing envelope shared by top-level ODP request and response documents.",
+  "type": "object",
+  "required": [
+    "odp_version"
+  ],
+  "additionalProperties": true,
+  "properties": {
+    "odp_version": {
+      "$ref": "protocol-version.schema.json"
+    }
+  }
+}

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

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