Backstage · Schema

SearchResultSet

SearchResultSet schema from Backstage search API

Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Properties

Name Type Description
results array Array of search result documents.
nextPageCursor string Cursor to fetch the next page of results.
previousPageCursor string Cursor to fetch the previous page of results.
numberOfResults integer Total number of matching results.
View JSON Schema on GitHub

JSON Schema

search-search-result-set-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/json-schema/search-search-result-set-schema.json",
  "title": "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": "integer",
      "description": "Total number of matching results."
    }
  }
}