kibana/packages/core/saved-objects/core-saved-objects-api-server
Jeramy Soucy 2cc12ceef5
[Saved Objects] Documents intended use of removeReferencesTo (#153711)
## Summary
Updates comments for `removeReferencesTo` (SO Repository) and
`authorizeRemoveReferences` (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](https://github.com/elastic/kibana/issues/135259#issuecomment-1482515139),
for background.
2023-03-28 09:31:02 -04:00
..
src [Saved Objects] Documents intended use of removeReferencesTo (#153711) 2023-03-28 09:31:02 -04:00
index.ts [Saved Objects] Remove deprecation notices from server SO types (#150839) 2023-02-15 17:13:27 +01:00
jest.config.js Create common and api types packages for the savedObjects domain (#136722) 2022-07-26 04:01:33 -07:00
kibana.jsonc Transpile packages on demand, validate all TS projects (#146212) 2022-12-22 19:00:29 -06:00
package.json Transpile packages on demand, validate all TS projects (#146212) 2022-12-22 19:00:29 -06:00
README.md Create common and api types packages for the savedObjects domain (#136722) 2022-07-26 04:01:33 -07:00
tsconfig.json [Saved Objects] Import SO types from server rather than common to avoid deprecation (#149289) 2023-01-25 05:38:05 -07:00

@kbn/core-saved-objects-api-server

This package contains the public types for core's server-side savedObjects client (and repository) APIs.