unleash.unleash/src/lib/openapi/spec/environment-schema.ts

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

export const environmentSchema = {
    $id: '#/components/schemas/environmentSchema',
    type: 'object',
    additionalProperties: false,
    required: ['name', 'type', 'enabled', 'protected', 'sortOrder'],
    description: 'A definition of the project environment',
    properties: {
        name: {
            type: 'string',
            example: 'my-dev-env',
            description: 'The name of the environment',
        },
        type: {
            type: 'string',
            example: 'development',
            description:
                'The [type of environment](https://docs.getunleash.io/reference/environments#environment-types).',
        },
        enabled: {
            type: 'boolean',
            example: true,
            description:
                '`true` if the environment is enabled for the project, otherwise `false`.',
        },
        protected: {
            type: 'boolean',
            example: true,
            description:
                '`true` if the environment is protected, otherwise `false`. A *protected* environment can not be deleted.',
        },
        sortOrder: {
            type: 'integer',
            example: 3,
            description:
                'Priority of the environment in a list of environments, the lower the value, the higher up in the list the environment will appear. Needs to be an integer',
        },
        projectCount: {
            type: 'integer',
            nullable: true,
            minimum: 0,
            example: 10,
            description: 'The number of projects with this environment',
        },
        apiTokenCount: {
            type: 'integer',
            nullable: true,
            minimum: 0,
            example: 6,
            description: 'The number of API tokens for the project environment',
        },
        enabledToggleCount: {
            type: 'integer',
            nullable: true,
            minimum: 0,
            example: 10,
            description:
                'The number of enabled toggles for the project environment',
        },
    },
    components: {},
} as const;

export type EnvironmentSchema = FromSchema<typeof environmentSchema>;