From ceacf51c7cbd433ca3ddf978cb7a9bd4e08ac6b2 Mon Sep 17 00:00:00 2001 From: Michael Dokolin Date: Tue, 8 Nov 2022 15:36:22 +0100 Subject: [PATCH] Update TSDoc for the hidden property --- .../core-saved-objects-server/src/saved_objects_type.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts b/packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts index b26be6f8bfb1a..e36212e7913f3 100644 --- a/packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts +++ b/packages/core/saved-objects/core-saved-objects-server/src/saved_objects_type.ts @@ -26,6 +26,9 @@ export interface SavedObjectsType { /** * Is the type hidden by default. If true, repositories will not have access to this type unless explicitly * declared as an `extraType` when creating the repository. + * It is recommended to hide the type for better backward compatibility. + * The hidden types will not be automatically exposed via the HTTP API. + * Therefore, that should prevent unexpected behavior in the client code, as all the interactions will be done via the plugin API. * * See {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}. */