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

BREAKING(aws): change the RESTMethodSettings type to a list of settings #6432

Open
nikpivkin opened this issue Apr 1, 2024 · 4 comments · May be fixed by #6441
Open

BREAKING(aws): change the RESTMethodSettings type to a list of settings #6432

nikpivkin opened this issue Apr 1, 2024 · 4 comments · May be fixed by #6441
Labels
kind/bug Categorizes issue or PR as related to a bug. scan/misconfiguration Issues relating to misconfiguration scanning

Comments

@nikpivkin
Copy link
Contributor

nikpivkin commented Apr 1, 2024

Several settings can be specified for the API stage.

@nikpivkin nikpivkin added kind/bug Categorizes issue or PR as related to a bug. scan/misconfiguration Issues relating to misconfiguration scanning labels Apr 1, 2024
@itaysk
Copy link
Contributor

itaysk commented Apr 9, 2024

is this about changing the input structure of the check? if so 1) need to update the schema as well 2) isn't it a breaking change?
cc @simar7

@nikpivkin
Copy link
Contributor Author

@itaysk
Yes, this is an update to the input data for the checks.

  1. Yes
  2. Most likely if users use this structure in custom checks. Should the title be updated?

@itaysk
Copy link
Contributor

itaysk commented Apr 9, 2024

yes, the title should be updated, and we should remember to mention it in the release notes.

also, I think we should be more minded that changing input structure is a breaking change and follow a procedure:

  1. explain why the change is needed
  2. is it possible to avoid it
  3. what is the impact / recovery method
  4. give some notice in advance, and collect feedback
  5. gradually roll out

I understand this might be a low impact change so we can fast-forward through some of the process, but we should at least be intentional about it

@simar7
Copy link
Member

simar7 commented Apr 9, 2024

@itaysk @nikpivkin we'll err on the side of caution and mark this as a breaking change. We don't have usage metrics so can't articulate how many users it will affect or how widely it is used (it's a non required argument).

@simar7 simar7 changed the title fix(aws): change the RESTMethodSettings type to a list of settings BREAKING(aws): change the RESTMethodSettings type to a list of settings Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. scan/misconfiguration Issues relating to misconfiguration scanning
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants