1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-08-27 13:49:10 +02:00

feat: update schema

This commit is contained in:
Thomas Heartman 2023-11-20 14:29:04 +01:00
parent 4bb9737d07
commit a64f6fd4a5
No known key found for this signature in database
GPG Key ID: BD1F880DAED1EE78

View File

@ -4,7 +4,8 @@ export const segmentStrategiesSchema = {
$id: '#/components/schemas/segmentStrategiesSchema',
type: 'object',
required: ['strategies'],
description: 'A collection of strategies belonging to a specified segment.',
description:
'A collection of strategies using the specified segment, as well as any strategies using the segment in active change requests.',
properties: {
strategies: {
description: 'The list of strategies',
@ -50,6 +51,51 @@ export const segmentStrategiesSchema = {
},
},
},
changeRequestStrategies: {
description:
'A list of strategies using the segment in active change requests. If a strategy is already using the segment outside of any change requests, it will not be listed here.',
type: 'array',
items: {
type: 'object',
required: [
'featureName',
'projectId',
'environment',
'strategyName',
],
properties: {
id: {
type: 'string',
description:
'The ID of the strategy, if available. Strategies added in the change request will not have this property.',
example: 'e465c813-cffb-4232-b184-82b1d6fe9d3d',
},
featureName: {
type: 'string',
description:
'The name of the feature flag that this strategy belongs to.',
example: 'new-signup-flow',
},
projectId: {
type: 'string',
description:
'The ID of the project that the strategy belongs to.',
example: 'red-vista',
},
environment: {
type: 'string',
description:
'The ID of the environment that the strategy belongs to.',
example: 'development',
},
strategyName: {
type: 'string',
description: "The name of the strategy's type.",
example: 'flexibleRollout',
},
},
},
},
},
components: {},
} as const;