SearchSuggestion

Fields

5 fields

detail

string or null

kind · required

string

label · required

string

q · required

string

scope · required

string

Raw schema (JSON)

{
  "properties": {
    "detail": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Detail"
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "label": {
      "title": "Label",
      "type": "string"
    },
    "q": {
      "title": "Q",
      "type": "string"
    },
    "scope": {
      "title": "Scope",
      "type": "string"
    }
  },
  "required": [
    "kind",
    "label",
    "q",
    "scope"
  ],
  "title": "SearchSuggestion",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• GET /api/v1/search/suggested — Suggested Searches

Used by schemas

• SearchSuggestionsResponse

More details

• Specification: OpenAPI JSON