import { FromSchema } from 'json-schema-to-ts'; import { featureSchema } from './feature-schema'; import { featureStrategySchema } from './feature-strategy-schema'; import { featureEnvironmentSchema } from './feature-environment-schema'; import { contextFieldSchema } from './context-field-schema'; import { featureTagSchema } from './feature-tag-schema'; import { parametersSchema } from './parameters-schema'; import { legalValueSchema } from './legal-value-schema'; import { variantSchema } from './variant-schema'; import { overrideSchema } from './override-schema'; import { variantsSchema } from './variants-schema'; import { constraintSchema } from './constraint-schema'; import { tagTypeSchema } from './tag-type-schema'; import { strategyVariantSchema } from './strategy-variant-schema'; export const exportResultSchema = { $id: '#/components/schemas/exportResultSchema', type: 'object', additionalProperties: false, description: 'The result of the export operation, providing you with the feature toggle definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)', required: ['features', 'featureStrategies', 'tagTypes'], properties: { features: { type: 'array', description: 'All the exported features.', example: [ { name: 'my-feature', description: 'best feature ever', type: 'release', project: 'default', stale: false, impressionData: false, archived: false, }, ], items: { $ref: '#/components/schemas/featureSchema', }, }, featureStrategies: { type: 'array', description: 'All strategy instances that are used by the exported features in the `features` list.', example: [ { name: 'flexibleRollout', id: '924974d7-8003-43ee-87eb-c5f887c06fd1', featureName: 'my-feature', title: 'Rollout 50%', parameters: { groupId: 'default', rollout: '50', stickiness: 'random', }, constraints: [], disabled: false, segments: [1], }, ], items: { $ref: '#/components/schemas/featureStrategySchema', }, }, featureEnvironments: { type: 'array', description: 'Environment-specific configuration for all the features in the `features` list. Includes data such as whether the feature is enabled in the selected export environment, whether there are any variants assigned, etc.', example: [ { enabled: true, featureName: 'my-feature', environment: 'development', variants: [ { name: 'a', weight: 500, overrides: [], stickiness: 'random', weightType: 'variable', }, { name: 'b', weight: 500, overrides: [], stickiness: 'random', weightType: 'variable', }, ], name: 'variant-testing', }, ], items: { $ref: '#/components/schemas/featureEnvironmentSchema', }, }, contextFields: { type: 'array', description: 'A list of all the context fields that are in use by any of the strategies in the `featureStrategies` list.', example: [ { name: 'appName', description: 'Allows you to constrain on application name', stickiness: false, sortOrder: 2, legalValues: [], }, ], items: { $ref: '#/components/schemas/contextFieldSchema', }, }, featureTags: { type: 'array', description: 'A list of all the tags that have been applied to any of the features in the `features` list.', example: [ { featureName: 'my-feature', tagType: 'simple', tagValue: 'user-facing', }, ], items: { $ref: '#/components/schemas/featureTagSchema', }, }, segments: { type: 'array', description: 'A list of all the segments that are used by the strategies in the `featureStrategies` list.', example: [ { id: 1, name: 'new-segment-name', }, ], items: { type: 'object', additionalProperties: false, required: ['id'], properties: { id: { type: 'number', }, name: { type: 'string', }, }, }, }, tagTypes: { type: 'array', description: 'A list of all of the tag types that are used in the `featureTags` list.', example: [ { name: 'simple', description: 'Used to simplify filtering of features', icon: '#', }, ], items: { $ref: '#/components/schemas/tagTypeSchema', }, }, }, components: { schemas: { featureSchema, featureStrategySchema, strategyVariantSchema, featureEnvironmentSchema, contextFieldSchema, featureTagSchema, variantsSchema, variantSchema, overrideSchema, constraintSchema, parametersSchema, legalValueSchema, tagTypeSchema, }, }, } as const; export type ExportResultSchema = FromSchema;