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

Fixed nodes API schemas #761

Merged
merged 3 commits into from
Jan 3, 2025
Merged

Conversation

Xtansia
Copy link
Collaborator

@Xtansia Xtansia commented Jan 3, 2025

Description

Fixed nodes API 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]>
@Xtansia Xtansia force-pushed the fix/nodes-schemas branch from f0d7cdb to b1547ea Compare January 3, 2025 00:25
Copy link
Contributor

github-actions bot commented Jan 3, 2025

Changes Analysis

Commit SHA: f9358e9
Comparing To SHA: 3d88921

API Changes

Summary

├─┬Paths
│ ├─┬/_nodes/{node_id}/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30501:13)❌ 
│ ├─┬/_nodes/usage/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_nodes/{node_id}/reload_secure_settings
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30483:13)❌ 
│ ├─┬/_nodes/stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30501:13)❌ 
│ ├─┬/_nodes/reload_secure_settings
│ │ └─┬POST
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30483:13)❌ 
│ ├─┬/_nodes/{node_id}/usage/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_nodes/{node_id}/stats/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30501:13)❌ 
│ ├─┬/_nodes/stats/{metric}/{index_metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30501:13)❌ 
│ ├─┬/_nodes/usage
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_nodes/{node_id_or_metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_nodes/stats/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           └──[🔀] $ref (30501:13)❌ 
│ ├─┬/_nodes
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_nodes/{node_id}/usage
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ ├─┬/_template/{name}
│ │ ├─┬PUT
│ │ │ └─┬Requestbody
│ │ │   └─┬application/json
│ │ │     └─┬Schema
│ │ │       └─┬index_patterns
│ │ │         └──[🔀] $ref (34520:9)❌ 
│ │ └─┬POST
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └─┬index_patterns
│ │           └──[🔀] $ref (34520:9)❌ 
│ ├─┬/_nodes/{node_id}/{metric}
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └──application/json
│ └─┬/_nodes/{node_id}/stats
│   └─┬GET
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └─┬Schema
│             └──[🔀] $ref (30501:13)❌ 
└─┬Components
  ├──[➖] schemas (54783:7)❌ 
  ├──[➖] schemas (55739:7)❌ 
  ├──[➖] schemas (55595:7)❌ 
  ├──[➖] schemas (54933:7)❌ 
  ├──[➖] schemas (54876:7)❌ 
  ├──[➖] schemas (55302:7)❌ 
  ├──[➖] schemas (55583:7)❌ 
  ├──[➖] schemas (55483:7)❌ 
  ├──[➖] schemas (55433:7)❌ 
  ├──[➖] schemas (55699:7)❌ 
  ├──[➖] schemas (55352:7)❌ 
  ├──[➖] schemas (55546:7)❌ 
  ├──[➖] schemas (55507:7)❌ 
  ├──[➖] schemas (55803:7)❌ 
  ├──[➖] schemas (55229:7)❌ 
  ├──[➖] schemas (55537:7)❌ 
  ├──[➖] schemas (54510:7)❌ 
  ├──[➖] schemas (55400:7)❌ 
  ├──[➖] schemas (55373:7)❌ 
  ├──[➖] schemas (54731:7)❌ 
  ├──[➖] schemas (55176:7)❌ 
  ├──[➖] schemas (55448:7)❌ 
  ├──[➖] schemas (55468:7)❌ 
  ├──[➖] schemas (54622:7)❌ 
  ├──[➖] schemas (55106:7)❌ 
  ├──[➕] schemas (56013:7)
  ├──[➖] schemas (55600:7)❌ 
  ├──[➖] schemas (54691:7)❌ 
  ├──[➖] schemas (54554:7)❌ 
  ├──[➕] schemas (56334:7)
  ├──[➖] schemas (54540:7)❌ 
  ├──[➖] schemas (55199:7)❌ 
  ├──[➖] schemas (55086:7)❌ 
  ├──[➖] schemas (54655:7)❌ 
  ├──[➖] schemas (54805:7)❌ 
  ├──[➖] schemas (55494:7)❌ 
  ├──[➕] schemas (56139:7)
  ├──[➖] schemas (54488:7)❌ 
  ├──[➖] schemas (54997:7)❌ 
  ├──[➖] schemas (55325:7)❌ 
  ├──[➖] schemas (55452:7)❌ 
  ├──[➖] schemas (55144:7)❌ 
  ├──[➖] schemas (54629:7)❌ 
  ├──[➖] schemas (54638:7)❌ 
  ├──[➖] schemas (55404:7)❌ 
  ├──[➖] schemas (56560:7)❌ 
  ├──[➖] schemas (56480:7)❌ 
  ├──[➖] schemas (55380:7)❌ 
  ├──[➖] schemas (54650:7)❌ 
  ├──[➖] schemas (55169:7)❌ 
  ├──[➖] schemas (54909:7)❌ 
  ├──[➖] schemas (55578:7)❌ 
  ├──[➖] schemas (54923:7)❌ 
  ├──[➖] schemas (54888:7)❌ 
  ├──[➖] schemas (55779:7)❌ 
  ├──[➖] schemas (55474:7)❌ 
  ├──[➖] schemas (54833:7)❌ 
  ├──[➖] schemas (55798:7)❌ 
  ├──[➖] schemas (55024:7)❌ 
  ├──[➖] schemas (55393:7)❌ 
  ├──[➖] schemas (54816:7)❌ 
  ├──[➖] schemas (55286:7)❌ 
  ├──[➖] schemas (55186:7)❌ 
  ├──[➖] schemas (55421:7)❌ 
  ├──[➖] schemas (55036:7)❌ 
  ├──[➖] schemas (56494:7)❌ 
  ├──[➖] schemas (54723:7)❌ 
  ├──[➖] schemas (55314:7)❌ 
  ├──[➖] schemas (55730:7)❌ 
  ├──[➖] schemas (54985:7)❌ 
  ├──[➖] schemas (55093:7)❌ 
  ├──[➖] schemas (55556:7)❌ 
  ├──[➖] schemas (54582:7)❌ 
  ├──[➖] schemas (56597:7)❌ 
  ├──[➖] schemas (54868:7)❌ 
  ├──[➖] schemas (54904:7)❌ 
  ├──[➖] schemas (55565:7)❌ 
  ├──[➖] schemas (56350:7)❌ 
  ├──[➖] schemas (54956:7)❌ 
  ├──[➖] schemas (55338:7)❌ 
  ├──[➖] schemas (55605:7)❌ 
  ├──[➖] schemas (55162:7)❌ 
  ├──[➖] schemas (54531:7)❌ 
  ├──[➖] schemas (55520:7)❌ 
  ├──[➖] schemas (54702:7)❌ 
  ├──[➖] schemas (55463:7)❌ 
  ├──[➖] schemas (55077:7)❌ 
  ├──[➖] schemas (55446:7)❌ 
  ├──[➖] schemas (55588:7)❌ 
  ├──[➖] schemas (55793:7)❌ 
  ├──[➖] schemas (55426:7)❌ 
  ├──[➖] schemas (54565:7)❌ 
  ├──[➖] schemas (55268:7)❌ 
  ├──[➕] schemas (56423:7)
  ├──[➕] schemas (55722:7)
  ├──[➕] schemas (55356:7)
  ├──[➕] schemas (55711:7)
  ├──[➕] schemas (55211:7)
  ├──[➕] schemas (56357:7)
  ├──[➕] schemas (56312:7)
  ├──[➕] schemas (55471:7)
  ├──[➕] schemas (56598:7)
  ├──[➕] schemas (34641:7)
  ├──[➕] schemas (34519:7)
  ├──[➕] schemas (55553:7)
  ├──[➕] schemas (55742:7)
  ├──[➕] schemas (56635:7)
  ├──[➕] schemas (56403:7)
  ├──[➕] schemas (55818:7)
  ├──[➕] schemas (56172:7)
  ├──[➕] schemas (56100:7)
  ├──[➕] schemas (55479:7)
  ├──[➕] schemas (55341:7)
  ├──[➕] schemas (55579:7)
  ├──[➕] schemas (55399:7)
  ├──[➕] schemas (56114:7)
  ├──[➕] schemas (55204:7)
  ├──[➕] schemas (56182:7)
  ├──[➕] schemas (56323:7)
  ├──[➕] schemas (56074:7)
  ├──[➕] schemas (56162:7)
  ├──[➕] schemas (56439:7)
  ├──[➕] schemas (55436:7)
  ├──[➕] schemas (55858:7)
  ├──[➕] schemas (56223:7)
  ├──[➕] schemas (55845:7)
  ├──[➕] schemas (55823:7)
  ├──[➕] schemas (56063:7)
  ├──[➕] schemas (56669:7)
  ├──[➕] schemas (55543:7)
  ├──[➕] schemas (56279:7)
  ├──[➕] schemas (56044:7)
  ├──[➕] schemas (56291:7)
  ├──[➕] schemas (55628:7)
  ├──[➕] schemas (55330:7)
  ├──[➕] schemas (55321:7)
  ├──[➕] schemas (56235:7)
  ├──[➕] schemas (55277:7)
  ├──[➕] schemas (55508:7)
  ├──[➕] schemas (56677:7)
  ├──[➕] schemas (56446:7)
  ├──[➕] schemas (56247:7)
  ├──[➕] schemas (55290:7)
  ├──[➕] schemas (55503:7)
  ├──[➕] schemas (56490:7)
  ├──[➕] schemas (56306:7)
  ├──[➕] schemas (55361:7)
  ├──[➕] schemas (55729:7)
  ├──[➕] schemas (55979:7)
  ├──[➕] schemas (55246:7)
  ├──[➕] schemas (55868:7)
  ├──[➕] schemas (55616:7)
  ├──[➕] schemas (54924:7)
  ├──[➕] schemas (56260:7)
  ├──[➕] schemas (56412:7)
  ├──[➕] schemas (55960:7)
  ├──[➕] schemas (55222:7)
  ├──[➕] schemas (56479:7)
  ├──[➕] schemas (55998:7)
  ├──[➕] schemas (55269:7)
  ├──[➕] schemas (56152:7)
  ├──[➕] schemas (55940:7)
  ├──[➕] schemas (51875:7)
  ├──[➕] schemas (56504:7)
  ├──[➕] schemas (55670:7)
  ├──[➕] schemas (55218:7)
  ├──[➕] schemas (55492:7)
  ├──[➕] schemas (56385:7)
  ├──[➕] schemas (56308:7)
  ├──[➕] schemas (56468:7)
  ├──[➕] schemas (55898:7)
  ├──[➕] schemas (56499:7)
  ├──[➕] schemas (56510:7)
  ├──[➕] schemas (55408:7)
  ├──[➕] schemas (56343:7)
  ├──[➕] schemas (55799:7)
  ├──[➕] schemas (55419:7)
  ├──[➕] schemas (56095:7)
  ├──[➕] schemas (56371:7)
  ├──[➕] schemas (56211:7)
  ├──[➕] schemas (55747:7)
  ├──[➕] schemas (56039:7)
  ├──[➕] schemas (55655:7)
  ├──[➕] schemas (56485:7)
  ├──[➕] schemas (56192:7)
  ├──[➕] schemas (55304:7)
  ├──[➕] schemas (56019:7)
  ├──[➕] schemas (56070:7)
  ├──[➕] schemas (55972:7)
  ├──[➕] schemas (56030:7)
  ├──[➕] schemas (56328:7)
  ├──[➕] schemas (32722:7)
  ├─┬nodes.info___NodeJvmInfo
  │ ├──[➕] properties (55101:9)
  │ ├─┬using_compressed_ordinary_object_pointers
  │ │ └──[🔀] $ref (34459:20)❌ 
  │ └─┬pid
  │   ├──[🔀] type (55099:17)❌ 
  │   └──[➕] format (55100:19)❌ 
  ├─┬nodes.info___NodeThreadPoolInfo
  │ ├─┬core
  │ │ ├──[🔀] type (55185:17)❌ 
  │ │ └──[➕] format (55186:19)❌ 
  │ ├─┬size
  │ │ ├──[🔀] type (55196:17)❌ 
  │ │ └──[➕] format (55197:19)❌ 
  │ ├─┬max
  │ │ ├──[🔀] type (55190:17)❌ 
  │ │ └──[➕] format (55191:19)❌ 
  │ └─┬queue_size
  │   ├──[🔀] type (55193:17)❌ 
  │   └──[➕] format (55194:19)❌ 
  ├─┬nodes.info___NodeInfoSettingsCluster
  │ ├─┬deprecation_indexing
  │ │ └──[🔀] $ref (54924:13)❌ 
  │ ├─┬initial_cluster_manager_nodes
  │ │ └──[🔀] $ref (34520:9)❌ 
  │ └─┬initial_master_nodes
  │   └──[🔀] $ref (34520:9)❌ 
  ├─┬nodes.usage___NodeUsage
  │ ├─┬rest_actions
  │ │ └─┬Schema
  │ │   ├──[🔀] type (56693:19)❌ 
  │ │   └──[➕] format (56694:21)❌ 
  │ └─┬aggregations
  │   └──[🔀] additionalProperties (56701:33)❌ 
  ├─┬nodes.info___NodeInfoOSCPU
  │ ├─┬total_cores
  │ │ ├──[🔀] type (54771:17)❌ 
  │ │ └──[➕] format (54772:19)❌ 
  │ ├─┬mhz
  │ │ ├──[🔀] type (54766:17)❌ 
  │ │ └──[➕] format (54767:19)❌ 
  │ ├─┬total_sockets
  │ │ ├──[🔀] type (54774:17)❌ 
  │ │ └──[➕] format (54775:19)❌ 
  │ └─┬cores_per_socket
  │   ├──[🔀] type (54763:17)❌ 
  │   └──[➕] format (54764:19)❌ 
  ├─┬nodes.info___NodeInfo
  │ ├─┬total_indexing_buffer_in_bytes
  │ │ └──[🔀] $ref (33075:13)❌ 
  │ └─┬total_indexing_buffer
  │   └──[🔀] $ref (32486:13)❌ 
  ├─┬nodes.info___NodeInfoSettingsHttp
  │ ├─┬port
  │ │ └──[🔀] $ref (34494:20)❌ 
  │ └─┬compression
  │   └──[🔀] $ref (34459:20)❌ 
  ├─┬nodes.info___NodeOperatingSystemInfo
  │ ├──[➕] properties (55148:9)
  │ ├─┬available_processors
  │ │ ├──[🔀] type (55138:17)❌ 
  │ │ └──[➕] format (55139:19)❌ 
  │ └─┬allocated_processors
  │   ├──[🔀] type (55142:17)❌ 
  │   └──[➕] format (55143:19)❌ 
  ├─┬nodes.info___NodeProcessInfo
  │ ├──[➕] properties (55173:9)
  │ └─┬id
  │   ├──[🔀] type (55168:17)❌ 
  │   └──[➕] format (55169:19)❌ 
  ├─┬nodes.info___NodeInfoNetwork
  │ └─┬refresh_interval
  │   ├──[🔀] type (54737:17)❌ 
  │   └──[➕] format (54738:19)❌ 
  ├─┬nodes.info___NodeInfoSettingsNode
  │ └─┬attr
  │   └──[🔀] $ref (55049:11)❌ 
  ├─┬_common.analysis___StopWords
  │ └──[🔀] $ref (39879:20)❌ 
  └─┬indices.stats___IndexShardStats
    ├─┬ALLOF
    │ ├──[➖] properties (51860:13)❌ 
    │ ├──[➖] properties (51864:13)❌ 
    │ ├──[➖] properties (51858:13)❌ 
    │ ├──[➖] properties (51862:13)❌ 
    │ └──[➖] properties (51866:13)❌ 
    └─┬ALLOF
      └──[🔀] $ref (51876:9)❌ 

Document Element Total Changes Breaking Changes
paths 10 10
components 240 141
  • BREAKING Changes: 151 out of 250
  • Modifications: 36
  • Removals: 95
  • Additions: 119
  • Breaking Removals: 95
  • Breaking Modifications: 36
  • Breaking Additions: 14

Report

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

API Coverage

Before After Δ
Covered (%) 609 (59.65 %) 609 (59.65 %) 0 (0 %)
Uncovered (%) 412 (40.35 %) 412 (40.35 %) 0 (0 %)
Unknown 43 43 0

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

github-actions bot commented Jan 3, 2025

Spec Test Coverage Analysis

Total Tested
539 539 (100 %)

@dblock dblock merged commit dafcdd6 into opensearch-project:main Jan 3, 2025
32 checks passed
@Xtansia Xtansia deleted the fix/nodes-schemas branch January 5, 2025 20:44
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