Skip to content
Merged
Changes from all commits
Commits
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
24 changes: 21 additions & 3 deletions specs/recommend/common/schemas/TrendingFacetsQuery.yml
Original file line number Diff line number Diff line change
@@ -1,20 +1,38 @@
trendingFacetsQuery:
title: Trending facet values
allOf:
- $ref: './RecommendationsRequest.yml#/baseRecommendRequest'
- $ref: '#/trendingFacets'

trendingFacets:
type: object
additionalProperties: false
properties:
indexName:
$ref: '../../../common/parameters.yml#/indexName'
threshold:
type: number
format: double
minimum: 0
maximum: 100
description: Minimum score a recommendation must have to be included in the response.
maxRecommendations:
type: integer
minimum: 1
maximum: 30
default: 30
description: |
Maximum number of recommendations to retrieve.
By default, all recommendations are returned and no fallback request is made.
Depending on the available recommendations and the other request parameters,
the actual number of recommendations may be lower than this value.
facetName:
type: string
description: Facet attribute for which to retrieve trending facet values.
model:
$ref: '#/trendingFacetsModel'
fallbackParameters:
$ref: './QueryParameters.yml#/fallbackParams'
required:
- indexName
- threshold
- facetName
- model

Expand Down