Update TSDoc for the hidden property

elastic · Nov 8, 2022 · ceacf51 · ceacf51
1 parent 5e07fda
commit ceacf51
Showing 1 changed file with 3 additions and 0 deletions.
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
@@ -26,6 +26,9 @@ export interface SavedObjectsType<Attributes = any> {
   /**
    * 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}.
    */