[Defend Workflows] Set deprecated flag to true in router for deprecated endpoint API's

[dasansol92]

Summary

Set deprecated: true flag to endpoint api routes.
These routes are already marked as deprecated in api docs:

• /api/endpoint/policy/summaries:

  • ESS: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L475-L500
  • Serverless: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L425-L450
  • OpenAPI docs: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/common/api/endpoint/policy/deprecated_agent_policy_summary.schema.yaml

• /api/endpoint/action_log/{agent_id}

  • ESS: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L34-L59
  • Serverless: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L34-L59
  • OpenApi docs: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/common/api/endpoint/actions/action_log/deprecated_action_log.schema.yaml

• /api/endpoint/isolate

  • ESS: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L351-L400
  • Serverless: Not present
  • OpenApi docs: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/common/api/endpoint/actions/response_actions/isolate/deprecated_isolate.schema.yaml

• /api/endpoint/unisolate

  • ESS: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml#L584-L633
  • Serverless: Not present
  • OpenApi docs: https://github.com/elastic/kibana/blob/main/x-pack/plugins/security_solution/common/api/endpoint/actions/response_actions/unisolate/deprecated_unisolate.schema.yaml

[elasticmachine]

Pinging @elastic/security-defend-workflows (Team:Defend Workflows)

[szwarckonrad]

Thanks for addressing this!

[TinaHeiligers]

@dasansol92 If these APIs going to be removed in v9.0.0 and you want the Upgrade Assistant to show critical notices for them, please be aware of these pending changes to deprecation .

The tracking issue for APIs that need changes is API Deprecations replace deprecated: true with the deprecated object

[dasansol92]

@elasticmachine merge upstream

[elasticmachine]

💔 Build Failed

• Buildkite Build
• Commit: e6d8d72

Failed CI Steps

• Check Types

Metrics [docs]

✅ unchanged

History

[TinaHeiligers]

deprecated needs to be an object within the version declaration.
You'll need to update the doc links and double check on the deprecation objects w.r.t correct replacement path and severity levels.

[TinaHeiligers]

deprecated needs to be declared on .addVersion because the endpoint is being removed completely and needs to be surfaced in the Upgrade Assistant.

**
 * Registers the endpoint activity_log route
 * @deprecated
 * @removeBy 9.0.0
 *
 */
export function registerActionAuditLogRoutes(
  router: SecuritySolutionPluginRouter,
  endpointContext: EndpointAppContext
) {
  router.versioned
    .get({
      access: 'public',
      path: ENDPOINT_ACTION_LOG_ROUTE,
      options: { authRequired: true, tags: ['access:securitySolution'] },
    })
    .addVersion(
      {
        version: '2023-10-31',
        options: {
          deprecated: {
            documentationUrl: 'https://elastic.co', // add a link to your docs about the change
            severity: 'critical',
            reason: {
              type: 'remove',
            },
          },
        },
        validate: {
          request: EndpointActionLogRequestSchema,
        },
      },
      withEndpointAuthz(
        { all: ['canIsolateHost'] },
        endpointContext.logFactory.get('hostIsolationLogs'),
        auditLogRequestHandler(endpointContext)
      )
    );
}

[TinaHeiligers]

Move deprecated into .addVersion:

  /**
   * @deprecated use ISOLATE_HOST_ROUTE_V2 instead
   */
  router.versioned
    .post({
      access: 'public',
      path: ISOLATE_HOST_ROUTE,
      options: { authRequired: true, tags: ['access:securitySolution'] },
    })
    .addVersion(
      {
        version: '2023-10-31',
        options: {
          deprecated: {
            documentationUrl: 'https://elastic.co',
            severity: 'critical',
            reason: {
              type: 'migrate',
              newApiPath: `${ISOLATE_HOST_ROUTE_V2}`,
              newApiMethod: 'post',
            },
          },
        },
        validate: {
          request: IsolateRouteRequestSchema,
        },
      },
      withEndpointAuthz({ all: ['canIsolateHost'] }, logger, redirectHandler(ISOLATE_HOST_ROUTE_V2))
    );

  /**
   * @deprecated use RELEASE_HOST_ROUTE instead
   */
  router.versioned
    .post({
      access: 'public',
      path: UNISOLATE_HOST_ROUTE,
      options: { authRequired: true, tags: ['access:securitySolution'] },
    })
    .addVersion(
      {
        version: '2023-10-31',
        options: {
          deprecated: {
            documentationUrl: 'https://elastic.co',
            severity: 'critical',
            reason: {
              type: 'migrate',
              newApiPath: `${ISOLATE_HOST_ROUTE_V2}`
              newApiMethod: 'post',
            },
          },
        },
        validate: {
          request: UnisolateRouteRequestSchema,
        },
      },
      withEndpointAuthz(
        { all: ['canUnIsolateHost'] },
        logger,
        redirectHandler(UNISOLATE_HOST_ROUTE_V2)
      )
    );

Note: RELEASE_HOST_ROUTE doesn't exist. The doc comment should probably be " use UNISOLATE_HOST_ROUTE_v2"

[TinaHeiligers]

Move to .addVersion:

  /**
   * @deprecated
   * @removeBy 9.0.0
   *
   */
  router.versioned
    .get({
      access: 'public',
      path: AGENT_POLICY_SUMMARY_ROUTE,
      options: { authRequired: true },
    })
    .addVersion(
      {
        version: '2023-10-31',
        options: {
          deprecated: {
            documentationUrl: 'https://elastic.co', // link to docs explaining the removal
            severity: 'critical',
            reason: {
              type: 'remove',
            },
          },
        },
        validate: {
          request: GetAgentPolicySummaryRequestSchema,
        },
      },
      withEndpointAuthz(
        { all: ['canAccessEndpointManagement'] },
        logger,
        getAgentPolicySummaryHandler(endpointAppContext)
      )
    );

[TinaHeiligers]

deprecated only needs to be changed to an object for merging to 8.x and main.

[TinaHeiligers]

route options deprecated needs to be an object or expect a linting error: // @ts-expect-error TODO(https://github.com/elastic/kibana/issues/196095): Replace {RouteDeprecationInfo}

[dasansol92]

Closing this pr since we will handle those changes in a follow up