Skip to content

Commit

Permalink
[Docs] Fix field cap descriptions (#603)
Browse files Browse the repository at this point in the history
* Fix field cap descriptions

Signed-off-by: Archer <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Archer <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
Naarcha-AWS and natebower authored Oct 7, 2024
1 parent 4d74a49 commit 10027be
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions spec/schemas/_core.field_caps.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ components:
type: object
properties:
aggregatable:
description: Whether this field can be aggregated on all indices.
description: Whether this field can be aggregated on all indexes.
type: boolean
indices:
$ref: '_common.yaml#/components/schemas/Indices'
Expand All @@ -21,7 +21,7 @@ components:
non_searchable_indices:
$ref: '_common.yaml#/components/schemas/Indices'
searchable:
description: Whether this field is indexed for search on all indices.
description: Whether this field is indexed for search on all indexes.
type: boolean
type:
type: string
Expand All @@ -35,15 +35,15 @@ components:
$ref: '_common.mapping.yaml#/components/schemas/TimeSeriesMetricType'
non_dimension_indices:
description: |-
If this list is present in response then some indices have the
field marked as a dimension and other indices, the ones in this list, do not.
If this list is present in the response, then indexes not contained in the list have the
field marked as a dimension. Any indexes contained in the list are not marked as a dimension.
type: array
items:
$ref: '_common.yaml#/components/schemas/IndexName'
metric_conflicts_indices:
description: |-
The list of indices where this field is present if these indices
don't have the same `time_series_metric` value for this field.
The list of indexes in which this field is present if the indexes
don't have the same `time_series_metric` value for the field.
type: array
items:
$ref: '_common.yaml#/components/schemas/IndexName'
Expand Down

0 comments on commit 10027be

Please sign in to comment.