Skip to content

Revert "max_score and _score are required (and can be null)" #5248

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
merged 2 commits into from
Sep 2, 2025
Merged

Revert "max_score and _score are required (and can be null)" #5248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39b796f
Revert "max_score and _score are required (and can be null) (#1144)"
pquentin Sep 2, 2025
345d33a
Explain why this is not required
pquentin Sep 2, 2025
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
4 changes: 2 additions & 2 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 8 additions & 2 deletions specification/_global/search/_types/hits.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,10 @@ export class Hit<TDocument> {
* on a search request. Otherwise the field is always present on hits.
*/
_id?: Id
_score: double | null
// While _score is always returned by Elasticsearch, making it required
// breaks downstream JavaScript users for little added benefit
// See https://github.com/elastic/elasticsearch-specification/pull/5248
_score?: double | null
_explanation?: Explanation
fields?: Dictionary<string, UserDefinedValue>
highlight?: Dictionary<string, string[]>
Expand All @@ -69,7 +72,10 @@ export class HitsMetadata<T> {
total?: TotalHits | long
hits: Hit<T>[]

max_score: double | null
// While max_score is always returned by Elasticsearch, making it required
// breaks downstream JavaScript users for little added benefit
// See https://github.com/elastic/elasticsearch-specification/pull/5248
max_score?: double | null
}

export class HitMetadata<TDocument> {
Expand Down