Backstage · JSON Structure

Search Search Result Set Structure

SearchResultSet schema from Backstage search API

Type: object Properties: 4
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

SearchResultSet is a JSON Structure definition published by Backstage, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

results nextPageCursor previousPageCursor numberOfResults

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-structure/search-search-result-set-structure.json",
  "name": "SearchResultSet",
  "description": "SearchResultSet schema from Backstage search API",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SearchResult"
      },
      "description": "Array of search result documents."
    },
    "nextPageCursor": {
      "type": "string",
      "description": "Cursor to fetch the next page of results."
    },
    "previousPageCursor": {
      "type": "string",
      "description": "Cursor to fetch the previous page of results."
    },
    "numberOfResults": {
      "type": "int32",
      "description": "Total number of matching results."
    }
  }
}