PyPI - offering-protocol - Versions diffs - 0.1.0__py3-none-any.whl - Mend

offering-protocol 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (80) hide show

offering_protocol/core/schemas/offering.schema.json ADDED Viewed

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/offering.schema.json",
+  "title": "ODP Full Offering 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
+      }
+    },
+    "web_url": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "collection_ids": {
+      "allOf": [
+        {
+          "$ref": "local-resource-identifier-list.schema.json"
+        },
+        {
+          "minItems": 1
+        }
+      ]
+    },
+    "price": {
+      "$ref": "price-preview.schema.json"
+    },
+    "schema": {
+      "$ref": "attribute-schema-reference.schema.json"
+    },
+    "attributes": {
+      "type": "object",
+      "minProperties": 1
+    },
+    "actions": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "items": {
+        "$ref": "action.schema.json"
+      }
+    }
+  },
+  "dependentRequired": {
+    "attributes": [
+      "schema"
+    ]
+  }
+}

offering_protocol/core/schemas/openapi-action-target.schema.json ADDED Viewed

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/openapi-action-target.schema.json",
+  "title": "ODP OpenAPI Action target",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "operation_id"
+  ],
+  "properties": {
+    "url": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "operation_id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    }
+  }
+}

offering_protocol/core/schemas/operation-descriptor.schema.json ADDED Viewed

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/operation-descriptor.schema.json",
+  "title": "ODP Operation Descriptor",
+  "type": "object",
+  "required": [
+    "authentication",
+    "name"
+  ],
+  "properties": {
+    "authentication": {
+      "$ref": "authentication-requirement.schema.json"
+    },
+    "name": {
+      "enum": [
+        "get-collection",
+        "get-offering",
+        "list-collection-offerings",
+        "list-collections",
+        "list-offerings",
+        "search-collections",
+        "search-offerings"
+      ]
+    }
+  },
+  "additionalProperties": false
+}

offering_protocol/core/schemas/page-envelope.schema.json ADDED Viewed

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

offering_protocol/core/schemas/page-limit.schema.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/page-limit.schema.json",
+  "title": "ODP requested page limit",
+  "type": "integer",
+  "minimum": 1,
+  "maximum": 100
+}

offering_protocol/core/schemas/payment-option.schema.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/payment-option.schema.json",
+  "title": "ODP Payment Option",
+  "type": "string",
+  "enum": [
+    "algorand",
+    "aptos",
+    "arbitrum",
+    "avalanche",
+    "base",
+    "card",
+    "ethereum",
+    "hedera",
+    "inflow",
+    "lightning",
+    "polygon",
+    "solana",
+    "stellar",
+    "stripe",
+    "tempo",
+    "ton"
+  ]
+}

offering_protocol/core/schemas/payment-protocol.schema.json ADDED Viewed

@@ -0,0 +1,34 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/payment-protocol.schema.json",
+  "title": "ODP Payment Protocol Descriptor",
+  "type": "object",
+  "required": [
+    "authentication",
+    "name"
+  ],
+  "properties": {
+    "authentication": {
+      "enum": [
+        "not-required",
+        "required"
+      ]
+    },
+    "name": {
+      "enum": [
+        "mpp",
+        "x402"
+      ]
+    },
+    "options": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 16,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "payment-option.schema.json"
+      }
+    }
+  },
+  "additionalProperties": false
+}

offering_protocol/core/schemas/price-preview.schema.json ADDED Viewed

@@ -0,0 +1,133 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/price-preview.schema.json",
+  "title": "ODP Price Preview",
+  "$defs": {
+    "decimal": {
+      "type": "string",
+      "pattern": "^(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$"
+    },
+    "currency": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64
+    }
+  },
+  "oneOf": [
+    {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "free"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "type",
+        "amount",
+        "currency"
+      ],
+      "properties": {
+        "type": {
+          "enum": [
+            "fixed",
+            "starting_at"
+          ]
+        },
+        "amount": {
+          "$ref": "#/$defs/decimal"
+        },
+        "currency": {
+          "$ref": "#/$defs/currency"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "type",
+        "minimum",
+        "maximum",
+        "currency"
+      ],
+      "properties": {
+        "type": {
+          "const": "range"
+        },
+        "minimum": {
+          "$ref": "#/$defs/decimal"
+        },
+        "maximum": {
+          "$ref": "#/$defs/decimal"
+        },
+        "currency": {
+          "$ref": "#/$defs/currency"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "type",
+        "amount",
+        "currency",
+        "unit"
+      ],
+      "properties": {
+        "type": {
+          "const": "metered"
+        },
+        "amount": {
+          "$ref": "#/$defs/decimal"
+        },
+        "currency": {
+          "$ref": "#/$defs/currency"
+        },
+        "unit": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "quote"
+        }
+      }
+    },
+    {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "not": {
+            "enum": [
+              "free",
+              "fixed",
+              "range",
+              "starting_at",
+              "metered",
+              "quote"
+            ]
+          }
+        }
+      }
+    }
+  ]
+}

offering_protocol/core/schemas/problem-code.schema.json ADDED Viewed

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/problem-code.schema.json",
+  "title": "ODP problem code",
+  "type": "string",
+  "minLength": 1,
+  "maxLength": 64,
+  "pattern": "^[A-Z][A-Z0-9_]*$"
+}

offering_protocol/core/schemas/problem-details.schema.json ADDED Viewed

@@ -0,0 +1,66 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/problem-details.schema.json",
+  "title": "ODP Problem Details",
+  "type": "object",
+  "required": [
+    "type",
+    "title",
+    "status",
+    "code"
+  ],
+  "properties": {
+    "type": {
+      "type": "string",
+      "format": "uri",
+      "pattern": "^https://offeringprotocol\\.org/problems/[a-z0-9][a-z0-9-]*$"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128
+    },
+    "status": {
+      "type": "integer",
+      "minimum": 400,
+      "maximum": 599
+    },
+    "code": {
+      "$ref": "problem-code.schema.json"
+    },
+    "detail": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 2048
+    },
+    "instance": {
+      "type": "string",
+      "format": "uri-reference",
+      "maxLength": 2048
+    },
+    "invalid_params": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": {
+        "$ref": "invalid-parameter.schema.json"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "required": [
+          "invalid_params"
+        ]
+      },
+      "then": {
+        "properties": {
+          "code": {
+            "const": "INVALID_REQUEST"
+          }
+        }
+      }
+    }
+  ]
+}

offering_protocol/core/schemas/protocol-version.schema.json ADDED Viewed

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/protocol-version.schema.json",
+  "title": "ODP protocol version",
+  "description": "The major and minor version governing one top-level ODP document.",
+  "type": "string",
+  "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)$"
+}

offering_protocol/core/schemas/refinement-bucket.schema.json ADDED Viewed

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/refinement-bucket.schema.json",
+  "title": "ODP Refinement Bucket",
+  "type": "object",
+  "required": [
+    "value",
+    "count"
+  ],
+  "properties": {
+    "value": {
+      "type": [
+        "string",
+        "boolean",
+        "integer",
+        "number"
+      ]
+    },
+    "count": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "count_relation": {
+      "const": "lower_bound"
+    }
+  }
+}

offering_protocol/core/schemas/refinement-group.schema.json ADDED Viewed

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/refinement-group.schema.json",
+  "title": "ODP Refinement Group",
+  "type": "object",
+  "required": [
+    "filter_id",
+    "values"
+  ],
+  "properties": {
+    "filter_id": {
+      "$ref": "capability-identifier.schema.json"
+    },
+    "values": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "refinement-bucket.schema.json"
+      }
+    }
+  }
+}

offering_protocol/core/schemas/representation.schema.json ADDED Viewed

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/representation.schema.json",
+  "title": "ODP representation selection",
+  "description": "The requested completeness level for Collection or Offering representations.",
+  "type": "string",
+  "enum": [
+    "terse",
+    "full"
+  ]
+}

offering_protocol/core/schemas/resource-identity.schema.json ADDED Viewed

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/resource-identity.schema.json",
+  "title": "ODP resource identity",
+  "description": "The structured identity composed by an Agent from Service origin, resource type, and local identifier.",
+  "type": "object",
+  "required": [
+    "service",
+    "type",
+    "id"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "service": {
+      "$ref": "service-origin.schema.json"
+    },
+    "type": {
+      "enum": [
+        "collection",
+        "offering"
+      ]
+    },
+    "id": {
+      "$ref": "local-resource-identifier.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/resource-image.schema.json ADDED Viewed

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/resource-image.schema.json",
+  "title": "ODP Resource image",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "src"
+  ],
+  "properties": {
+    "alt": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 1024
+    },
+    "height": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 65535
+    },
+    "src": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "image/avif",
+        "image/jpeg",
+        "image/png",
+        "image/svg+xml",
+        "image/webp"
+      ]
+    },
+    "width": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 65535
+    }
+  }
+}

offering_protocol/core/schemas/resource-reference.schema.json ADDED Viewed

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/resource-reference.schema.json",
+  "title": "ODP resource reference",
+  "description": "An origin-relative absolute-path reference or an absolute HTTPS URL, with loopback HTTP allowed for development.",
+  "type": "string",
+  "format": "uri-reference",
+  "anyOf": [
+    {
+      "pattern": "^/(?!/)[^#]*$"
+    },
+    {
+      "pattern": "^https://(?![^/?#]*@)[^#]+$"
+    },
+    {
+      "pattern": "^http://(?:localhost|127\\.0\\.0\\.1|\\[::1\\])(?::[0-9]+)?(?:/[^#]*)?$"
+    }
+  ]
+}

offering_protocol/core/schemas/schema-reference.schema.json ADDED Viewed

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

offering_protocol/core/schemas/search-capabilities.schema.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/search-capabilities.schema.json",
+  "title": "ODP search capability advertisement",
+  "type": "object",
+  "anyOf": [
+    {
+      "required": [
+        "filters"
+      ]
+    },
+    {
+      "required": [
+        "sorts"
+      ]
+    }
+  ],
+  "properties": {
+    "filters": {
+      "$ref": "filter-capability-source.schema.json"
+    },
+    "sorts": {
+      "$ref": "sort-capability-source.schema.json"
+    }
+  }
+}

offering_protocol/core/schemas/service-branding-image.schema.json ADDED Viewed

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://offeringprotocol.org/schemas/service-branding-image.schema.json",
+  "title": "ODP Service branding image",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "src"
+  ],
+  "properties": {
+    "src": {
+      "$ref": "resource-reference.schema.json"
+    },
+    "type": {
+      "type": "string",
+      "enum": [
+        "image/png",
+        "image/svg+xml",
+        "image/webp"
+      ]
+    }
+  }
+}