mirror of
https://github.com/Unleash/unleash.git
synced 2025-06-18 01:18:23 +02:00
74 lines
2.8 KiB
TypeScript
74 lines
2.8 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
import type { SearchFeaturesSortOrder } from './searchFeaturesSortOrder';
|
|
|
|
export type SearchFeaturesParams = {
|
|
/**
|
|
* The search query for the feature name or tag
|
|
*/
|
|
query?: string;
|
|
/**
|
|
* Id of the project where search and filter is performed. The project id can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
|
|
*/
|
|
project?: string;
|
|
/**
|
|
* The state of the feature active/stale. The state can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
|
|
*/
|
|
state?: string;
|
|
/**
|
|
* The lifecycle stage of the feature. The stagee can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
|
|
*/
|
|
lifecycle?: string;
|
|
/**
|
|
* The feature flag type to filter by. The type can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
|
|
*/
|
|
type?: string;
|
|
/**
|
|
* The feature flag creator to filter by. The creators can be specified with an operator. The supported operators are IS, IS_NOT, IS_ANY_OF, IS_NONE_OF.
|
|
*/
|
|
createdBy?: string;
|
|
/**
|
|
* The list of feature tags to filter by. Feature tag has to specify a type and a value joined with a colon.
|
|
*/
|
|
tag?: string;
|
|
/**
|
|
* The list of segments with operators to filter by. The segment valid operators are INCLUDE, DO_NOT_INCLUDE, INCLUDE_ALL_OF, INCLUDE_ANY_OF, EXCLUDE_IF_ANY_OF, EXCLUDE_ALL.
|
|
*/
|
|
segment?: string;
|
|
/**
|
|
* The list of feature environment status to filter by. Feature environment has to specify a name and a status joined with a colon.
|
|
*/
|
|
status?: string[];
|
|
/**
|
|
* The number of features to skip when returning a page. By default it is set to 0.
|
|
*/
|
|
offset?: string;
|
|
/**
|
|
* The number of feature environments to return in a page. By default it is set to 50.
|
|
*/
|
|
limit?: string;
|
|
/**
|
|
* The field to sort the results by. By default it is set to "createdAt".
|
|
*/
|
|
sortBy?: string;
|
|
/**
|
|
* The sort order for the sortBy. By default it is det to "asc".
|
|
*/
|
|
sortOrder?: SearchFeaturesSortOrder;
|
|
/**
|
|
* The flag to indicate if the favorite features should be returned first. By default it is set to false.
|
|
*/
|
|
favoritesFirst?: string;
|
|
/**
|
|
* Whether to get results for archived feature flags or active feature flags. If `true`, Unleash will return only archived flags. If `false`, it will return only active flags.
|
|
*/
|
|
archived?: string;
|
|
/**
|
|
* The date the feature was created. The date can be specified with an operator. The supported operators are IS_BEFORE, IS_ON_OR_AFTER.
|
|
*/
|
|
createdAt?: string;
|
|
};
|