Backstage · Schema

SearchDocument

SearchDocument schema from Backstage search API

Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

Properties

Name Type Description
title string Title of the document.
text string Text content of the document.
location string URL or path to the original content.
View JSON Schema on GitHub

JSON Schema

search-search-document-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-document-schema.json",
  "title": "SearchDocument",
  "description": "SearchDocument schema from Backstage search API",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the document."
    },
    "text": {
      "type": "string",
      "description": "Text content of the document."
    },
    "location": {
      "type": "string",
      "description": "URL or path to the original content."
    }
  },
  "required": [
    "title",
    "text",
    "location"
  ],
  "additionalProperties": true
}