icarResourceCollectionReference.json

{
  "description": "Defines a reference to a collection of resources.",

  "type": "object",

  "required": [
    "@id",
    "@type",
    "@context"
  ],

  "properties": {
    "@id": {
      "type": "string",
      "format": "uri",
      "description": "Uniform resource idendentifier (URI) of the collection."
    },
    "@type": {
      "type": "string",
      "description": "Specifies whether this is a single resource Link or a Collection.",
      "enum": ["Collection"]
    },
    "@context": {
      "type": "string",
      "description": "Tells us the type of the referenced resource object (eg. icarAnimalCoreCollection)."
    },
    "totalItems": {
      "type": "integer",
      "description": "Provides the number of items in the collection, if known."
    },
    "pageSize": {
      "type": "integer",
      "description": "If non-zero, specifies the default number of items returned per page."
    },
    "totalPages": {
      "type": "integer",
      "description": "Provides the number of pages in the collection, if known."
    },
    "operations": {
      "type": "array",
      "items": {
        "@type": {
          "type": "string",
          "enum": ["Operation"]
        },
        "method": {
          "type": "string",
          "enum": ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD"]
        }
      },
      "description": "Defines the operations that may be carried out on the collection (POST) or its members (PUT/PATCH/DELETE)."
    }
  },
  "links": [{
    "rel": "collection",
    "href": "{@id}",
    "templateRequired": ["@id"]
  }]
}