mirror of
https://github.com/Unleash/unleash.git
synced 2024-11-01 19:07:38 +01:00
38 lines
1.1 KiB
TypeScript
38 lines
1.1 KiB
TypeScript
|
import { FromSchema } from 'json-schema-to-ts';
|
||
|
|
import { constraintSchema } from './constraint-schema';
|
||
|
|
|
||
|
|
export const clientSegmentSchema = {
|
||
|
|
$id: '#/components/schemas/clientSegmentSchema',
|
||
|
|
type: 'object',
|
||
|
|
description:
|
||
|
|
'Represents a client API segment of users defined by a set of constraints.',
|
||
|
|
additionalProperties: false,
|
||
|
|
required: ['id', 'constraints'],
|
||
|
|
properties: {
|
||
|
|
id: {
|
||
|
|
type: 'number',
|
||
|
|
description: "The segment's id.",
|
||
|
|
},
|
||
|
|
name: {
|
||
|
|
type: 'string',
|
||
|
|
description: 'The name of the segment.',
|
||
|
|
example: 'segment A',
|
||
|
|
},
|
||
|
|
constraints: {
|
||
|
|
type: 'array',
|
||
|
|
description:
|
||
|
|
'List of constraints that determine which users are part of the segment',
|
||
|
|
items: {
|
||
|
|
$ref: '#/components/schemas/constraintSchema',
|
||
|
|
},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
components: {
|
||
|
|
schemas: {
|
||
|
|
constraintSchema,
|
||
|
|
},
|
||
|
|
},
|
||
|
|
} as const;
|
||
|
|
|
||
|
|
export type ClientSegmentSchema = FromSchema<typeof clientSegmentSchema>;
|