diff --git a/x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts b/x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts index e772ad389e8f9..c237c86b0b91a 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts @@ -32,6 +32,7 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_copy_saved_objects', options: { tags: ['access:copySavedObjectsToSpaces'], + description: `Copy saved objects to spaces`, }, validate: { body: schema.object( @@ -148,6 +149,7 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_resolve_copy_saved_objects_errors', options: { tags: ['access:copySavedObjectsToSpaces'], + description: `Resolve conflicts copying saved objects`, }, validate: { body: schema.object( diff --git a/x-pack/plugins/spaces/server/routes/api/external/delete.ts b/x-pack/plugins/spaces/server/routes/api/external/delete.ts index 63679f49847b7..30a6f85d6994b 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/delete.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/delete.ts @@ -20,6 +20,9 @@ export function initDeleteSpacesApi(deps: ExternalRouteDeps) { router.delete( { path: '/api/spaces/space/{id}', + options: { + description: `Delete a space`, + }, validate: { params: schema.object({ id: schema.string(), diff --git a/x-pack/plugins/spaces/server/routes/api/external/disable_legacy_url_aliases.ts b/x-pack/plugins/spaces/server/routes/api/external/disable_legacy_url_aliases.ts index d708618f43870..67bce1bfb742a 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/disable_legacy_url_aliases.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/disable_legacy_url_aliases.ts @@ -18,6 +18,9 @@ export function initDisableLegacyUrlAliasesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_disable_legacy_url_aliases', + options: { + description: `Disable legacy URL aliases`, + }, validate: { body: schema.object({ aliases: schema.arrayOf( diff --git a/x-pack/plugins/spaces/server/routes/api/external/get.ts b/x-pack/plugins/spaces/server/routes/api/external/get.ts index 496c3408b7d2e..99bc646994b5c 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/get.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/get.ts @@ -18,6 +18,9 @@ export function initGetSpaceApi(deps: ExternalRouteDeps) { router.get( { path: '/api/spaces/space/{id}', + options: { + description: `Get a space`, + }, validate: { params: schema.object({ id: schema.string(), diff --git a/x-pack/plugins/spaces/server/routes/api/external/get_all.ts b/x-pack/plugins/spaces/server/routes/api/external/get_all.ts index c1dc24caf151e..5b972f6491860 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/get_all.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/get_all.ts @@ -18,6 +18,9 @@ export function initGetAllSpacesApi(deps: ExternalRouteDeps) { router.get( { path: '/api/spaces/space', + options: { + description: `Get all spaces`, + }, validate: { query: schema.object({ purpose: schema.maybe( diff --git a/x-pack/plugins/spaces/server/routes/api/external/get_shareable_references.ts b/x-pack/plugins/spaces/server/routes/api/external/get_shareable_references.ts index f9b18961fae59..687a51b28f9c8 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/get_shareable_references.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/get_shareable_references.ts @@ -17,6 +17,9 @@ export function initGetShareableReferencesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_get_shareable_references', + options: { + description: `Get shareable references`, + }, validate: { body: schema.object({ objects: schema.arrayOf(schema.object({ type: schema.string(), id: schema.string() })), diff --git a/x-pack/plugins/spaces/server/routes/api/external/post.ts b/x-pack/plugins/spaces/server/routes/api/external/post.ts index 34a9c7f854dad..31dda1285f06a 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/post.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/post.ts @@ -20,6 +20,9 @@ export function initPostSpacesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/space', + options: { + description: `Create a space`, + }, validate: { body: getSpaceSchema(isServerless), }, diff --git a/x-pack/plugins/spaces/server/routes/api/external/put.ts b/x-pack/plugins/spaces/server/routes/api/external/put.ts index 7d0c255392ee4..e1defabee7103 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/put.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/put.ts @@ -20,6 +20,9 @@ export function initPutSpacesApi(deps: ExternalRouteDeps) { router.put( { path: '/api/spaces/space/{id}', + options: { + description: `Update a space`, + }, validate: { params: schema.object({ id: schema.string(), diff --git a/x-pack/plugins/spaces/server/routes/api/external/update_objects_spaces.ts b/x-pack/plugins/spaces/server/routes/api/external/update_objects_spaces.ts index 5e610c9693ab5..8222ceba0813c 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/update_objects_spaces.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/update_objects_spaces.ts @@ -36,6 +36,9 @@ export function initUpdateObjectsSpacesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_update_objects_spaces', + options: { + description: `Update saved objects in spaces`, + }, validate: { body: schema.object({ objects: schema.arrayOf(schema.object({ type: schema.string(), id: schema.string() })),