mirror of
https://github.com/Unleash/unleash.git
synced 2025-07-07 01:16:28 +02:00
26 lines
1.1 KiB
TypeScript
26 lines
1.1 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
|
|
/**
|
|
* Data required to create a new [environment](https://docs.getunleash.io/reference/environments)
|
|
*/
|
|
export interface CreateEnvironmentSchema {
|
|
/** Newly created environments are enabled by default. Set this property to `false` to create the environment in a disabled state. */
|
|
enabled?: boolean;
|
|
/** The name of the environment. Must be a URL-friendly string according to [RFC 3968, section 2.3](https://www.rfc-editor.org/rfc/rfc3986#section-2.3) */
|
|
name: string;
|
|
/** Defines where in the list of environments to place this environment. The list uses an ascending sort, so lower numbers are shown first. You can change this value later. */
|
|
sortOrder?: number;
|
|
/** The [type of environment](https://docs.getunleash.io/reference/environments#environment-types) you would like to create. Unleash officially recognizes the following values:
|
|
- `development`
|
|
- `test`
|
|
- `preproduction`
|
|
- `production`
|
|
|
|
If you pass a string that is not one of the recognized values, Unleash will accept it, but it will carry no special semantics. */
|
|
type: string;
|
|
}
|