mirror of
https://github.com/Unleash/unleash.git
synced 2025-10-27 11:02:16 +01:00
abe160eb7d
We're migrating to ESM, which will allow us to import the latest versions of our dependencies. Co-Authored-By: Christopher Kolstad <chriswk@getunleash.io>
35 lines
1.3 KiB
TypeScript
35 lines
1.3 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
import type { AddonSchemaParameters } from './addonSchemaParameters.js';
|
|
|
|
/**
|
|
* An [addon](https://docs.getunleash.io/reference/addons) instance description. Contains data about what kind of provider it uses, whether it's enabled or not, what events it listens for, and more.
|
|
*/
|
|
export interface AddonSchema {
|
|
/**
|
|
* A description of the addon. `null` if no description exists.
|
|
* @nullable
|
|
*/
|
|
description: string | null;
|
|
/** Whether the addon is enabled or not. */
|
|
enabled: boolean;
|
|
/** The list of environments that this addon listens to events from. An empty list means it listens to events from **all** environments. */
|
|
environments?: string[];
|
|
/** The event types that trigger this specific addon. */
|
|
events: string[];
|
|
/**
|
|
* The addon's unique identifier.
|
|
* @minimum 1
|
|
*/
|
|
id: number;
|
|
/** Parameters for the addon provider. This object has different required and optional properties depending on the provider you choose. */
|
|
parameters: AddonSchemaParameters;
|
|
/** The projects that this addon listens to events from. An empty list means it listens to events from **all** projects. */
|
|
projects?: string[];
|
|
/** The addon provider, such as "webhook" or "slack". */
|
|
provider: string;
|
|
}
|