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.

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

Fix cluster schemas #754

Merged
merged 3 commits into from
Dec 27, 2024
Merged

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Dec 23, 2024

Description

Fix cluster schemas

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Thomas Farr <[email protected]>
Signed-off-by: Thomas Farr <[email protected]>
Copy link
Contributor

github-actions bot commented Dec 23, 2024

Changes Analysis

Commit SHA: 715e0cd
Comparing To SHA: edf9d6f

API Changes

Summary

├─┬Paths
│ ├─┬/_cluster/allocation/explain
│ │ ├─┬GET
│ │ │ ├─┬Responses
│ │ │ │ └─┬200
│ │ │ │   └─┬application/json
│ │ │ │     └─┬Schema
│ │ │ │       └─┬shard
│ │ │ │         ├──[🔀] type (28595:23)❌ 
│ │ │ │         └──[➕] format (28596:25)❌ 
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬shard
│ │ │         ├──[🔀] type (26441:23)❌ 
│ │ │         └──[➕] format (26442:25)❌ 
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬200
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └─┬shard
│ │   │         ├──[🔀] type (28595:23)❌ 
│ │   │         └──[➕] format (28596:25)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬shard
│ │           ├──[🔀] type (26441:23)❌ 
│ │           └──[➕] format (26442:25)❌ 
│ ├─┬/_cluster/reroute
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           ├──[➖] required (28752:17)❌ 
│ │           ├──[➖] type (28737:19)❌ 
│ │           ├──[➖] properties (28739:15)❌ 
│ │           ├──[➖] properties (28741:15)❌ 
│ │           ├──[➖] properties (28745:15)❌ 
│ │           ├──[➕] allOf (28751:17)
│ │           └──[➕] allOf (32138:7)
│ ├─┬/_cluster/stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (28772:13)❌ 
│ ├─┬/_cluster/state
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[➖] type (28758:19)❌ 
│ ├─┬/_cluster/state/{metric}/{index}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[➖] type (28758:19)❌ 
│ ├─┬/_cluster/state/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[➖] type (28758:19)❌ 
│ ├─┬/_cluster/stats/{metric}/{index_metric}/nodes/{node_id}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (28772:13)❌ 
│ ├─┬/_component_template/{name}
│ │ └─┬GET
│ │   └──[➕] parameters (17181:13)❌ 
│ ├─┬/_cluster/stats/nodes/{node_id}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (28772:13)❌ 
│ ├─┬/_cluster/stats/{metric}/nodes/{node_id}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (28772:13)❌ 
│ └─┬/_component_template
│   └─┬GET
│     └──[➕] parameters (17181:13)❌ 
└─┬Components
  ├──[➕] parameters (17180:7)
  ├──[➖] schemas (49028:7)❌ 
  ├─┬cluster.stats___ClusterJvmVersion
  │ └─┬count
  │   ├──[🔀] type (48690:17)❌ 
  │   └──[➕] format (48691:19)❌ 
  ├─┬cluster.stats___ClusterProcessOpenFileDescriptors
  │ ├─┬min
  │ │ ├──[🔀] type (48952:17)❌ 
  │ │ └──[➕] format (48953:19)❌ 
  │ ├─┬max
  │ │ ├──[🔀] type (48946:17)❌ 
  │ │ └──[➕] format (48947:19)❌ 
  │ └─┬avg
  │   ├──[🔀] type (48940:17)❌ 
  │   └──[➕] format (48941:19)❌ 
  ├─┬cluster.stats___NodePackagingType
  │ └─┬count
  │   ├──[🔀] type (49120:17)❌ 
  │   └──[➕] format (49121:19)❌ 
  ├─┬cluster.stats___ClusterJvm
  │ └─┬threads
  │   ├──[🔀] type (48652:17)❌ 
  │   └──[➕] format (48653:19)❌ 
  ├─┬cluster.stats___ClusterIngest
  │ └─┬number_of_pipelines
  │   ├──[🔀] type (48632:17)❌ 
  │   └──[➕] format (48633:19)❌ 
  ├─┬cluster.stats___ClusterShardMetrics
  │ ├─┬avg
  │ │ └──[➕] format (48985:19)❌ 
  │ ├─┬max
  │ │ └──[➕] format (48989:19)❌ 
  │ └─┬min
  │   └──[➕] format (48993:19)❌ 
  ├─┬cluster.health___IndexHealthStats
  │ ├─┬initializing_shards
  │ │ ├──[🔀] type (48127:17)❌ 
  │ │ └──[➕] format (48128:19)❌ 
  │ ├─┬active_shards
  │ │ ├──[🔀] type (48124:17)❌ 
  │ │ └──[➕] format (48125:19)❌ 
  │ ├─┬active_primary_shards
  │ │ ├──[🔀] type (48121:17)❌ 
  │ │ └──[➕] format (48122:19)❌ 
  │ ├─┬relocating_shards
  │ │ ├──[🔀] type (48136:17)❌ 
  │ │ └──[➕] format (48137:19)❌ 
  │ ├─┬unassigned_shards
  │ │ ├──[🔀] type (48145:17)❌ 
  │ │ └──[➕] format (48146:19)❌ 
  │ ├─┬number_of_replicas
  │ │ ├──[🔀] type (48130:17)❌ 
  │ │ └──[➕] format (48131:19)❌ 
  │ └─┬number_of_shards
  │   ├──[🔀] type (48133:17)❌ 
  │   └──[➕] format (48134:19)❌ 
  ├─┬cluster.health___AwarenessAttributeStats
  │ ├─┬unassigned_shards
  │ │ ├──[🔀] type (48017:17)❌ 
  │ │ └──[➕] format (48018:19)❌ 
  │ ├─┬weight
  │ │ ├──[🔀] type (48023:17)❌ 
  │ │ └──[➕] format (48024:19)❌ 
  │ ├─┬relocating_shards
  │ │ ├──[🔀] type (48014:17)❌ 
  │ │ └──[➕] format (48015:19)❌ 
  │ ├─┬data_nodes
  │ │ ├──[🔀] type (48020:17)❌ 
  │ │ └──[➕] format (48021:19)❌ 
  │ ├─┬initializing_shards
  │ │ ├──[🔀] type (48011:17)❌ 
  │ │ └──[➕] format (48012:19)❌ 
  │ └─┬active_shards
  │   ├──[🔀] type (48008:17)❌ 
  │   └──[➕] format (48009:19)❌ 
  ├─┬cluster.stats___FieldTypesMappings
  │ ├──[➖] properties (48878:9)❌ 
  │ ├──[➖] properties (48881:9)❌ 
  │ ├──[➖] properties (48883:9)❌ 
  │ └──[➖] properties (48875:9)❌ 
  ├─┬cluster.remote_info___ClusterRemoteProxyInfo
  │ ├─┬num_proxy_sockets_connected
  │ │ ├──[🔀] type (48242:17)❌ 
  │ │ └──[➕] format (48243:19)❌ 
  │ └─┬max_proxy_socket_connections
  │   ├──[🔀] type (48245:17)❌ 
  │   └──[➕] format (48246:19)❌ 
  ├─┬cluster.health___HealthResponseBody
  │ ├─┬unassigned_shards
  │ │ ├──[🔀] type (48099:17)❌ 
  │ │ └──[➕] format (48100:19)❌ 
  │ ├─┬active_primary_shards
  │ │ ├──[🔀] type (48030:17)❌ 
  │ │ └──[➕] format (48031:19)❌ 
  │ ├─┬active_shards
  │ │ ├──[🔀] type (48034:17)❌ 
  │ │ └──[➕] format (48035:19)❌ 
  │ ├─┬number_of_nodes
  │ │ ├──[🔀] type (48078:17)❌ 
  │ │ └──[➕] format (48079:19)❌ 
  │ ├─┬number_of_pending_tasks
  │ │ ├──[🔀] type (48082:17)❌ 
  │ │ └──[➕] format (48083:19)❌ 
  │ ├─┬initializing_shards
  │ │ ├──[🔀] type (48066:17)❌ 
  │ │ └──[➕] format (48067:19)❌ 
  │ ├─┬number_of_data_nodes
  │ │ ├──[🔀] type (48070:17)❌ 
  │ │ └──[➕] format (48071:19)❌ 
  │ ├─┬number_of_in_flight_fetch
  │ │ ├──[🔀] type (48074:17)❌ 
  │ │ └──[➕] format (48075:19)❌ 
  │ ├─┬delayed_unassigned_shards
  │ │ ├──[🔀] type (48050:17)❌ 
  │ │ └──[➕] format (48051:19)❌ 
  │ └─┬relocating_shards
  │   ├──[🔀] type (48086:17)❌ 
  │   └──[➕] format (48087:19)❌ 
  ├─┬cluster.allocation_explain___UnassignedInformation
  │ └─┬failed_allocation_attempts
  │   ├──[🔀] type (47963:17)❌ 
  │   └──[➕] format (47964:19)❌ 
  ├─┬cluster.stats___ClusterOperatingSystemName
  │ └─┬count
  │   ├──[🔀] type (48894:17)❌ 
  │   └──[➕] format (48895:19)❌ 
  ├─┬cluster.stats___ClusterOperatingSystemArchitecture
  │ └─┬count
  │   ├──[🔀] type (48884:17)❌ 
  │   └──[➕] format (48885:19)❌ 
  ├─┬cluster.stats___ClusterNodeCount
  │ ├─┬data_frozen
  │ │ ├──[🔀] type (48747:17)❌ 
  │ │ └──[➕] format (48748:19)❌ 
  │ ├─┬data_hot
  │ │ ├──[🔀] type (48750:17)❌ 
  │ │ └──[➕] format (48751:19)❌ 
  │ ├─┬data_warm
  │ │ ├──[🔀] type (48753:17)❌ 
  │ │ └──[➕] format (48754:19)❌ 
  │ ├─┬cluster_manager
  │ │ ├──[🔀] type (48762:17)❌ 
  │ │ └──[➕] format (48763:19)❌ 
  │ ├─┬remote_cluster_client
  │ │ ├──[🔀] type (48769:17)❌ 
  │ │ └──[➕] format (48770:19)❌ 
  │ ├─┬ingest
  │ │ ├──[🔀] type (48756:17)❌ 
  │ │ └──[➕] format (48757:19)❌ 
  │ ├─┬data_content
  │ │ ├──[🔀] type (48744:17)❌ 
  │ │ └──[➕] format (48745:19)❌ 
  │ ├─┬coordinating_only
  │ │ ├──[🔀] type (48735:17)❌ 
  │ │ └──[➕] format (48736:19)❌ 
  │ ├─┬master
  │ │ ├──[🔀] type (48759:17)❌ 
  │ │ └──[➕] format (48760:19)❌ 
  │ ├─┬ml
  │ │ ├──[🔀] type (48766:17)❌ 
  │ │ └──[➕] format (48767:19)❌ 
  │ ├─┬data
  │ │ ├──[🔀] type (48738:17)❌ 
  │ │ └──[➕] format (48739:19)❌ 
  │ ├─┬search
  │ │ ├──[🔀] type (48772:17)❌ 
  │ │ └──[➕] format (48773:19)❌ 
  │ ├─┬voting_only
  │ │ ├──[🔀] type (48782:17)❌ 
  │ │ └──[➕] format (48783:19)❌ 
  │ ├─┬transform
  │ │ ├──[🔀] type (48779:17)❌ 
  │ │ └──[➕] format (48780:19)❌ 
  │ ├─┬data_cold
  │ │ ├──[🔀] type (48741:17)❌ 
  │ │ └──[➕] format (48742:19)❌ 
  │ └─┬total
  │   ├──[🔀] type (48776:17)❌ 
  │   └──[➕] format (48777:19)❌ 
  ├─┬cluster.pending_tasks___PendingTask
  │ └─┬insert_order
  │   ├──[🔀] type (48197:17)❌ 
  │   └──[➕] format (48198:19)❌ 
  ├─┬cluster.reroute___CommandCancelAction
  │ └─┬shard
  │   ├──[🔀] type (48372:17)❌ 
  │   └──[➕] format (48373:19)❌ 
  ├─┬cluster.stats___ClusterIndicesShards
  │ ├─┬primaries
  │ │ ├──[🔀] type (48602:17)❌ 
  │ │ └──[➕] format (48603:19)❌ 
  │ ├─┬total
  │ │ ├──[🔀] type (48610:17)❌ 
  │ │ └──[➕] format (48611:19)❌ 
  │ └─┬replication
  │   ├──[🔀] type (48606:17)❌ 
  │   └──[➕] format (48607:19)❌ 
  ├─┬cluster.stats___ClusterProcessor
  │ ├─┬count
  │ │ ├──[🔀] type (48962:17)❌ 
  │ │ └──[➕] format (48963:19)❌ 
  │ ├─┬failed
  │ │ ├──[🔀] type (48968:17)❌ 
  │ │ └──[➕] format (48969:19)❌ 
  │ └─┬current
  │   ├──[🔀] type (48965:17)❌ 
  │   └──[➕] format (48966:19)❌ 
  ├─┬cluster.allocation_explain___ReservedSize
  │ └─┬total
  │   ├──[🔀] type (47940:17)❌ 
  │   └──[➕] format (47941:19)❌ 
  ├─┬cluster.remote_info___ClusterRemoteSniffInfo
  │ ├─┬num_nodes_connected
  │ │ ├──[🔀] type (48269:17)❌ 
  │ │ └──[➕] format (48270:19)❌ 
  │ └─┬max_connections_per_cluster
  │   ├──[🔀] type (48266:17)❌ 
  │   └──[➕] format (48267:19)❌ 
  ├─┬cluster.reroute___CommandAllocateReplicaAction
  │ └─┬shard
  │   ├──[🔀] type (48358:17)❌ 
  │   └──[➕] format (48359:19)❌ 
  ├─┬cluster.stats___ClusterOperatingSystemPrettyName
  │ └─┬count
  │   ├──[🔀] type (48906:17)❌ 
  │   └──[➕] format (48907:19)❌ 
  ├─┬cluster.stats___IndicesVersions
  │ ├─┬primary_shard_count
  │ │ ├──[🔀] type (49090:17)❌ 
  │ │ └──[➕] format (49091:19)❌ 
  │ └─┬index_count
  │   ├──[🔀] type (49087:17)❌ 
  │   └──[➕] format (49088:19)❌ 
  ├─┬cluster.allocation_explain___NodeAllocationExplanation
  │ └─┬weight_ranking
  │   ├──[🔀] type (47910:17)❌ 
  │   └──[➕] format (47911:19)❌ 
  ├─┬cluster.reroute___CommandMoveAction
  │ └─┬shard
  │   ├──[🔀] type (48388:17)❌ 
  │   └──[➕] format (48389:19)❌ 
  ├─┬cluster.reroute___CommandAllocatePrimaryAction
  │ └─┬shard
  │   ├──[🔀] type (48340:17)❌ 
  │   └──[➕] format (48341:19)❌ 
  ├─┬cluster.health___ShardHealthStats
  │ ├─┬active_shards
  │ │ ├──[🔀] type (48167:17)❌ 
  │ │ └──[➕] format (48168:19)❌ 
  │ ├─┬unassigned_shards
  │ │ ├──[🔀] type (48180:17)❌ 
  │ │ └──[➕] format (48181:19)❌ 
  │ ├─┬relocating_shards
  │ │ ├──[🔀] type (48175:17)❌ 
  │ │ └──[➕] format (48176:19)❌ 
  │ └─┬initializing_shards
  │   ├──[🔀] type (48170:17)❌ 
  │   └──[➕] format (48171:19)❌ 
  ├─┬cluster.stats___ClusterNodes
  │ └─┬discovery_types
  │   └─┬Schema
  │     ├──[🔀] type (48801:19)❌ 
  │     └──[➕] format (48802:21)❌ 
  ├─┬cluster.allocation_explain___CurrentNode
  │ └─┬weight_ranking
  │   ├──[🔀] type (47841:17)❌ 
  │   └──[➕] format (47842:19)❌ 
  ├─┬cluster.stats___FieldTypes
  │ ├──[➖] properties (48851:9)❌ 
  │ ├──[➖] properties (48854:9)❌ 
  │ ├──[➖] properties (48857:9)❌ 
  │ ├──[➖] properties (48860:9)❌ 
  │ ├─┬count
  │ │ ├──[🔀] type (49005:17)❌ 
  │ │ └──[➕] format (49006:19)❌ 
  │ └─┬index_count
  │   ├──[🔀] type (49009:17)❌ 
  │   └──[➕] format (49010:19)❌ 
  ├─┬cluster.reroute___RerouteParameters
  │ └─┬shard
  │   ├──[🔀] type (48451:17)❌ 
  │   └──[➕] format (48452:19)❌ 
  ├─┬cluster.stats___ClusterNetworkTypes
  │ ├─┬transport_types
  │ │ └─┬Schema
  │ │   ├──[🔀] type (48726:19)❌ 
  │ │   └──[➕] format (48727:21)❌ 
  │ └─┬http_types
  │   └─┬Schema
  │     ├──[🔀] type (48720:19)❌ 
  │     └──[➕] format (48721:21)❌ 
  ├─┬cluster.stats___ClusterOperatingSystem
  │ ├─┬allocated_processors
  │ │ ├──[🔀] type (48847:17)❌ 
  │ │ └──[➕] format (48848:19)❌ 
  │ └─┬available_processors
  │   ├──[🔀] type (48856:17)❌ 
  │   └──[➕] format (48857:19)❌ 
  └─┬cluster.stats___ClusterIndices
    └─┬count
      ├──[🔀] type (48574:17)❌ 
      └──[➕] format (48575:19)❌ 

Document Element Total Changes Breaking Changes
paths 24 22
components 179 178
  • BREAKING Changes: 200 out of 203
  • Modifications: 91
  • Removals: 17
  • Additions: 95
  • Breaking Removals: 17
  • Breaking Modifications: 91
  • Breaking Additions: 92

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/12507335361/artifacts/2364036387

API Coverage

Before After Δ
Covered (%) 606 (59.35 %) 606 (59.35 %) 0 (0 %)
Uncovered (%) 415 (40.65 %) 415 (40.65 %) 0 (0 %)
Unknown 43 43 0

Copy link
Contributor

Spec Test Coverage Analysis

Total Tested
536 541 (100.93 %)

Copy link
Member

@dblock dblock left a comment

Choose a reason for hiding this comment

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

Looks good, fix vale complaints pls? See the diff. We should enable that to fail CI as well.

Signed-off-by: Thomas Farr <[email protected]>
@Xtansia Xtansia requested a review from dblock December 26, 2024 18:52
@Xtansia
Copy link
Collaborator Author

Xtansia commented Dec 26, 2024

Looks good, fix vale complaints pls? See the diff. We should enable that to fail CI as well.

Have fixed the vale complaints

@dblock dblock merged commit 1dac3c9 into opensearch-project:main Dec 27, 2024
31 checks passed
@Xtansia Xtansia deleted the fix/cluster-schemas branch December 30, 2024 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants