unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
103 lines • 4.82 kB
TypeScript
import type { FromSchema } from 'json-schema-to-ts';
export declare const bulkRegistrationSchema: {
readonly $id: "#/components/schemas/bulkRegistrationSchema";
readonly type: "object";
readonly required: readonly ["appName", "instanceId", "environment"];
readonly description: "An application registration. Defines the format POSTed by our server-side SDKs when they're starting up";
readonly properties: {
readonly connectVia: {
readonly type: "array";
readonly description: "A list of applications this app registration has been registered through. If connected directly to Unleash, this is an empty list. \n This can be used in later visualizations to tell how many levels of proxy or Edge instances our SDKs have connected through";
readonly items: {
readonly type: "object";
readonly required: readonly ["appName", "instanceId"];
readonly properties: {
readonly appName: {
readonly type: "string";
};
readonly instanceId: {
readonly type: "string";
};
};
};
readonly example: readonly [{
readonly appName: "unleash-edge";
readonly instanceId: "edge-pod-bghzv5";
}];
};
readonly appName: {
readonly description: "The name of the application that is evaluating toggles";
readonly type: "string";
readonly example: "Ingress load balancer";
};
readonly environment: {
readonly description: "Which environment the application is running in";
readonly type: "string";
readonly example: "development";
};
readonly instanceId: {
readonly description: "A [(somewhat) unique identifier](https://docs.getunleash.io/reference/sdks/node#advanced-usage) for the application";
readonly type: "string";
readonly example: "application-name-dacb1234";
};
readonly interval: {
readonly description: "How often (in seconds) the application refreshes its features";
readonly type: "number";
readonly example: 10;
};
readonly started: {
readonly description: "The application started at";
readonly example: "1952-03-11T12:00:00.000Z";
readonly $ref: "#/components/schemas/dateSchema";
};
readonly strategies: {
readonly description: "Enabled [strategies](https://docs.getunleash.io/reference/activation-strategies) in the application";
readonly type: "array";
readonly example: readonly ["standard", "gradualRollout"];
readonly items: {
readonly type: "string";
};
};
readonly projects: {
readonly description: "The list of projects used in the application";
readonly type: "array";
readonly example: readonly ["projectA", "projectB"];
readonly items: {
readonly type: "string";
};
};
readonly sdkVersion: {
readonly description: "The version the sdk is running. Typically <client>:<version>";
readonly example: "unleash-client-java:8.0.0";
readonly type: "string";
};
readonly sdkType: {
readonly description: "The sdk type";
readonly example: "backend";
readonly type: "string";
readonly enum: readonly ["frontend", "backend", null];
readonly nullable: true;
};
};
readonly components: {
readonly schemas: {
readonly dateSchema: {
readonly $id: "#/components/schemas/dateSchema";
readonly description: "A representation of a date. Either as a date-time string or as a UNIX timestamp.";
readonly oneOf: readonly [{
readonly type: "string";
readonly format: "date-time";
readonly description: "An [RFC-3339](https://www.rfc-editor.org/rfc/rfc3339.html)-compliant timestamp.";
readonly example: "2023-07-27T11:23:44Z";
}, {
readonly type: "integer";
readonly description: "A [UNIX timestamp](https://en.wikipedia.org/wiki/Unix_time).";
readonly example: 1690449593;
}];
readonly components: {};
};
};
};
};
export type BulkRegistrationSchema = FromSchema<typeof bulkRegistrationSchema>;
//# sourceMappingURL=bulk-registration-schema.d.ts.map