Profile: collection

Profile Schema

A collection is simply a document meant to aggregate other documents. Unlike other “aggregation” documents (which take the form of a “tag” or “genre”), collections can be used for any arbitrary grouping of documents.

The collection profile is intended to be used as a “type” profile.

Structure

The collection profile requires that the document also list the aggregation profile in its profile list; the aggregation profile provides further validation constraints.

Example collection document

{
  "id": "12345",
  "profiles": [
    {
      "href": "/v1/profiles/collection",
      "rels": [
        "type"
      ]
    },
    {
      "href": "/v1/profiles/aggregation"
    },
    {
      "href": "/v1/profiles/document"
    }
  ],

  "items": []
}

© 2024 npr