unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
52 lines • 1.86 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.deprecatedSearchEventsSchema = void 0;
const types_1 = require("../../types");
exports.deprecatedSearchEventsSchema = {
$id: '#/components/schemas/deprecatedSearchEventsSchema',
type: 'object',
description: `
Search for events by type, project, feature, free-text query,
or a combination thereof. Pass an empty object to fetch all events.
`,
properties: {
type: {
type: 'string',
description: 'Find events by event type (case-sensitive).',
enum: types_1.IEventTypes,
example: 'feature-created',
},
project: {
type: 'string',
description: 'Find events by project ID (case-sensitive).',
example: 'default',
},
feature: {
type: 'string',
description: 'Find events by feature flag name (case-sensitive).',
example: 'my.first.flag',
},
query: {
type: 'string',
description: `Find events by a free-text search query. The query will be matched against the event type, the username or email that created the event (if any), and the event data payload (if any).`,
example: 'admin@example.com',
},
limit: {
type: 'integer',
description: 'The maximum amount of events to return in the search result',
minimum: 1,
maximum: 100,
default: 100,
example: 50,
},
offset: {
description: 'Which event id to start listing from',
type: 'integer',
minimum: 0,
default: 0,
example: 100,
},
},
components: {},
};
//# sourceMappingURL=deprecated-search-events-schema.js.map