Skip to content

SPTECH-56: Update PAPPI Documentation - rating and popularity (sort mode) #114

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
pstarritt-gyg merged 1 commit into from
May 21, 2026
+7 −2
Merged

SPTECH-56: Update PAPPI Documentation - rating and popularity (sort mode) #114

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
9 changes: 7 additions & 2 deletions spec/components/commons/query.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ components:
$ref: "#/components/schemas/Rating"
type: array
sortdirection:
description: Defines the sort order.
description: Defines the sort order. Ignored when `sortfield=popularity`.
in: query
name: sortdirection
required: false
Expand All @@ -271,7 +271,12 @@ components:
- ASC
type: string
sortfield:
description: Defines the sort field.
description: |
Defines the sort field. Behavior per value:
- `popularity`: returns recommended results (an internal ranking, not raw popularity). `sortdirection` is ignored.
- `rating`: ranks using internal signals in addition to `overall_rating`; results are not strictly ordered by the `overall_rating` response field alone.
- `price`: sorts by price.
- `duration`: sorts by duration.
in: query
name: sortfield
required: false
Expand Down
Loading