boxology-classifier 0.1.0

Compatibility classifier
Documentation
{
  "box_id": "classifier",
  "capabilities": [
    {
      "deprecation": null,
      "docs": [],
      "error": "ClassifierError",
      "id": "classifier.classify",
      "idempotency": "none",
      "input": {
        "name": "request",
        "type": "ClassifyRequest"
      },
      "max_exposure": "code_only",
      "name": "classify",
      "output": {
        "type": "ClassifyOutcome"
      },
      "shape": "unary"
    }
  ],
  "provenance": {
    "generator": "boxology-generator",
    "generator_version": "0.0.0",
    "semantic_digest": "sha256:6db8122a1f97a89b00816b26e762d758f0a32aeafe3bd4a859f6a9ff6499b45b"
  },
  "revision": "sha256:c615a71958fd24f37973ef962d34a3c349bd87901bf92e83712a9e6ba367a536",
  "schema_format": 1,
  "types": [
    {
      "deprecation": null,
      "docs": [],
      "kind": "enum",
      "name": "CompatibilityClass",
      "variants": [
        {
          "deprecation": null,
          "docs": [],
          "name": "Unchanged"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Documentation"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Deprecation"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Additive"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "CompatibleWithConditions"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Incompatible"
        }
      ]
    },
    {
      "deprecation": null,
      "docs": [],
      "fields": [
        {
          "deprecation": null,
          "docs": [],
          "name": "base",
          "type": "Option<Vec<u8>>"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "submitted",
          "type": "Vec<u8>"
        }
      ],
      "kind": "struct",
      "name": "ClassifyRequest"
    },
    {
      "deprecation": null,
      "docs": [],
      "fields": [
        {
          "deprecation": null,
          "docs": [],
          "name": "code",
          "type": "String"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "path",
          "type": "String"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "kind",
          "type": "String"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "class",
          "type": "CompatibilityClass"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "base_excerpt",
          "type": "Option<String>"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "submitted_excerpt",
          "type": "Option<String>"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "condition",
          "type": "Option<String>"
        }
      ],
      "kind": "struct",
      "name": "ClassifyFinding"
    },
    {
      "deprecation": null,
      "docs": [],
      "fields": [
        {
          "deprecation": null,
          "docs": [],
          "name": "verdict",
          "type": "CompatibilityClass"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "findings",
          "type": "Vec<ClassifyFinding>"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "rendered_text",
          "type": "String"
        }
      ],
      "kind": "struct",
      "name": "ClassifyReport"
    },
    {
      "deprecation": null,
      "docs": [],
      "kind": "enum",
      "name": "ClassifyFailureStage",
      "variants": [
        {
          "deprecation": null,
          "docs": [],
          "name": "Base"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Submitted"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "Pairing"
        }
      ]
    },
    {
      "deprecation": null,
      "docs": [],
      "fields": [
        {
          "deprecation": null,
          "docs": [],
          "name": "stage",
          "type": "ClassifyFailureStage"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "diagnostics",
          "type": "String"
        }
      ],
      "kind": "struct",
      "name": "ClassifyFailure"
    },
    {
      "deprecation": null,
      "docs": [],
      "fields": [
        {
          "deprecation": null,
          "docs": [],
          "name": "report",
          "type": "Option<ClassifyReport>"
        },
        {
          "deprecation": null,
          "docs": [],
          "name": "failure",
          "type": "Option<ClassifyFailure>"
        }
      ],
      "kind": "struct",
      "name": "ClassifyOutcome"
    },
    {
      "deprecation": null,
      "docs": [],
      "kind": "error",
      "name": "ClassifierError",
      "variants": [
        {
          "deprecation": null,
          "docs": [],
          "name": "Internal",
          "payload": "unit"
        }
      ]
    }
  ]
}