collection.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/collection",
  "definitions": {
    "single-collectionPage-or-link": {
      "anyOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "$ref":
            "https://ns.adobe.com/xdm/external/activity-streams-2/collection-page"
        },
        {
          "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link"
        }
      ]
    },
    "single-object-or-link": {
      "anyOf": [
        {
          "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object"
        },
        {
          "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link"
        }
      ]
    },
    "ordered-list-of-objects-or-links": {
      "items": {
        "$ref": "#/definitions/single-object-or-link"
      },
      "type": "array"
    },
    "object-or-link-or-ordered-list-of-object-or-link": {
      "oneOf": [
        {
          "$ref": "#/definitions/single-object-or-link"
        },
        {
          "$ref": "#/definitions/ordered-list-of-objects-or-links"
        }
      ]
    },
    "extra-properties": {
      "properties": {
        "activitystreams:totalItems": {
          "description":
            "A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-totalitems) document for a complete description.",
          "type": "integer",
          "minimum": 0
        },
        "activitystreams:current": {
          "description":
            "In a paged Collection, indicates the page that contains the most recently updated member items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-current) document for a complete description.",
          "$ref": "#/definitions/single-collectionPage-or-link"
        },
        "activitystreams:first": {
          "description":
            "In a paged Collection, indicates the furthest preceeding page of items in the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-first) document for a complete description.",
          "$ref": "#/definitions/single-collectionPage-or-link"
        },
        "activitystreams:last": {
          "description":
            "In a paged Collection, indicates the furthest proceeding page of the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-last) document for a complete description.",
          "$ref": "#/definitions/single-collectionPage-or-link"
        },
        "activitystreams:items": {
          "description":
            "Identifies the items contained in a collection. The items might be ordered or unordered. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-items) document for a complete description.",
          "$ref":
            "#/definitions/object-or-link-or-ordered-list-of-object-or-link"
        }
      }
    }
  },
  "description":
    "A `Collection` is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that represents ordered or unordered sets of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` instances. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection) specification for a complete description of the `Collection` type.",
  "type": "object",
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object"
    },
    {
      "$ref": "#/definitions/extra-properties"
    }
  ],
  "title": "Collection",
  "meta:status": "experimental"
}