Skip to content

fix: add relevance sort option to POST /search in OpenAPI spec #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnf merged 1 commit into from
Mar 30, 2026
Merged

fix: add relevance sort option to POST /search in OpenAPI spec #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,15 +355,20 @@ paths:
minimum: 0
default: 0
sort:
description: The field on which to sort results (e.g., `id`, `updatedAt`).
example: id
description: |
The field on which to sort results. Defaults to `relevance`, which orders
results by search score (highest first). When set to `relevance`, the
`order` parameter is ignored. Use `id`, `name`, `createdAt`, or
`updatedAt` to sort by a specific field.
example: relevance
type: string
enum:
- id
- name
- createdAt
- updatedAt
default: id
- relevance
default: relevance
order:
description: |
Sort order:
Expand Down Expand Up @@ -1160,7 +1165,6 @@ components:
lng: 150.9
limit: 20
offset: 0
sort: "updatedAt"
order: "desc"

SearchResponse:
Expand Down