From a79b7d4e781bc5b4e6cfba79074fc39706a91a0a Mon Sep 17 00:00:00 2001 From: lcawl Date: Fri, 24 May 2024 10:04:08 -0700 Subject: [PATCH 1/2] [HTTP/OAS] Add descriptions for spaces APIs --- .../spaces/server/routes/api/external/copy_to_space.ts | 4 ++++ x-pack/plugins/spaces/server/routes/api/external/delete.ts | 4 ++++ .../server/routes/api/external/disable_legacy_url_aliases.ts | 4 ++++ x-pack/plugins/spaces/server/routes/api/external/get.ts | 4 ++++ x-pack/plugins/spaces/server/routes/api/external/get_all.ts | 4 ++++ .../server/routes/api/external/get_shareable_references.ts | 4 ++++ x-pack/plugins/spaces/server/routes/api/external/post.ts | 4 ++++ x-pack/plugins/spaces/server/routes/api/external/put.ts | 4 ++++ .../server/routes/api/external/update_objects_spaces.ts | 4 ++++ 9 files changed, 36 insertions(+) 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 e772ad389e8f92..f21e543b692633 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,8 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_copy_saved_objects', options: { tags: ['access:copySavedObjectsToSpaces'], + access: 'public', + description: `Copy saved objects to spaces`, }, validate: { body: schema.object( @@ -148,6 +150,8 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_resolve_copy_saved_objects_errors', options: { tags: ['access:copySavedObjectsToSpaces'], + access: 'public', + 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 63679f49847b7d..c39f872b86a005 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,10 @@ export function initDeleteSpacesApi(deps: ExternalRouteDeps) { router.delete( { path: '/api/spaces/space/{id}', + options: { + access: 'public', + 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 d708618f43870b..1d3e69ecff2441 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,10 @@ export function initDisableLegacyUrlAliasesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_disable_legacy_url_aliases', + options: { + access: 'public', + 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 ce89aac5fe1869..fd2107671f6655 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,10 @@ export function initGetSpaceApi(deps: ExternalRouteDeps) { router.get( { path: '/api/spaces/space/{id}', + options: { + access: 'public', + 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 c1dc24caf151e6..b7b8fc88b85c19 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,10 @@ export function initGetAllSpacesApi(deps: ExternalRouteDeps) { router.get( { path: '/api/spaces/space', + options: { + access: 'public', + 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 f9b18961fae59d..0889b53a8c9f6d 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,10 @@ export function initGetShareableReferencesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_get_shareable_references', + options: { + access: 'public', + 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 d8091a0140e001..ca2ee01ab8d7d6 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,10 @@ export function initPostSpacesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/space', + options: { + access: 'public', + description: `Create a space`, + }, validate: { body: spaceSchema, }, 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 753ec8e0289259..3668e19ca10ab0 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,10 @@ export function initPutSpacesApi(deps: ExternalRouteDeps) { router.put( { path: '/api/spaces/space/{id}', + options: { + access: 'public', + 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 5e610c9693ab53..16843ca84a1547 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,10 @@ export function initUpdateObjectsSpacesApi(deps: ExternalRouteDeps) { router.post( { path: '/api/spaces/_update_objects_spaces', + options: { + access: 'public', + description: `Update saved objects in spaces`, + }, validate: { body: schema.object({ objects: schema.arrayOf(schema.object({ type: schema.string(), id: schema.string() })), From d1d418a056dafb25f189399ced7c24231ed59223 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 3 Jun 2024 17:41:00 -0700 Subject: [PATCH 2/2] Remove access declarations --- .../plugins/spaces/server/routes/api/external/copy_to_space.ts | 2 -- x-pack/plugins/spaces/server/routes/api/external/delete.ts | 1 - .../server/routes/api/external/disable_legacy_url_aliases.ts | 1 - x-pack/plugins/spaces/server/routes/api/external/get.ts | 1 - x-pack/plugins/spaces/server/routes/api/external/get_all.ts | 1 - .../server/routes/api/external/get_shareable_references.ts | 1 - x-pack/plugins/spaces/server/routes/api/external/post.ts | 1 - x-pack/plugins/spaces/server/routes/api/external/put.ts | 1 - .../spaces/server/routes/api/external/update_objects_spaces.ts | 1 - 9 files changed, 10 deletions(-) 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 f21e543b692633..c237c86b0b91a9 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,7 +32,6 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_copy_saved_objects', options: { tags: ['access:copySavedObjectsToSpaces'], - access: 'public', description: `Copy saved objects to spaces`, }, validate: { @@ -150,7 +149,6 @@ export function initCopyToSpacesApi(deps: ExternalRouteDeps) { path: '/api/spaces/_resolve_copy_saved_objects_errors', options: { tags: ['access:copySavedObjectsToSpaces'], - access: 'public', description: `Resolve conflicts copying saved objects`, }, validate: { 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 c39f872b86a005..30a6f85d6994b0 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/delete.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/delete.ts @@ -21,7 +21,6 @@ export function initDeleteSpacesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/space/{id}', options: { - access: 'public', description: `Delete a space`, }, validate: { 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 1d3e69ecff2441..67bce1bfb742ad 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 @@ -19,7 +19,6 @@ export function initDisableLegacyUrlAliasesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/_disable_legacy_url_aliases', options: { - access: 'public', description: `Disable legacy URL aliases`, }, validate: { 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 fd2107671f6655..4a45f516c3001c 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/get.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/get.ts @@ -19,7 +19,6 @@ export function initGetSpaceApi(deps: ExternalRouteDeps) { { path: '/api/spaces/space/{id}', options: { - access: 'public', description: `Get a space`, }, validate: { 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 b7b8fc88b85c19..5b972f64918607 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 @@ -19,7 +19,6 @@ export function initGetAllSpacesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/space', options: { - access: 'public', description: `Get all spaces`, }, validate: { 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 0889b53a8c9f6d..687a51b28f9c85 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 @@ -18,7 +18,6 @@ export function initGetShareableReferencesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/_get_shareable_references', options: { - access: 'public', description: `Get shareable references`, }, validate: { 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 ca2ee01ab8d7d6..eb0a03ef77e137 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/post.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/post.ts @@ -21,7 +21,6 @@ export function initPostSpacesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/space', options: { - access: 'public', description: `Create a space`, }, validate: { 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 3668e19ca10ab0..ff7253f3461f9c 100644 --- a/x-pack/plugins/spaces/server/routes/api/external/put.ts +++ b/x-pack/plugins/spaces/server/routes/api/external/put.ts @@ -21,7 +21,6 @@ export function initPutSpacesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/space/{id}', options: { - access: 'public', description: `Update a space`, }, validate: { 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 16843ca84a1547..8222ceba0813ca 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 @@ -37,7 +37,6 @@ export function initUpdateObjectsSpacesApi(deps: ExternalRouteDeps) { { path: '/api/spaces/_update_objects_spaces', options: { - access: 'public', description: `Update saved objects in spaces`, }, validate: {