Category

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf620-product-catalog-category-schema.json",
  "title": "Category",
  "description": "Category schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity"
    },
    {
      "type": "object",
      "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.",
      "properties": {
        "description": {
          "type": "string",
          "description": "Description of the category"
        },
        "isRoot": {
          "type": "boolean",
          "description": "If true, this Boolean indicates that the category is a root of categories"
        },
        "parent": {
          "$ref": "#/components/schemas/CategoryRef"
        },
        "productOffering": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductOfferingRef"
          },
          "description": "List of product offerings that are referred to by the category"
        },
        "subCategory": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CategoryRef"
          },
          "description": "The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other (sub-)categories and/or product offerings."
        },
        "validFor": {
          "$ref": "#/components/schemas/TimePeriod"
        },
        "version": {
          "type": "string",
          "description": "Category version"
        },
        "lastUpdate": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of the last update"
        },
        "lifecycleStatus": {
          "type": "string",
          "description": "Used to indicate the current lifecycle status"
        },
        "name": {
          "type": "string",
          "description": "Name of the category"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "Category": "#/components/schemas/Category"
    }
  }
}