LibrariesInfo

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe/main/json-schema/adobe-libraries-info-schema.json",
  "title": "LibrariesInfo",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adobe-library-service-api-openapi.yml#/components/schemas/LibrariesInfo",
  "type": "object",
  "properties": {
    "total_count": {
      "type": "integer",
      "format": "int32",
      "description": "Total results for query"
    },
    "libraries": {
      "type": "array",
      "description": "Libraries list",
      "items": {
        "$ref": "#/$defs/DbLibraryInfo"
      }
    },
    "_page": {
      "description": "List Page",
      "$ref": "#/$defs/PageSpec"
    },
    "_links": {
      "description": "List Links",
      "$ref": "#/$defs/MelvilleHypermediaListLinks"
    }
  },
  "$defs": {
    "DbLibraryBookmark": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "`public`, or `collab`, with separate required fields as identified below",
          "enum": [
            "PUBLIC",
            "COLLAB"
          ]
        },
        "id": {
          "type": "string",
          "description": "Required, must match the library's `id`. Submissions with an existing ID are discarded."
        },
        "url": {
          "type": "string",
          "description": "Required if `type` is `public`"
        },
        "urn": {
          "type": "string",
          "description": "Required if `type` is `collab`"
        },
        "role": {
          "type": "string",
          "description": "'viewer'/'editor' role of user's sharing status on library."
        },
        "can_share": {
          "type": "boolean",
          "description": "Sharing permission for user's sharing status on library"
        },
        "can_comment": {
          "type": "boolean",
          "description": "Commenting permission for user's sharing status on library"
        },
        "created": {
          "type": "integer",
          "format": "int64",
          "description": "This parameter will be ignored, populated with the timestamp upon creation and immutable after"
        },
        "_fc": {
          "type": "boolean"
        }
      }
    },
    "DbLibraryCollaborationData": {
      "type": "object",
      "properties": {
        "rootURN": {
          "type": "string"
        },
        "ownerId": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "collaborators": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DbLibraryCollaboratorData"
          }
        },
        "invitations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DbLibraryInvitationData"
          }
        },
        "public": {
          "type": "boolean"
        },
        "_fc": {
          "type": "boolean"
        },
        "directCollaborators": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DbLibraryCollaboratorData"
          }
        },
        "hasAdmin": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "DbLibraryCollaboratorData": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string",
          "readOnly": true
        },
        "displayName": {
          "type": "string",
          "readOnly": true
        },
        "collaborator": {
          "type": "string",
          "readOnly": true
        },
        "role": {
          "type": "string",
          "readOnly": true
        },
        "canComment": {
          "type": "boolean",
          "readOnly": true
        },
        "canShare": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "DbLibraryDetail": {
      "type": "object",
      "properties": {
        "_fc": {
          "type": "boolean"
        },
        "etag": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "manifest_format_version": {
          "type": "string"
        },
        "num_elements": {
          "type": "integer",
          "format": "int32"
        },
        "num_archived_elements": {
          "type": "integer",
          "format": "int32"
        },
        "types": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "element_type_counts": {
          "type": "object",
          "additionalProperties": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    },
    "DbLibraryElementRenditionData": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string"
        },
        "rendition": {
          "type": "object",
          "properties": {}
        }
      }
    },
    "DbLibraryGroup": {
      "type": "object",
      "required": [
        "name",
        "order"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Group id."
        },
        "name": {
          "type": "string",
          "description": "Group name."
        },
        "classifier": {
          "type": "string",
          "description": "Group namespace. Currently defaults to $default. The default should be used unless there's a specific case to provide a custom classifiers. Non-default classifiers are presently not supported in any applications."
        },
        "order": {
          "type": "string",
          "description": "Lexicographical string for setting the group's place in the group list, or for an element's place within a group.The client is responsible for providing and sorting using these strings."
        },
        "created_date": {
          "type": "integer",
          "format": "int64",
          "description": "Group created date"
        },
        "modified_date": {
          "type": "integer",
          "format": "int64",
          "description": "Group modified date"
        },
        "parent_id": {
          "type": "string",
          "description": "Defines a relationship between nested groups.  If provided, and the specified parent group exists, this group will be the \"child\" of the parent group. If there is no group in the library that matches the supplied parentId the group will still be created or updated with an empty parentId."
        }
      }
    },
    "DbLibraryInfo": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Library Id"
        },
        "toolkit_id": {
          "type": "string",
          "description": "Library toolkit id"
        },
        "name": {
          "type": "string",
          "description": "Library name"
        },
        "storage_used": {
          "type": "integer",
          "format": "int64",
          "description": "Storage used"
        },
        "document_id": {
          "type": "string",
          "description": "Document ID"
        },
        "document_type": {
          "type": "string",
          "description": "Document Type"
        },
        "creator": {
          "type": "string",
          "description": "Library creator"
        },
        "ownership": {
          "type": "string",
          "description": "Library ownership type",
          "enum": [
            "PRIVATE",
            "INCOMING",
            "OUTGOING",
            "DISCOVERY",
            "PUBLIC"
          ]
        },
        "created_date": {
          "type": "integer",
          "format": "int64",
          "description": "Library created date"
        },
        "modified_date": {
          "type": "integer",
          "format": "int64",
          "description": "Library modified date"
        },
        "version": {
          "type": "string",
          "description": "Library version"
        },
        "region": {
          "type": "string",
          "description": "Library region"
        },
        "library_urn": {
          "type": "string",
          "description": "Library resource_urn"
        },
        "manifest_urn": {
          "type": "string",
          "description": "Library manifest_urn"
        },
        "storage_path": {
          "type": "string"
        },
        "elements_count": {
          "type": "integer",
          "format": "int32"
        },
        "removed_elements_count": {
          "type": "integer",
          "format": "int32"
        },
        "bookmark": {
          "description": "Public or Shared Library Bookmark, not populated via the un-authenticated `/public/libraries` API.",
          "$ref": "#/$defs/DbLibraryBookmark"
        },
        "rendition_grid": {
          "description": "Library renditions",
          "$ref": "#/$defs/DbLibraryRenditionData"
        },
        "collaboration": {
          "description": "Library collaboration",
          "$ref": "#/$defs/DbLibraryCollaborationData"
        },
        "asset_acl": {
          "description": "Asset ACL",
          "$ref": "#/$defs/EffectiveACL"
        },
        "details": {
          "description": "Library details",
          "$ref": "#/$defs/DbLibraryDetail"
        },
        "groups": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DbLibraryGroup"
          }
        },
        "_links": {
          "$ref": "#/$defs/MelvilleHypermediaLibraryLinks"
        },
        "searchable": {
          "type": "boolean"
        },
        "rawName": {
          "type": "string"
        },
        "renditionGridMissing": {
          "type": "boolean"
        },
        "assetSubType": {
          "type": "string"
        },
        "_fc": {
          "type": "boolean"
        },
        "is_searchable": {
          "type": "boolean",
          "description": "Library is searchable"
        },
        "manifest_etag": {
          "type": "string"
        }
      }
    },
    "DbLibraryInvitationData": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "recipientEmail": {
          "type": "string",
          "readOnly": true
        },
        "senderName": {
          "type": "string",
          "readOnly": true
        },
        "created": {
          "type": "string",
          "readOnly": true
        },
        "role": {
          "type": "string",
          "readOnly": true
        },
        "canComment": {
          "type": "boolean",
          "readOnly": true
        },
        "canShare": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "DbLibraryRenditionData": {
      "type": "object",
      "properties": {
        "_fc": {
          "type": "boolean"
        },
        "main": {
          "$ref": "#/$defs/DbLibraryElementRenditionData"
        },
        "tiles": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DbLibraryElementRenditionData"
          }
        }
      }
    },
    "EffectiveACL": {
      "type": "object",
      "properties": {
        "_links": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": {
              "$ref": "#/$defs/Link"
            }
          }
        },
        "_fc": {
          "type": "boolean"
        }
      }
    },
    "Link": {
      "type": "object",
      "properties": {
        "href": {
          "type": "string"
        },
        "templated": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "deprecation": {
          "type": "string"
        },
        "mode": {
          "type": "string"
        },
        "additionalFields": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {}
          }
        }
      }
    },
    "MelvilleHypermediaLibraryLinks": {
      "type": "object",
      "properties": {
        "http://ns.adobe.com/melville/rel/primary": {
          "description": "Primary Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/path": {
          "description": "Path Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/id": {
          "description": "ID Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/ac/policy": {
          "description": "Policy Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/ac/check": {
          "description": "Check Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/ac/effective": {
          "description": "Effective Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/describedBy": {
          "description": "Metadata Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/metadata/application": {
          "description": "Application Metadata Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/metadata/repository": {
          "description": "Repository Metadata Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/rendition": {
          "description": "Rendition Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/version-history": {
          "description": "Version History Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/manifest": {
          "description": "Manifest Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/component": {
          "description": "Component Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/elements": {
          "description": "Elements Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/element": {
          "description": "Element Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/groups": {
          "description": "Groups Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/representations": {
          "description": "Representations Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "http://ns.adobe.com/melville/rel/raw": {
          "description": "Raw Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "page": {
          "description": "Page Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "next": {
          "description": "Next Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        }
      }
    },
    "MelvilleHypermediaLink": {
      "type": "object",
      "properties": {
        "href": {
          "type": "string"
        },
        "rel": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "templated": {
          "type": "boolean"
        }
      }
    },
    "MelvilleHypermediaListLinks": {
      "type": "object",
      "properties": {
        "page": {
          "description": "Page Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        },
        "next": {
          "description": "Next Link",
          "$ref": "#/$defs/MelvilleHypermediaLink"
        }
      }
    },
    "PageSpec": {
      "type": "object",
      "properties": {
        "orderBy": {
          "type": "string",
          "description": "List orderby"
        },
        "start": {
          "type": "string",
          "description": "List start position"
        },
        "next": {
          "type": "string",
          "description": "List next position"
        },
        "count": {
          "type": "integer",
          "format": "int32",
          "description": "List page size"
        },
        "type": {
          "type": "string",
          "description": "List page type"
        },
        "property": {
          "type": "string",
          "description": "List page property"
        }
      }
    }
  }
}