Skip to main content

FolderResponseView

Folder structure containing documentation files

identifierstringrequired

Unique identifier of the folder

Example: 123e4567-e89b-12d3-a456-426614174001
documentationTemplateFolderReferencestring

Reference to the template folder if applicable

Example: 2d6e099-910b-4668-902c-deb9f15984ec
names object[]required

Set of localized names for this folder

  • Array [
    • namestringrequired

    The name in the specified language

    Example: Root folder
    localestringrequired

    Language code (ISO 639-1)

    Example: en-US
  • ]
    • foldersundefined[]required

    List of subfolders contained within this folder

    Example: []
    FolderResponseView
    {
      "identifier": "123e4567-e89b-12d3-a456-426614174001",
      "documentationTemplateFolderReference": "2d6e099-910b-4668-902c-deb9f15984ec",
      "names": [
        {
          "name": "Root folder",
          "locale": "en-US"
        }
      ],
      "folders": []
    }