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
Remove some internal details for Rulesets API #1346
Conversation
This is an internal-only kind and is not exposed in the public API.
changelog detected ✅ |
@@ -734,19 +730,16 @@ type UpdateRulesetParams struct { | |||
} | |||
|
|||
type UpdateEntrypointRulesetParams struct { | |||
Name string `json:"name,omitempty"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This technically can be useful to specify but has some slightly inconsistent behaviour from the API if it is. If you specify it and the entry point ruleset didn't exist before, then this name will be used. If the entry point ruleset already exists though, this name will be ignored (and the ruleset will not be renamed).
Omitting the name always works consistently and will cause the API to set it to "default" if an entry point ruleset does not already exist. This is why I think it's probably best to not allow users to set the name explicitly to avoid confusion, but we can keep it here if that would be too much of a breaking change. What do you think @jacobbednarz?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
works for me!
* `ShareableEntitlementName` cannot be used in requests using the public API. * `Version` cannot be specified in requests as it is computed by the API. * `Name` and `Kind` are not necessary when updating entry point rulesets. They are populated automatically by the API.
Codecov Report
@@ Coverage Diff @@
## master #1346 +/- ##
==========================================
+ Coverage 48.33% 48.50% +0.16%
==========================================
Files 133 135 +2
Lines 13023 13202 +179
==========================================
+ Hits 6295 6403 +108
- Misses 5201 5247 +46
- Partials 1527 1552 +25
|
This functionality has been released in v0.74.0. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
Description
Has your change been tested?
Using the existing Go unit tests, no new functionality has been added.
Types of changes
This is technically a breaking change in the Go API due to some fields being removed, although it would not have worked to use these fields with the Rulesets API in any case.
Checklist:
and relies on stable APIs.