Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
  • Loading branch information
Naarcha-AWS and natebower authored Oct 7, 2024
1 parent c43ccd5 commit 6463266
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions spec/schemas/_common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,9 @@ components:
x-version-added: '2.4'
description: |-
A two-dimensional Cartesian point specified by x and y coordinates. It can be represented in the following ways:
- As a `{x, y}` object.
- As a `[x, y]` array.
- As a string in `"x, y"` or Well Known Text (WKT) point formats.
- As an `{x, y}` object.
- As an `[x, y]` array.
- As a string in `"x, y"` or WKT point format.
oneOf:
- title: cartesian
$ref: '#/components/schemas/XyCartesianCoordinates'
Expand Down Expand Up @@ -690,7 +690,7 @@ components:
items:
$ref: '_common.query_dsl.yaml#/components/schemas/QueryContainer'
boost:
description: The boost value to applied to k-NN scores.
description: The boost value applied to k-NN scores.
type: number
method_parameters:
type: object
Expand Down Expand Up @@ -994,14 +994,14 @@ components:
properties:
count:
description: |-
The total number of non-deleted documents across all primary shards assigned to selected nodes.
The total number of non-deleted documents across all primary shards assigned to the selected nodes.
This number is based on documents in Lucene segments and may include documents from nested fields.
type: number
deleted:
description: |-
The total number of deleted documents across all primary shards assigned to selected nodes.
The total number of deleted documents across all primary shards assigned to the selected nodes.
This number is based on the number of documents stored in Lucene segments.
OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged
OpenSearch reclaims the disk space previously occupied by the deleted Lucene documents when a segment is merged.
type: number
required:
- count
Expand Down Expand Up @@ -1034,22 +1034,22 @@ components:
properties:
cache_count:
description: |-
The total number of entries added to the query cache across all shards assigned to selected nodes.
The total number of entries added to the query cache across all shards assigned to the selected nodes.
This number includes all current and evicted entries.
type: number
cache_size:
description: The total number of entries currently stored in the query cache across all shards assigned to the selected nodes.
type: number
evictions:
description: The total number of query cache evictions across all shards assigned to selected nodes.
description: The total number of query cache evictions across all shards assigned to the selected nodes.
type: number
hit_count:
description: The total number of query cache hits across all shards assigned to selected nodes.
description: The total number of query cache hits across all shards assigned to the selected nodes.
type: number
memory_size:
$ref: '#/components/schemas/HumanReadableByteCount'
memory_size_in_bytes:
description: The total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for the query cache across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
miss_count:
description: The total number of query cache misses across all shards assigned to the selected nodes.
Expand Down Expand Up @@ -1252,7 +1252,7 @@ components:
type: object
properties:
count:
description: The total number of segments across all shards assigned to selected nodes.
description: The total number of segments across all shards assigned to the selected nodes.
type: number
doc_values_memory:
$ref: '#/components/schemas/HumanReadableByteCount'
Expand All @@ -1269,59 +1269,59 @@ components:
fixed_bit_set:
$ref: '#/components/schemas/HumanReadableByteCount'
fixed_bit_set_memory_in_bytes:
description: The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
description: The total amount of memory, in bytes, used by fixed bit sets across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
index_writer_memory:
$ref: '#/components/schemas/HumanReadableByteCount'
index_writer_max_memory_in_bytes:
$ref: '#/components/schemas/ByteCount'
index_writer_memory_in_bytes:
description: The total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used by all index writers across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
max_unsafe_auto_id_timestamp:
description: The Unix timestamp, in milliseconds, of the most recently retried indexing request.
type: number
memory:
description: The total amount of memory used for segments across all shards assigned to selected nodes.
description: The total amount of memory used for segments across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
memory_in_bytes:
description: The total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for segments across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
norms_memory:
description: The total amount of memory used for normalization factors across all shards assigned to selected nodes.
description: The total amount of memory used for normalization factors across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
norms_memory_in_bytes:
description: The total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for normalization factors across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
points_memory:
description: The total amount of memory used for points across all shards assigned to selected nodes.
description: The total amount of memory used for points across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
points_memory_in_bytes:
description: The total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for points across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
stored_fields_memory:
description: The total amount of memory used for stored fields across all shards assigned to selected nodes.
description: The total amount of memory used for stored fields across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
stored_fields_memory_in_bytes:
description: The total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for stored fields across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
terms_memory:
description: The total amount of memory used for terms across all shards assigned to selected nodes.
description: The total amount of memory used for terms across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
terms_memory_in_bytes:
description: The total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for terms across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
term_vectors_memory:
description: The total amount of memory used for term vectors across all shards assigned to selected nodes.
description: The total amount of memory used for term vectors across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
term_vectors_memory_in_bytes:
description: The total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used for term vectors across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
version_map_memory:
description: The total amount of memory used by all version maps across all shards assigned to selected nodes.
description: The total amount of memory used by all version maps across all shards assigned to the selected nodes.
$ref: '#/components/schemas/HumanReadableByteCount'
version_map_memory_in_bytes:
description: The total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
description: The total amount, in bytes, of memory used by all version maps across all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
remote_store:
$ref: '#/components/schemas/RemoteStoreStats'
Expand All @@ -1347,7 +1347,7 @@ components:
size:
$ref: '#/components/schemas/HumanReadableByteCount'
size_in_bytes:
description: The total size, in bytes, of all shards assigned to selected nodes.
description: The total size, in bytes, of all shards assigned to the selected nodes.
$ref: '#/components/schemas/ByteCount'
reserved:
$ref: '#/components/schemas/HumanReadableByteCount'
Expand Down Expand Up @@ -2172,7 +2172,7 @@ components:
type: integer
format: int32
version_conflicts:
description: The number of version conflicts that the reindex encounters.
description: The number of version conflicts encountered by the reindex operation.
type: integer
format: int64
noops:
Expand Down

0 comments on commit 6463266

Please sign in to comment.