Add support to remove tag bindings from projects/workspaces #1023
Conversation
Datadog ReportBranch report: ✅ 0 Failed, 1419 Passed, 155 Skipped, 20m 41.54s Total Time 🔻 Code Coverage Decreases vs Default Branch (1)
|
sebasslash
force-pushed
the
sebasslash/remove-tag-bindings
branch
from
d9526c2 to
9ccdce0
Compare
project.go
Outdated
| @@ -44,6 +44,9 @@ type Projects interface { | |||
|
|
|||
| // AddTagBindings adds or modifies the value of existing tag binding keys for a project. | |||
| AddTagBindings(ctx context.Context, projectID string, options ProjectAddTagBindingsOptions) ([]*TagBinding, error) | |||
|
|
|||
| // DeleteTagBindings removes all existing tag bindings for a project. | |||
| DeleteTagBindings(ctx context.Context, projectID string) error | |||
There was a problem hiding this comment.
Can we call this DeleteAllTagBindings just in case we ever add the ability to delete specific ones?
workspace.go
Outdated
| @@ -829,6 +832,31 @@ func (s *workspaces) AddTagBindings(ctx context.Context, workspaceID string, opt | |||
| return response.Items, err | |||
| } | |||
|
|
|||
| // DeleteTagBindings removes all tag bindings associated with a workspace. This | |||
| // method will not remove any inherited tags. | |||
There was a problem hiding this comment.
💅
| // method will not remove any inherited tags. | |
| // method will not remove any inherited tag bindings, which must be | |
| // removed explicitly removed from the parent resource. |
| return ErrInvalidWorkspaceID | ||
| } | ||
|
|
||
| type aliasOpts struct { |
There was a problem hiding this comment.
No suggestions, just curious about the intent behind the name aliasOpts? What is "alias" referring to?
There was a problem hiding this comment.
I could have probably used a more descriptive name, but normally structs that "shadow" another -- for example to override struct tag definitions -- are referred to as aliases from what I've seen.
A more descriptive name would be aliasUpdateOptions, but given this wasn't part of the public interface I decided for brevity. An alternative declaration could look like:
opts := struct {
Type string `jsonapi:"primary,workspaces"`
TagBindings []*TagBinding `jsonapi:"relation,tag-bindings"`
} {
TagBindings: []*TagBinding{},
} Let me know if you would prefer this change
There was a problem hiding this comment.
It's ok, no changes needed from my end.
sebasslash
force-pushed
the
sebasslash/remove-tag-bindings
branch
from
9ccdce0 to
e1ea9cb
Compare
|
Reminder to the contributor that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes. |
Description
In order to remove tag bindings using the workspace or projects API you need to serialize an empty array of bindings (as a jsonapi relationship) and pass that to the PATCH endpoint for either target resource. The problem is the current update calls for either resource sets the tag bindings field to be
omitempty. So if you serialize an empty slice nothing will occur. This change adds a new method toProjectsandWorkspacescalledDeleteTagBindings()which purposefully serializes an empty slice and sends it over the wire.Testing plan
External links
Output from tests
Including output from tests may require access to a TFE instance. Ignore this section if you have no environment to test against.