unleash.unleash/src/lib/openapi/spec/frontend-api-client-schema.ts

import type { FromSchema } from 'json-schema-to-ts';

export const frontendApiClientSchema = {
    $id: '#/components/schemas/frontendApiClientSchema',
    type: 'object',
    required: ['appName', 'interval', 'started', 'strategies'],
    description: 'Frontend SDK client registration information',
    properties: {
        appName: {
            type: 'string',
            description: 'Name of the application using Unleash',
        },
        instanceId: {
            type: 'string',
            description:
                'Instance id for this application (typically hostname, podId or similar)',
        },
        sdkVersion: {
            type: 'string',
            description:
                'Optional field that describes the sdk version (name:version)',
        },
        environment: {
            type: 'string',
            deprecated: true,
            description: 'deprecated',
            example: 'development',
        },
        interval: {
            type: 'number',
            description:
                'At which interval, in milliseconds, will this client be expected to send metrics',
        },
        started: {
            oneOf: [
                { type: 'string', format: 'date-time' },
                { type: 'number' },
            ],
            description:
                'When this client started. Should be reported as ISO8601 time.',
        },
        strategies: {
            type: 'array',
            items: {
                type: 'string',
            },
            description: 'List of strategies implemented by this application',
        },
    },
    components: {},
} as const;

export type FrontendApiClientSchema = FromSchema<
    typeof frontendApiClientSchema
>;