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

Updates the missing item types for security API related schemas #420

Conversation

DarshitChanpura
Copy link
Member

Description

This PR updates missing items property for parent properties of array type in the security schema.

Issues Resolved

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.

Copy link
Contributor

github-actions bot commented Jul 15, 2024

Changes Analysis

Commit SHA: ec97b6b
Comparing To SHA: e1cd369

API Changes

Summary

└─┬Components
  ├─┬security._common:SSLInfo
  │ ├─┬local_certificates_list
  │ │ └──[➕] items (48089:13)❌ 
  │ └─┬peer_certificates_list
  │   └──[➕] items (48084:13)❌ 
  ├─┬security._common:AuthInfo
  │ ├─┬custom_attribute_names
  │ │ └──[➕] items (47701:13)❌ 
  │ ├─┬roles
  │ │ └──[➕] items (47706:13)❌ 
  │ └─┬backend_roles
  │   └──[➕] items (47696:13)❌ 
  ├─┬security._common:DashboardsInfo
  │ └─┬sign_in_options
  │   └──[➕] items (47835:13)❌ 
  └─┬security._common:ConfigUpgradePayload
    └─┬config
      └──[➕] items (47798:13)❌ 

Document Element Total Changes Breaking Changes
components 7 7
  • BREAKING Changes: 7 out of 7
  • Additions: 7
  • Breaking Additions: 7

Report

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

API Coverage

Before After Δ
Covered (%) 490 (47.99 %) 490 (47.99 %) 0 (0 %)
Uncovered (%) 531 (52.01 %) 531 (52.01 %) 0 (0 %)
Unknown 24 24 0

@DarshitChanpura DarshitChanpura added the skip-changelog No need to update CHANGELOG. label Jul 15, 2024
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.

Add a test please into tests and update CHANGELOG?

Are all the schemas for these items the same? Should this be a $ref?

@nhtruong
Copy link
Collaborator

@dblock the recent PRs fail with this

@dblock
Copy link
Member

dblock commented Jul 15, 2024

@dblock the recent PRs fail with this

Fixed in #421.

@DarshitChanpura
Copy link
Member Author

@dblock I have a work-in-progress item for tests. I'll raise a separate PR to add tests for all security related APIs.

@dblock
Copy link
Member

dblock commented Jul 18, 2024

@dblock I have a work-in-progress item for tests. I'll raise a separate PR to add tests for all security related APIs.

We want to avoid regressions, so maybe PR the tests first?

Either way this PR should be rebased and pass existing tests.

@DarshitChanpura
Copy link
Member Author

i'll mark this as draft meanwhile.

@DarshitChanpura DarshitChanpura marked this pull request as draft July 18, 2024 19:29
@DarshitChanpura
Copy link
Member Author

Closing this as changes will be covered by #439

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No need to update CHANGELOG.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants