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"
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/search-search-result"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.