[Saved Objects] Documents intended use of removeReferencesTo #153711
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates comments for
removeReferencesTo
(SO Repository) andauthorizeRemoveReferences
(SO Security Extension) methods with remarks regarding the intended use and authorization.Currently the only use case for
removeReferencesTo
is the delete method of the tags client. If the authorization check is changed to authorize an update for each referencing object, lingering references in objects which the user is not authorized to update may be left behind when a tag is deleted. We will leave the current implementation in place until a decision about if & how to manage referential integrity occurs.This PR documents the current intended use case for
removeReferencesTo
as: "to provide clean up of any references to an object which is being deleted (e.g. deleting a tag)."See issue #135259 and discussion here, for background.