[Saved Objects] Add documentation covering hidden saved object types (#144647)

This commit is contained in:
Michael Dokolin 2022-11-08 16:42:02 +01:00 committed by GitHub
parent e12371d884
commit 167797cae1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 43 additions and 6 deletions

View file

@ -18,7 +18,7 @@ import { SavedObjectsType } from 'src/core/server';
export const dashboardVisualization: SavedObjectsType = {
name: 'dashboard_visualization', [1]
hidden: false,
hidden: true,
namespaceType: 'multiple-isolated', [2]
mappings: {
dynamic: false,
@ -38,8 +38,8 @@ export const dashboardVisualization: SavedObjectsType = {
};
```
[1] Since the name of a Saved Object type forms part of the url path for the public Saved Objects HTTP API,
these should follow our API URL path convention and always be written as snake case.
[1] Since the name of a Saved Object type forms part of the URL path for the public Saved Objects HTTP API,
these should follow our API URL path convention and always be written in snake case.
[2] This field determines "space behavior" -- whether these objects can exist in one space, multiple spaces, or all spaces. This value means
that objects of this type can only exist in a single space. See