DocumentListType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/kibo-commerce/main/json-schema/kibo-commerce-document-list-type-schema.json",
  "title": "DocumentListType",
  "description": "A documentListType instructs the Mozu platform to automatically create documentLists within a scopeType. Example: Creating a documentListType in tenant X with a \nscopeType of site tells the Mozu platform to immediately create a documentList in each site tenant X has. The Mozu platform will also automatically create a new \ndocumentList for every site subsequently provisioned in tenant X. Any defaultDocuments defined on the documentListType will be created within \neach documentList. Each documentList will be addressable via the documenetListType's fully qualified name and will, by default, use the documentListType's views, \nusages and metadata. Therefore the documentListType can be used to centrally manage each associated documentList.",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/kibo-commerce-content-openapi.yml#/components/schemas/DocumentListType",
  "properties": {
    "defaultDocuments": {
      "description": "The definition of any documents to create when a documentList is created.",
      "items": {
        "$ref": "#/$defs/DocumentInstallation"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "documentListTypeFQN": {
      "description": "The unique identifier of the documentListType, represented by name@namespace. The documentListTypeFQN must be provided when creating the documentListType, or the name and namespace fields must be provided.\nThis field cannot be updated and each documentList created from the documentListType will use this value.",
      "type": [
        "string",
        "null"
      ]
    },
    "documentTypeFQNs": {
      "description": "The full names (name@namespace) of the types of documents that can be created within the documentLists belonging to this documentListType. \nEach documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "enableActiveDateRanges": {
      "description": "Determines if documentLists belonging to this documentListType have ActiveDateRanges turned on or off. \nEach documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "enablePublishing": {
      "description": "Determines if documentLists belonging to this documentListType have publishing turned on or off. \nEach documentList created from the documentListType will use this value, but it can be overridden in an individual documentList.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "installationPackage": {
      "description": "Optionally, a documentListType can be defined in an installationPackage and then installed into a tenant. Installed documentListsTypes can only be updated via installation upgrades. \nCurrently only internal Mozu platform components can create installations. This field is system-supplied and read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "metadata": {
      "description": "Allows arbitrary data to be stored on the documentListType. Each documentList created from this documentListType will use this value, \nbut it can be overridden in an individual documentList.",
      "nullable": true
    },
    "name": {
      "description": "The name component of the documentListTypeFQN, name@namespace. The name must be unique within the namespace component and cannot be updated.\nEach documentList created from the documentListType will use this value.",
      "type": [
        "string",
        "null"
      ]
    },
    "namespace": {
      "description": "The namespace component of the documentListTypeFQN, name@namespace. The issued dev account namespace must be used unless elevated privileges allow a blank namespace to be used. The namespace cannot be updated.\nEach documentList created from the documentListType will use this value.",
      "type": [
        "string",
        "null"
      ]
    },
    "scopeType": {
      "description": "The context level at which this documentListType will create documentLists. Valid values are \"tenant\", \"masterCatalog\", \"catalog\" and \"site\". This field is read-only after insert.",
      "type": [
        "string",
        "null"
      ]
    },
    "supportsActiveDateRanges": {
      "description": "Determines if documentLists belonging to this documentListType will support drafting and ActiveDateRanges documents. \nThis field defaults to false and cannot be updated. Each documentList created from the documentListType will use this value.",
      "type": "boolean"
    },
    "supportsPublishing": {
      "description": "Determines if documentLists belonging to this documentListType will support drafting and publishing documents. \nThis field defaults to false and cannot be updated. Each documentList created from the documentListType will use this value.",
      "type": "boolean"
    },
    "usages": {
      "description": "An array of strings that describes to the Mozu platform the manner(s) in which a documentList can be used. The following values are valid:\nentitymanager -- the documentList should be visible in the Admin Content/Entities screen, which allows admin users to create, manage and publish documents within the documentList.\nsitebuilder -- the documentList should be visible in Sitebuilder. A documentList will display in the Sitebuilder Navigation Content List node, which supports document creation, management and web cms integration.\nEach documentList created from this documentListType will use this value, but it can be overridden in an individual documentList.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "version": {
      "description": "The version of the installationPackge installed. This field is read-only.",
      "type": [
        "string",
        "null"
      ]
    },
    "views": {
      "description": "An array of one or more views, which each allow GET access to a projection of fields from the documents in the given documentList. \nEach documentList created from this documentListType will use this value, but it can be overridden in an individual documentList.",
      "items": {
        "$ref": "#/$defs/View"
      },
      "type": [
        "array",
        "null"
      ]
    }
  },
  "type": "object",
  "$defs": {
    "DocumentInstallation": {
      "description": "The definition of a document to create when a documentList is created.",
      "properties": {
        "documentTypeFQN": {
          "description": "The full name of the documentType that underlies this document.",
          "type": [
            "string",
            "null"
          ]
        },
        "locale": {
          "description": "tbd",
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "description": "The name of the document to create.",
          "type": [
            "string",
            "null"
          ]
        },
        "properties": {
          "description": "The properties of this document.",
          "nullable": true
        }
      },
      "type": "object"
    },
    "View": {
      "description": "A view provides GET access to documents within the documentList the view belongs to. The view can designate which document fields are returned (projection) and\na security model for providing GET access independent of the documentList's security model.",
      "properties": {
        "fields": {
          "description": "Designation of which document fields are returned (projection) when GETing documents from the view.",
          "items": {
            "$ref": "#/$defs/ViewField"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "filter": {
          "description": "Filter criteria to apply automatically when documents from this view are accessed, using the standard Mozu filter syntax. Only documents matching the filter criteria will be returned. \nAny filter provided by an operation is combined with the view filter.",
          "type": [
            "string",
            "null"
          ]
        },
        "includeInactiveMode": {
          "description": "If view documents are requested with includeInactive=true, then this controls which documents return. If includeInactive is not provided or set to false, then only active documents return.\nIf not set, or set to \"all\", then all documents return.\nIf set to \"active\", then only documents within the active date range and documents with no active date range are returned.\nIf set to \"scheduled\", then only documents with an active date range in the future are returned.\nIf set to \"activeOrScheduled\", then only documents that are active or documents with an active date range in the future are returned.\nIf set to \"ended\", then only documents with an active date range in the past are returned.",
          "type": [
            "string",
            "null"
          ]
        },
        "isAdminDefault": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "isVisibleInStorefront": {
          "description": "The isVisibleInStorefront field indicates whether documents in the view can be accessed from the Mozu storefront application. If true, the storefront application and storefront client application (javascript tier) \ncan GET documents from the view.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "metadata": {
          "description": "The metadata field allows arbitrary data to be stored on the view.",
          "nullable": true
        },
        "name": {
          "description": "A view is addressed via its name, which is unique within the documentList or documentListType in which it is defined.",
          "type": [
            "string",
            "null"
          ]
        },
        "usages": {
          "description": "tbd",
          "items": {
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "ViewField": {
      "description": "The projection of an individual field in a view.",
      "properties": {
        "name": {
          "description": "The name of the field projected into the view document, meaning the name given to the target field after it is projected.\nThe name must be unique within the list of viewFields provided in the view.",
          "type": [
            "string",
            "null"
          ]
        },
        "target": {
          "description": "Specifies the document field to project. First-class fields will be returned on the document, but can be projected into the view properties. \nValid first-class fields include name, id, documentTypeFqn, listFqn and publishState. Dynamic fields within the properties field can be projected by prefixing the target string with \"properties.\"\nExample: \"properties.property1\". If a property is an object, then dot notation can be used to walk to particular subelements. Example: \"properties.property1.subProperty1\"\nIndividual array elements can be selected as well. Example: \"properties.property1.subProperty1.subSubArray[2].propertyOnArrayItem\"\nAny target miss will result in a null value returning for the projected field.",
          "type": [
            "string",
            "null"
          ]
        }
      },
      "type": "object"
    }
  }
}