Backstage · Schema

SearchResult

SearchResult schema from Backstage search API

Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Properties

Name Type Description
type string The document type (e.g., software-catalog, techdocs).
document object
rank number Relevance rank of the result.
highlight object
View JSON Schema on GitHub

JSON Schema

search-search-result-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-schema.json",
  "title": "SearchResult",
  "description": "SearchResult schema from Backstage search API",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The document type (e.g., software-catalog, techdocs)."
    },
    "document": {
      "$ref": "#/components/schemas/SearchDocument"
    },
    "rank": {
      "type": "number",
      "description": "Relevance rank of the result."
    },
    "highlight": {
      "type": "object",
      "properties": {
        "preTag": {
          "type": "string"
        },
        "postTag": {
          "type": "string"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    }
  }
}