Surface Kibana security route deprecations in Upgrade Assistant #199656
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ | |
|
|
||
| import type { TypeOf } from '@kbn/config-schema'; | ||
| import { schema } from '@kbn/config-schema'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import { parseNextURL } from '@kbn/std'; | ||
|
|
||
| import type { RouteDefinitionParams } from '..'; | ||
|
|
@@ -40,6 +41,7 @@ export function defineCommonRoutes({ | |
| '/api/security/logout', | ||
| ...(buildFlavor !== 'serverless' ? ['/api/security/v1/logout'] : []), | ||
| ]) { | ||
| const isDeprecated = path === '/api/security/v1/logout'; | ||
| router.get( | ||
| { | ||
| path, | ||
|
|
@@ -57,11 +59,27 @@ export function defineCommonRoutes({ | |
| excludeFromOAS: true, | ||
| authRequired: false, | ||
| tags: [ROUTE_TAG_CAN_REDIRECT, ROUTE_TAG_AUTH_FLOW], | ||
| ...(isDeprecated && { | ||
| deprecated: { | ||
| documentationUrl: 'https://elastic.co', // ToDo: Update with docLink to upgrade note | ||
|
There was a problem hiding this comment. With the PR known and the release note added, I think we can go ahead and populate this following the template's instructions about doc links. Ditto for other instances! There was a problem hiding this comment. @jloleysens Done in 97153f1 |
||
| severity: 'warning', | ||
| message: i18n.translate('xpack.security.deprecations.logoutRouteMessage', { | ||
| defaultMessage: | ||
| 'The "{path}" URL is deprecated and will be removed in the next major version, please use "/api/security/logout" instead.', | ||
jeramysoucy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| values: { path }, | ||
| }), | ||
| reason: { | ||
| type: 'migrate', | ||
| newApiMethod: 'GET', | ||
| newApiPath: '/api/security/logout', | ||
| }, | ||
| }, | ||
| }), | ||
| }, | ||
| }, | ||
| async (context, request, response) => { | ||
| const serverBasePath = basePath.serverBasePath; | ||
| if (isDeprecated) { | ||
| logger.warn( | ||
| `The "${serverBasePath}${path}" URL is deprecated and will stop working in the next major version, please use "${serverBasePath}/api/security/logout" URL instead.`, | ||
| { tags: ['deprecation'] } | ||
|
|
@@ -96,7 +114,7 @@ export function defineCommonRoutes({ | |
| '/internal/security/me', | ||
| ...(buildFlavor !== 'serverless' ? ['/api/security/v1/me'] : []), | ||
| ]) { | ||
| const isDeprecated = path === '/api/security/v1/me'; | ||
| router.get( | ||
| { | ||
| path, | ||
|
|
@@ -107,10 +125,24 @@ export function defineCommonRoutes({ | |
| }, | ||
| }, | ||
| validate: false, | ||
| options: { | ||
| access: isDeprecated ? 'public' : 'internal', | ||
| ...(isDeprecated && { | ||
| deprecated: { | ||
| documentationUrl: 'https://elastic.co', // ToDo: Update with docLink to upgrade note | ||
| severity: 'warning', | ||
| message: i18n.translate('xpack.security.deprecations.meRouteMessage', { | ||
| defaultMessage: | ||
| 'The "{path}" endpoint is deprecated and will be removed in the next major version.', | ||
| values: { path }, | ||
| }), | ||
| reason: { type: 'remove' }, | ||
| }, | ||
| }), | ||
| }, | ||
| }, | ||
| createLicensedRouteHandler(async (context, request, response) => { | ||
| if (isDeprecated) { | ||
| logger.warn( | ||
| `The "${basePath.serverBasePath}${path}" endpoint is deprecated and will be removed in the next major version.`, | ||
| { tags: ['deprecation'] } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opted to remove this section as it seemed redundant with the new section. Plus it was only applicable to 8.0.0-alpha1.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After #199519
mainwill only contain 9.0+ changes for this file