Deprecation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-deprecation-schema.json",
  "title": "Deprecation",
  "description": "Weaviate Deprecation schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The id that uniquely identifies this particular deprecation (mostly used internally)."
    },
    "status": {
      "type": "string",
      "description": "Whether the problematic API functionality is deprecated (planned to be removed) or already removed."
    },
    "apiType": {
      "type": "string",
      "description": "Describes which API is affected, usually one of: REST, GraphQL and gRPC."
    },
    "msg": {
      "type": "string",
      "description": "What this deprecation is about."
    },
    "mitigation": {
      "type": "string",
      "description": "User-required object to not be affected by the (planned) removal."
    },
    "sinceVersion": {
      "type": "string",
      "description": "The deprecation was introduced in this version."
    },
    "plannedRemovalVersion": {
      "type": "string",
      "description": "A best-effort guess of which upcoming version will remove the feature entirely."
    },
    "removedIn": {
      "type": "string",
      "description": "If the feature has already been removed, it was removed in this version."
    },
    "removedTime": {
      "type": "string",
      "format": "date-time",
      "description": "If the feature has already been removed, it was removed at this timestamp."
    },
    "sinceTime": {
      "type": "string",
      "format": "date-time",
      "description": "The deprecation was introduced at this timestamp."
    },
    "locations": {
      "type": "array",
      "description": "The locations within the specified API affected by this deprecation.",
      "items": {
        "type": "string"
      }
    }
  }
}