Search Results (including Shared Links)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchResultsWithSharedLinks",
  "title": "Search Results (including Shared Links)",
  "type": "object",
  "x-box-resource-id": "search_results_with_shared_links",
  "x-box-tag": "search",
  "description": "A list of files, folders and web links that matched the search query,\nincluding the additional information about any shared links through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the `include_recent_shared_links`\nquery parameter has been set to `true`.",
  "required": [
    "type"
  ],
  "allOf": [
    {
      "type": "object",
      "properties": {
        "total_count": {
          "description": "One greater than the offset of the last entry in the search results.\nThe total number of entries in the collection may be less than\n`total_count`.",
          "example": 5000,
          "type": "integer",
          "format": "int64"
        },
        "limit": {
          "description": "The limit that was used for this search. This will be the same as the\n`limit` query parameter unless that value exceeded the maximum value\nallowed.",
          "example": 1000,
          "type": "integer",
          "format": "int64"
        },
        "offset": {
          "description": "The 0-based offset of the first entry in this set. This will be the same\nas the `offset` query parameter used.",
          "example": 2000,
          "type": "integer",
          "format": "int64"
        }
      }
    },
    {
      "properties": {
        "type": {
          "description": "Specifies the response as search result items with shared links",
          "type": "string",
          "example": "search_results_with_shared_links",
          "enum": [
            "search_results_with_shared_links"
          ],
          "nullable": false
        },
        "entries": {
          "description": "The search results for the query provided, including the\nadditional information about any shared links through\nwhich the item has been shared with the user.",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SearchResultWithSharedLink"
          }
        }
      }
    }
  ]
}