Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-09 00:18:00 +01:00
Code Issues Projects Releases Wiki Activity

chore: mark deprecations with version (#7218)

Browse Source 
Makes some deprecation messages in open API clearer around which version
they were deprecated in so that they can be removed in v7
This commit is contained in:
Simon Hornby 2024-05-30 13:49:39 +02:00 committed by GitHub
parent c932d2a02b
commit d6dc2b4ce2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/openapi/spec/client-application-schema.ts
View File

@ -25,7 +25,7 @@ export const clientApplicationSchema = {
example: 'unleash-client-java:7.0.0',
},
environment: {
description: `The SDK's configured 'environment' property. Deprecated. This property does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.`,
description: `The SDK's configured 'environment' property. This property was deprecated in v5. This property does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.`,
deprecated: true,
type: 'string',
example: 'development',

4
src/lib/openapi/spec/client-features-query-schema.ts
View File

@ -23,7 +23,7 @@ export const clientFeaturesQuerySchema = {
type: 'string',
},
description:
'Features that are part of these projects are included in this response. (DEPRECATED) - Handled by API tokens',
'Features that are part of these projects are included in this response. This is now handled by API tokens and was marked as deprecated in v5',
example: ['new.payment.flow'],
deprecated: true,
},
@ -36,7 +36,7 @@ export const clientFeaturesQuerySchema = {
environment: {
type: 'string',
description:
'Strategies for the feature flag configured for this environment are included. (DEPRECATED) - Handled by API tokens',
'Strategies for the feature flag configured for this environment are included. This is now handled by API tokens and was marked as deprecated in v5',
deprecated: true,
},
inlineSegmentConstraints: {

2
src/lib/openapi/spec/create-api-token-schema.ts
View File

@ -33,7 +33,7 @@ const usernameSchema = {
deprecated: true,
type: 'string',
description:
'The name of the token. This property is deprecated. Use `tokenName` instead.',
'The name of the token. This property was deprecated in v5. Use `tokenName` instead.',
example: 'token-64523',
},
},

5
src/lib/openapi/spec/feature-schema.ts
View File

@ -87,7 +87,7 @@ export const featureSchema = {
deprecated: true,
example: '2023-01-28T16:21:39.975Z',
description:
'The date when metrics where last collected for the feature. This field is deprecated, use the one in featureEnvironmentSchema',
'The date when metrics where last collected for the feature. This field was deprecated in v5, use the one in featureEnvironmentSchema',
},
environments: {
type: 'array',
@ -110,7 +110,8 @@ export const featureSchema = {
items: {
type: 'object',
},
description: 'This is a legacy field that will be deprecated',
description:
'This was deprecated in v5 and will be removed in a future major version',
deprecated: true,
},
tags: {

7
src/lib/openapi/spec/feature-search-response-schema.ts
View File

@ -101,7 +101,7 @@ export const featureSearchResponseSchema = {
deprecated: true,
example: '2023-01-28T16:21:39.975Z',
description:
'The date when metrics where last collected for the feature. This field is deprecated, use the one in featureEnvironmentSchema',
'The date when metrics where last collected for the feature. This field was deprecated in v5 and will be removed in a future release, use the one in featureEnvironmentSchema',
},
environments: {
type: 'array',
@ -124,7 +124,8 @@ export const featureSearchResponseSchema = {
items: {
$ref: '#/components/schemas/variantSchema',
},
description: 'The list of feature variants',
description:
'The list of feature variants. This field was deprecated in v5',
deprecated: true,
},
strategies: {
@ -132,7 +133,7 @@ export const featureSearchResponseSchema = {
items: {
type: 'object',
},
description: 'This is a legacy field that will be deprecated',
description: 'This is a legacy field that was deprecated in v5',
deprecated: true,
},
tags: {

2
src/lib/openapi/spec/user-schema.ts
View File

@ -15,7 +15,7 @@ export const userSchema = {
},
isAPI: {
description:
'(Deprecated): Used internally to know which operations the user should be allowed to perform',
'Deprecated in v5. Used internally to know which operations the user should be allowed to perform',
type: 'boolean',
example: true,
deprecated: true,