page.schema.json

{
  "meta:license": [
    "Copyright 2018 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/"
  ],
  "$id": "https://ns.adobe.com/xdm/common/page",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Page",
  "type": "object",
  "description":
    "Page object contains paging information for related resource when resource result is paginated.",
  "definitions": {
    "page": {
      "properties": {
        "orderBy": {
          "title": "Order by property",
          "type": "string",
          "description":
            "The `orderBy` parameter specifies the comma-separated (no spaces after comma) list of properties by which the resource should be sorted. The properties by which to sort are listed in priority order. The first property is used for primary sorting, the second property to resolve ties in primary sorting, etc. The name of a property may be prefixed with a `+` to indicate ascending ordering or `-` to indicate descending ordering by that property. If the property name is not prefixed the result is sorted in asceding order. If `orderBy` is not given or does not name a property supported to sort by, the order is indeterminate and the service may return the elements in any order."
        },
        "start": {
          "title": "First value",
          "type": "string",
          "description":
            "The first value, in sorted order, of the orderby property on this page."
        },
        "next": {
          "title": "Next page start value",
          "type": "string",
          "description": "The start value for the next page."
        },
        "property": {
          "title": "Filter properties",
          "type": "string",
          "description":
            "The list of properties by which the result is filtered, if any.\nThis list is comma-separated (no spaces after comma). The resulting list will only include entries for which the filtered property has been defined. "
        },
        "type": {
          "title": "Filter type value",
          "type": "string",
          "description":
            "The applied type filtering value, if any. Unlike `property` which allows to filter for presence of any property, `type` filters only for the specific value of the `type` attribute, i.e. the media type. This is a literal filter without any globbing or pattern matching."
        },
        "count": {
          "title": "Number of items",
          "type": "integer",
          "minimum": 0,
          "description": "The number of items on this page."
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "#/definitions/page"
    }
  ],
  "required": ["orderBy", "start", "next", "count"],
  "meta:status": "experimental"
}