Search Types
Operations of the Search API. Paths are relative to your deployment's API host.
GET /api/search-api/search-types
List the registered, biome-contributed search result-types
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json SearchTypeListDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/search-api/search-types/resolve-route
Resolve a xema:// ref to the frontend URL its result-type declares
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ref | query | string | yes | The xema://… ref to resolve. Accepts BOTH an object ref (xema://<scope>/<kind>/<slug>) and a search ref (xema://<scope>/<docType>/<sourceId>). Both type slots are open and biome-contributed; the ref routes by whether its type segment is a registered object kind or a registered docType. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json ResolvedRouteDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |