Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

fix(specs): add virtual index settings and update renderingContent #3254

Merged
merged 1 commit into from
Jun 25, 2024
Merged

fix(specs): add virtual index settings and update renderingContent #3254

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
13 changes: 13 additions & 0 deletions specs/common/schemas/IndexSettings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,11 @@ baseIndexSettings:
default: []
x-categories:
- Ranking
virtual:
type: boolean
description: Only present if the index is a [virtual replica](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-an-index-alphabetically/#virtual-replicas).
Comment on lines +67 to +69
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is this supposed to show up? I can't use it with setSettings and I don't see it in the response for a virtual replica with getSettings? Is this used somewhere?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, fixed in #3255, it's actually only returned when fetching the index list

x-categories:
- Ranking
paginationLimitedTo:
type: integer
example: 100
Expand Down Expand Up @@ -1031,6 +1036,8 @@ value:
$ref: '#/order'
sortRemainingBy:
$ref: '#/sortRemainingBy'
hide:
$ref: '#/hide'

order:
description: |
Expand All @@ -1041,6 +1048,12 @@ order:
items:
type: string

hide:
description: Hide facet values.
type: array
items:
type: string

sortRemainingBy:
description: |
Order of facet values that aren't explicitly positioned with the `order` setting.
Expand Down
Loading