@unleash/proxy/src/openapi/spec/register-client-schema.ts

The Unleash Proxy (Open-Source)

import { type CreateSchemaType, createSchemaObject } from '../openapi-types';

export const schema = {
    type: 'object',
    required: ['appName', 'interval', 'started', 'strategies'],
    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,
        },
        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',
        },
    },
} as const;

export type RegisterClientSchema = CreateSchemaType<typeof schema>;

export const registerClientSchema = createSchemaObject(schema);