Backstage · JSON Structure

Search Search Document Structure

SearchDocument schema from Backstage search API

Type: object Properties: 3 Required: 3
Developer PortalInternal Developer PlatformSoftware CatalogOpen Source

SearchDocument is a JSON Structure definition published by Backstage, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

title text location

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-document-structure.json",
  "name": "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
}