@authorizedretailers/spec 0.1.1 → 0.2.0

package/schemas/0.2/list.json

@@ -0,0 +1,87 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/list.json",
+  "title": "Signed list (section 5.2)",
+  "type": "object",
+  "required": [
+    "spec",
+    "brand",
+    "public",
+    "issued",
+    "valid_until",
+    "stale_until",
+    "signature"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "spec": {
+      "$ref": "common.json#/$defs/specVersion"
+    },
+    "brand": {
+      "$ref": "common.json#/$defs/listBrand"
+    },
+    "public": {
+      "type": "boolean"
+    },
+    "issued": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "valid_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "stale_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "catalog": {
+      "type": "array",
+      "items": {
+        "$ref": "common.json#/$defs/product"
+      }
+    },
+    "exclusions": {
+      "$ref": "common.json#/$defs/exclusions"
+    },
+    "authorizations": {
+      "type": "array",
+      "items": {
+        "$ref": "common.json#/$defs/authorization"
+      }
+    },
+    "signature": {
+      "$ref": "common.json#/$defs/signature"
+    }
+  },
+  "if": {
+    "properties": {
+      "public": {
+        "const": true
+      }
+    }
+  },
+  "then": {
+    "required": [
+      "authorizations"
+    ]
+  },
+  "else": {
+    "not": {
+      "anyOf": [
+        {
+          "required": [
+            "authorizations"
+          ]
+        },
+        {
+          "required": [
+            "catalog"
+          ]
+        },
+        {
+          "required": [
+            "exclusions"
+          ]
+        }
+      ]
+    }
+  }
+}

package/schemas/0.2/pointer.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/pointer.json",
+  "title": "authorized-retailers.json pointer (section 5.1)",
+  "type": "object",
+  "required": [
+    "spec",
+    "form",
+    "brand",
+    "verify_token",
+    "list"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "spec": {
+      "$ref": "common.json#/$defs/specVersion"
+    },
+    "form": {
+      "const": "pointer"
+    },
+    "brand": {
+      "$ref": "common.json#/$defs/brand"
+    },
+    "verify_token": {
+      "description": "The domain's public verification token (section 4).",
+      "type": "string",
+      "pattern": "^[A-Za-z0-9_-]{16,128}$"
+    },
+    "list": {
+      "$ref": "common.json#/$defs/registryUrl"
+    }
+  }
+}

package/schemas/0.2/revocation-feed.json

@@ -0,0 +1,55 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/revocation-feed.json",
+  "title": "Revocation feed (section 10.3)",
+  "type": "object",
+  "required": [
+    "spec",
+    "feed",
+    "issued",
+    "valid_until",
+    "stale_until",
+    "entries",
+    "signature"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "spec": {
+      "$ref": "common.json#/$defs/specVersion"
+    },
+    "feed": {
+      "const": "revocations"
+    },
+    "issued": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "valid_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "stale_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "entries": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "revocation_id",
+          "revoked"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "revocation_id": {
+            "$ref": "common.json#/$defs/revocationId"
+          },
+          "revoked": {
+            "$ref": "common.json#/$defs/timestamp"
+          }
+        }
+      }
+    },
+    "signature": {
+      "$ref": "common.json#/$defs/signature"
+    }
+  }
+}

package/schemas/0.2/verify-request.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/verify-request.json",
+  "title": "POST /v0/verify request (section 9)",
+  "description": "Canonical form. Call normalizeVerifyRequest on raw input first.",
+  "type": "object",
+  "required": [
+    "brand_domain",
+    "channel"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "brand_domain": {
+      "$ref": "common.json#/$defs/domain"
+    },
+    "channel": {
+      "$ref": "common.json#/$defs/channel"
+    },
+    "territory": {
+      "$ref": "common.json#/$defs/countryCode"
+    },
+    "product_line": {
+      "$ref": "common.json#/$defs/productLine"
+    },
+    "product": {
+      "description": "Exactly one of gtin or asin.",
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "gtin"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "gtin": {
+              "$ref": "common.json#/$defs/gtin"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": [
+            "asin"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "asin": {
+              "$ref": "common.json#/$defs/asin"
+            }
+          }
+        }
+      ]
+    },
+    "as_of": {
+      "anyOf": [
+        {
+          "$ref": "common.json#/$defs/date"
+        },
+        {
+          "$ref": "common.json#/$defs/timestamp"
+        }
+      ]
+    }
+  }
+}

package/schemas/0.2/verify-response.json

@@ -0,0 +1,284 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://authorizedretailers.ai/schemas/0.2/verify-response.json",
+  "title": "POST /v0/verify response (section 9)",
+  "type": "object",
+  "required": [
+    "status",
+    "checked",
+    "valid_until",
+    "stale_until",
+    "observed",
+    "signals",
+    "signature"
+  ],
+  "additionalProperties": false,
+  "properties": {
+    "status": {
+      "enum": [
+        "authorized",
+        "unlisted",
+        "expired",
+        "brand_not_registered",
+        "disputed"
+      ]
+    },
+    "reason": {
+      "enum": [
+        "not_registered",
+        "domain_unlinked",
+        "verification_lapsed",
+        "territory_mismatch",
+        "product_excluded",
+        "product_not_in_scope",
+        "product_not_in_catalog"
+      ]
+    },
+    "authorization_id": {
+      "$ref": "common.json#/$defs/id"
+    },
+    "revocation_id": {
+      "$ref": "common.json#/$defs/revocationId"
+    },
+    "expires": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "checked": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "as_of": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "valid_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "stale_until": {
+      "$ref": "common.json#/$defs/timestamp"
+    },
+    "product": {
+      "type": "object",
+      "required": [
+        "in_catalog"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "in_catalog": {
+          "type": "boolean"
+        },
+        "id": {
+          "$ref": "common.json#/$defs/id"
+        },
+        "product_line": {
+          "$ref": "common.json#/$defs/productLine"
+        }
+      },
+      "if": {
+        "properties": {
+          "in_catalog": {
+            "const": false
+          }
+        }
+      },
+      "then": {
+        "not": {
+          "anyOf": [
+            {
+              "required": [
+                "id"
+              ]
+            },
+            {
+              "required": [
+                "product_line"
+              ]
+            }
+          ]
+        }
+      }
+    },
+    "observed": {
+      "description": "Section 7: when the registry last saw this seller selling on the channel, within 30 days; otherwise null",
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "object",
+          "required": [
+            "last_seen"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "last_seen": {
+              "$ref": "common.json#/$defs/timestamp"
+            }
+          }
+        }
+      ]
+    },
+    "signals": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "type",
+          "observed"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "type": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]{0,63}$"
+          },
+          "observed": {
+            "$ref": "common.json#/$defs/timestamp"
+          },
+          "detail": {
+            "type": "string",
+            "maxLength": 1024
+          }
+        }
+      }
+    },
+    "signature": {
+      "$ref": "common.json#/$defs/signature"
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "enum": [
+              "authorized",
+              "expired",
+              "disputed"
+            ]
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "authorization_id"
+        ]
+      },
+      "else": {
+        "not": {
+          "anyOf": [
+            {
+              "required": [
+                "authorization_id"
+              ]
+            },
+            {
+              "required": [
+                "expires"
+              ]
+            }
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "const": "expired"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "expires"
+        ]
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "const": "authorized"
+          }
+        }
+      },
+      "then": {
+        "required": [
+          "revocation_id"
+        ]
+      },
+      "else": {
+        "properties": {
+          "observed": {
+            "const": null
+          }
+        },
+        "not": {
+          "required": [
+            "revocation_id"
+          ]
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "const": "brand_not_registered"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "reason": {
+            "enum": [
+              "not_registered",
+              "domain_unlinked",
+              "verification_lapsed"
+            ]
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "const": "unlisted"
+          }
+        }
+      },
+      "then": {
+        "properties": {
+          "reason": {
+            "enum": [
+              "territory_mismatch",
+              "product_excluded",
+              "product_not_in_scope",
+              "product_not_in_catalog"
+            ]
+          }
+        }
+      }
+    },
+    {
+      "if": {
+        "properties": {
+          "status": {
+            "enum": [
+              "authorized",
+              "expired",
+              "disputed"
+            ]
+          }
+        }
+      },
+      "then": {
+        "not": {
+          "required": [
+            "reason"
+          ]
+        }
+      }
+    }
+  ]
+}