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

Missing required fields #365

Merged
merged 3 commits into from
Jul 3, 2024
Merged

Conversation

Bzil
Copy link
Contributor

@Bzil Bzil commented Jun 27, 2024

Description

Related to issue opensearch-project/opensearch-java#1040

Issues Resolved

Bug

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.

@dblock
Copy link
Member

dblock commented Jun 27, 2024

Thanks! This is a good start, keep iterating on the test for a basic nodes info response.

Please amend your commit for DCO with git commit --amend -s.

Copy link

github-actions bot commented Jun 27, 2024

Changes Analysis

Commit SHA: 3e72602
Comparing To SHA: 666812e

API Changes

Summary


└─┬Components
  ├──[➖] schemas (45785:7)❌ 
  ├──[➖] schemas (45677:7)❌ 
  ├──[➕] schemas (45819:7)
  ├──[➕] schemas (45452:7)
  ├──[➕] schemas (45713:7)
  ├──[➕] schemas (45708:7)
  ├──[➕] schemas (45703:7)
  ├──[➕] schemas (45698:7)
  ├──[➕] schemas (45598:7)
  ├─┬nodes.info:NodeInfoSettings
  │ └──[➕] properties (45649:9)
  ├─┬nodes.info:ResponseBase
  │ ├──[➖] allOf (44935:7)❌ 
  │ └─┬ALLOF
  │   ├──[➕] required (45972:15)❌ 
  │   └──[➕] properties (45967:13)
  ├─┬nodes.info:NodeInfoDiscover
  │ └──[➖] required (45403:11)❌ 
  ├─┬nodes.info:NodeInfoSettingsNode
  │ └─┬attr
  │   └──[🔀] $ref (45819:13)❌ 
  ├─┬nodes.info:NodeInfoSettingsCluster
  │ └──[➖] required (45651:11)❌ 
  ├─┬nodes.info:Metric
  │ └──[➖] enum (45292:11)❌ 
  ├─┬nodes.info:NodeInfo
  │ ├──[➖] required (45358:11)❌ 
  │ └──[➕] properties (45357:9)
  ├─┬nodes.info:NodeInfoSettingsTransport
  │ └─┬type
  │   └──[🔀] $ref (45813:11)❌ 
  ├─┬nodes.info:NodeJvmInfo
  │ ├──[➕] required (45889:11)❌ 
  │ ├──[➖] required (45853:11)❌ 
  │ └──[➕] properties (45867:9)
  ├─┬nodes.info:NodeInfoSettingsHttp
  │ └─┬type
  │   └──[🔀] $ref (45684:11)❌ 
  ├─┬_common:PluginStats
  │ ├──[➖] required (26973:11)❌ 
  │ └──[➕] properties (26963:9)
  ├─┬nodes.info:NodeInfoPath
  │ └──[➖] required (45559:11)❌ 
  └─┬_common:NodeRole
    └──[➕] enum (26795:11)

Document Element Total Changes Breaking Changes
components 28 16
  • BREAKING Changes: 16 out of 28
  • Modifications: 3
  • Removals: 10
  • Additions: 15
  • Breaking Removals: 10
  • Breaking Modifications: 3
  • Breaking Additions: 2

Report

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

API Coverage

Before After Δ
Covered (%) 483 (47.31 %) 483 (47.31 %) 0 (0 %)
Uncovered (%) 538 (52.69 %) 538 (52.69 %) 0 (0 %)
Unknown 24 24 0

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.

The test doesn't seem to have the right path. Run it, make sure it fails without your fix and passes with it.

description: Test nodes endpoints.
chapters:
- synopsis: Nodes with a json response.
path: /_cat/aliases
Copy link
Member

Choose a reason for hiding this comment

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

This should be _nodes.

@dblock
Copy link
Member

dblock commented Jul 2, 2024

Looks like a legit spec test failure.

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.

Turned out to be a lot more than just a required/optional field! Good work.

Want to try and add tests/fix the remainder of nodes API? :)

@dblock dblock merged commit cbc0b08 into opensearch-project:main Jul 3, 2024
7 checks passed
@Bzil Bzil deleted the fix-nodes-output branch July 3, 2024 15:59
@Bzil
Copy link
Contributor Author

Bzil commented Jul 3, 2024

Indeed, I will try to do this, but it's will depend of my time/work

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