Skip to content
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

Add missing fields property on top_hits aggregation #2522

Merged
merged 3 commits into from
Apr 23, 2024
Merged

Add missing fields property on top_hits aggregation #2522

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
292edec
Add missing fields property on top_hits aggregation
JoshMock Apr 18, 2024
d11241b
Use correct fields type
JoshMock Apr 23, 2024
b807d3d
Update type for docvalue_fields too
JoshMock Apr 23, 2024
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
7 changes: 6 additions & 1 deletion specification/_types/aggregations/metric.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { Dictionary } from '@spec_utils/Dictionary'
import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
import { Field, Fields } from '@_types/common'
import { double, integer, long } from '@_types/Numeric'
import { QueryContainer } from '@_types/query_dsl/abstractions'
import { FieldAndFormat, QueryContainer } from '@_types/query_dsl/abstractions'
import { Script, ScriptField } from '@_types/Scripting'
import { Aggregation } from './Aggregation'
import { Missing } from './AggregationContainer'
Expand Down Expand Up @@ -344,6 +344,11 @@ export class TopHitsAggregation extends MetricAggregationBase {
* @server_default false
*/
explain?: boolean
/**
* Array of wildcard (*) patterns. The request returns values for field names
* matching these patterns in the hits.fields property of the response.
*/
fields?: (FieldAndFormat | Field)[]
Copy link
Contributor

Choose a reason for hiding this comment

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

should it be FieldAndFormat[] | Field[]?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's a good question. My assumption was that fields could take an array that consisted of either, or a combination of the two (e.g. ['field_one', { field: 'field_two', format: 'xxx' }]). The docs suggest that's the case as well.

I was looking at the FieldFetcher subphase in the Elasticsearch repo to verify in the source, but my Java is pretty rusty so it's hard to tell. What does it seem like to you?

/**
* Starting document offset.
* @server_default 0
Expand Down
Loading