Changes deprecated SO HTTP APIs deprecation field to object (elastic#…

…197936) fix elastic#197721. The route deprecation field changed from a boolean to an object, where the object contains information that is used in deprecation issues that the Upgrade Assistant shows. This PR makes the necessary changes in the deprecated Saved Objects HTTP APIs. This PR also includes a release notes entry for the API deprecations that was missing. ![Screenshot 2024-10-29 at 12 01 29](https://github.com/user-attachments/assets/5c47c697-fbae-4b2e-8c6c-cd4701a667df) ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios ### How to test this: - Pull PR, run es against a trial license and start kibana as usual. - Make a curl request to Kibana to get the config saved object: ``` curl --location 'localhost:5601/abc/api/saved_objects/config/9.0.0' \ --header 'Content-Type: application/json' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'kbn-xsrf: kibana' \ --header 'Kbn-Version: 9.0.0' \ --header 'Authorization: Basic ZWxhc3RpYzpjaGFuZ2VtZQ==' ``` - Navigate to Upgrade Assistant and observe Kibana has at least 1 deprecation warning. - View Kibana's warnings, you should see a warning entry for `The "GET /api/saved_objects/{type}/{id}" route is deprecated` ![Screenshot 2024-11-06 at 16 26 26](https://github.com/user-attachments/assets/3b6a5644-3e5e-403e-a0f6-015686675b9f) - click on the deprecation and you should see more detail about the deprecated API that's been used in the flyout: ![Screenshot 2024-11-06 at 16 26 44](https://github.com/user-attachments/assets/696aaf8f-fb6b-4c61-bc3c-b3745f85059a) - resolve the deprecation warning - Kibana should continue to issue requests to the deprecated SO HTTP APIs because these APIs have not been removed yet. ### Risk Matrix | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | End user concern from the deprecation warning that says the routes have been deprecated | Low | Low | The APIs have been deprecated since 8.7 and recommends using public APIs instead. | ### For maintainers - [x] This will appear in the **Release Notes** and follow the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]>
jloleysens · Nov 7, 2024 · 0df2e98 · 0df2e98
1 parent 207894e
commit 0df2e98
Show file tree

Hide file tree

Showing 56 changed files with 610 additions and 120 deletions.
diff --git a/docs/upgrade-notes.asciidoc b/docs/upgrade-notes.asciidoc
@@ -1432,6 +1432,35 @@ The `/agent_status` Fleet API now returns the following statuses:
 * `active` &mdash; All active
 ====
 
+[discrete]
+[[kibana-150267]]
+.Deprecated Saved objects APIs. (8.7)
+[%collapsible]
+====
+*Details* +
+The following saved objects APIs have been deprecated.
+
+[source,text]
+--
+/api/saved_objects/{type}/{id}
+/api/saved_objects/resolve/{type}/{id}
+/api/saved_objects/{type}/{id?}
+/api/saved_objects/{type}/{id}
+/api/saved_objects/_find
+/api/saved_objects/{type}/{id}
+/api/saved_objects/_bulk_get
+/api/saved_objects/_bulk_create
+/api/saved_objects/_bulk_resolve
+/api/saved_objects/_bulk_update
+/api/saved_objects/_bulk_delete
+--
+
+For more information, refer to ({kibana-pull}150267[#150267]).
+
+*Impact* +
+Use dedicated public APIs instead, for example use <<data-views-api>> to manage Data Views.
+====
+
 [discrete]
 [[deprecation-119494]]
 .Updates Fleet API to improve consistency. (8.0)

diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -50524,7 +50524,7 @@ tags:
     name: ml
   - name: roles
   - description: >
-      Export sets of saved objects that you want to import into {kib}, resolve
+      Export sets of saved objects that you want to import into Kibana, resolve
       import errors, and rotate an encryption key for encrypted saved objects
       with the saved objects APIs.
 

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -37229,7 +37229,7 @@ paths:
           description: >
             Indicates a successful call. NOTE: This HTTP response code indicates
             that the bulk operation succeeded.  Errors pertaining to individual
-            objects will be returned in the response body. 
+            objects will be returned in the response body.
         '400':
           content:
             application/json; Elastic-Api-Version=2023-10-31:
@@ -37263,7 +37263,7 @@ paths:
           description: >
             Indicates a successful call. NOTE: This HTTP response code indicates
             that the bulk operation succeeded. Errors pertaining to individual
-            objects will be returned in the response body. 
+            objects will be returned in the response body.
         '400':
           content:
             application/json; Elastic-Api-Version=2023-10-31:
@@ -58900,7 +58900,7 @@ tags:
     name: ml
   - name: roles
   - description: >
-      Export sets of saved objects that you want to import into {kib}, resolve
+      Export sets of saved objects that you want to import into Kibana, resolve
       import errors, and rotate an encryption key for encrypted saved objects
       with the saved objects APIs.
 

diff --git a/...core/deprecations/core-deprecations-server-internal/src/routes/post_validation_handler.ts b/...core/deprecations/core-deprecations-server-internal/src/routes/post_validation_handler.ts
@@ -11,7 +11,7 @@ import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-server-int
 import type { CoreKibanaRequest } from '@kbn/core-http-router-server-internal';
 import type { InternalHttpServiceSetup } from '@kbn/core-http-server-internal';
 import { isObject } from 'lodash';
-import { RouteDeprecationInfo } from '@kbn/core-http-server/src/router/route';
+import { RouteDeprecationInfo } from '@kbn/core-http-server/src/router/route'; // shouldn't use deep imports
 import { buildApiDeprecationId } from '../deprecations';
 
 interface Dependencies {

diff --git a/packages/core/http/core-http-server/index.ts b/packages/core/http/core-http-server/index.ts
@@ -120,6 +120,7 @@ export type {
   RouteSecurity,
   RouteSecurityGetter,
   InternalRouteSecurity,
+  RouteDeprecationInfo,
 } from './src/router';
 export {
   validBodyOutput,

diff --git a/packages/core/http/core-http-server/src/router/index.ts b/packages/core/http/core-http-server/src/router/index.ts
@@ -64,6 +64,7 @@ export type {
   RouteSecurity,
   Privilege,
   PrivilegeSet,
+  RouteDeprecationInfo,
 } from './route';
 
 export { validBodyOutput, ReservedPrivilegesSet } from './route';

diff --git a/packages/core/root/core-root-server-internal/src/server.ts b/packages/core/root/core-root-server-internal/src/server.ts
@@ -309,6 +309,7 @@ export class Server {
       elasticsearch: elasticsearchServiceSetup,
       deprecations: deprecationsSetup,
       coreUsageData: coreUsageDataSetup,
+      docLinks: docLinksSetup,
     });
 
     const uiSettingsSetup = await this.uiSettings.setup({

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_create.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_create.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerBulkCreateRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.post(
@@ -38,8 +39,7 @@ export const registerBulkCreateRoute = (
         summary: `Create saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         query: schema.object({

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_delete.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_delete.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerBulkDeleteRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.post(
@@ -38,8 +39,7 @@ export const registerBulkDeleteRoute = (
         summary: `Delete saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         body: schema.arrayOf(

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_get.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_get.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerBulkGetRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.post(
@@ -38,8 +39,7 @@ export const registerBulkGetRoute = (
         summary: `Get saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         body: schema.arrayOf(

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_resolve.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_resolve.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerBulkResolveRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.post(
@@ -38,8 +39,7 @@ export const registerBulkResolveRoute = (
         summary: `Resolve saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
         description: `Retrieve multiple Kibana saved objects by ID, using any legacy URL aliases if they exist.
         Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved with the bulk resolve API using either its new ID or its old ID.`,
       },

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_update.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/bulk_update.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerBulkUpdateRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.put(
@@ -38,8 +39,7 @@ export const registerBulkUpdateRoute = (
         summary: `Update saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         body: schema.arrayOf(

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/create.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/create.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerCreateRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.post(
@@ -38,8 +39,7 @@ export const registerCreateRoute = (
         summary: `Create a saved object`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         params: schema.object({

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/delete.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/delete.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -24,11 +24,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerDeleteRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const { allowHttpApiAccess } = config;
   router.delete(
@@ -38,8 +39,7 @@ export const registerDeleteRoute = (
         summary: `Delete a saved object`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         params: schema.object({

diff --git a/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/find.ts b/packages/core/saved-objects/core-saved-objects-server-internal/src/routes/find.ts
@@ -8,7 +8,7 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import type { RouteAccess } from '@kbn/core-http-server';
+import type { RouteAccess, RouteDeprecationInfo } from '@kbn/core-http-server';
 import { SavedObjectConfig } from '@kbn/core-saved-objects-base-server-internal';
 import type { InternalCoreUsageDataSetup } from '@kbn/core-usage-data-base-server-internal';
 import type { Logger } from '@kbn/logging';
@@ -21,11 +21,12 @@ interface RouteDependencies {
   coreUsageData: InternalCoreUsageDataSetup;
   logger: Logger;
   access: RouteAccess;
+  deprecationInfo: RouteDeprecationInfo;
 }
 
 export const registerFindRoute = (
   router: InternalSavedObjectRouter,
-  { config, coreUsageData, logger, access }: RouteDependencies
+  { config, coreUsageData, logger, access, deprecationInfo }: RouteDependencies
 ) => {
   const referenceSchema = schema.object({
     type: schema.string(),
@@ -42,8 +43,7 @@ export const registerFindRoute = (
         summary: `Search for saved objects`,
         tags: ['oas-tag:saved objects'],
         access,
-        // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}
-        deprecated: true,
+        deprecated: deprecationInfo,
       },
       validate: {
         query: schema.object({