|
|
|
@@ -92,6 +92,7 @@ export type GetEntitiesByQuery = {
|
|
|
|
|
orderField?: Array<string>;
|
|
|
|
|
cursor?: string;
|
|
|
|
|
filter?: Array<string>;
|
|
|
|
|
totalItems?: 'include' | 'exclude';
|
|
|
|
|
fullTextFilterTerm?: string;
|
|
|
|
|
fullTextFilterFields?: Array<string>;
|
|
|
|
|
};
|
|
|
|
@@ -308,6 +309,7 @@ export class DefaultApiClient {
|
|
|
|
|
* @param orderField - By default the entities are returned ordered by their internal uid. You can customize the `orderField` query parameters to affect that ordering. For example, to return entities by their name: `/entities/by-query?orderField=metadata.name,asc` Each parameter can be followed by `asc` for ascending lexicographical order or `desc` for descending (reverse) lexicographical order.
|
|
|
|
|
* @param cursor - You may pass the `cursor` query parameters to perform cursor based pagination through the set of entities. The value of `cursor` will be returned in the response, under the `pageInfo` property: ```json \"pageInfo\": { \"nextCursor\": \"a-cursor\", \"prevCursor\": \"another-cursor\" } ``` If `nextCursor` exists, it can be used to retrieve the next batch of entities. Following the same approach, if `prevCursor` exists, it can be used to retrieve the previous batch of entities. - [`filter`](#filtering), for selecting only a subset of all entities - [`fields`](#field-selection), for selecting only parts of the full data structure of each entity - `limit` for limiting the number of entities returned (20 is the default) - [`orderField`](#ordering), for deciding the order of the entities - `fullTextFilter` **NOTE**: [`filter`, `orderField`, `fullTextFilter`] and `cursor` are mutually exclusive. This means that, it isn\'t possible to change any of [`filter`, `orderField`, `fullTextFilter`] when passing `cursor` as query parameters, as changing any of these properties will affect pagination. If any of `filter`, `orderField`, `fullTextFilter` is specified together with `cursor`, only the latter is taken into consideration.
|
|
|
|
|
* @param filter - You can pass in one or more filter sets that get matched against each entity. Each filter set is a number of conditions that all have to match for the condition to be true (conditions effectively have an AND between them). At least one filter set has to be true for the entity to be part of the result set (filter sets effectively have an OR between them). Example: ```text /entities/by-query?filter=kind=user,metadata.namespace=default&filter=kind=group,spec.type Return entities that match Filter set 1: Condition 1: kind = user AND Condition 2: metadata.namespace = default OR Filter set 2: Condition 1: kind = group AND Condition 2: spec.type exists ``` Each condition is either on the form `<key>`, or on the form `<key>=<value>`. The first form asserts on the existence of a certain key (with any value), and the second asserts that the key exists and has a certain value. All checks are always case _insensitive_. In all cases, the key is a simplified JSON path in a given piece of entity data. Each part of the path is a key of an object, and the traversal also descends through arrays. There are two special forms: - Array items that are simple value types (such as strings) match on a key-value pair where the key is the item as a string, and the value is the string `true` - Relations can be matched on a `relations.<type>=<targetRef>` form Let\'s look at a simplified example to illustrate the concept: ```json { \"a\": { \"b\": [\"c\", { \"d\": 1 }], \"e\": 7 } } ``` This would match any one of the following conditions: - `a` - `a.b` - `a.b.c` - `a.b.c=true` - `a.b.d` - `a.b.d=1` - `a.e` - `a.e=7` Some more real world usable examples: - Return all orphaned entities: `/entities/by-query?filter=metadata.annotations.backstage.io/orphan=true` - Return all users and groups: `/entities/by-query?filter=kind=user&filter=kind=group` - Return all service components: `/entities/by-query?filter=kind=component,spec.type=service` - Return all entities with the `java` tag: `/entities/by-query?filter=metadata.tags.java` - Return all users who are members of the `ops` group (note that the full [reference](references.md) of the group is used): `/entities/by-query?filter=kind=user,relations.memberof=group:default/ops`
|
|
|
|
|
* @param totalItems - Controls whether the response\'s `totalItems` field is computed. Computing the total may be expensive for large catalogs; pass `exclude` if the caller does not need it (e.g. cursor-paginated UIs that only display the count cosmetically). Defaults to `include`. New values may be added in the future, such as an approximate mode.
|
|
|
|
|
* @param fullTextFilterTerm - Text search term.
|
|
|
|
|
* @param fullTextFilterFields - A comma separated list of fields to sort returned results by.
|
|
|
|
|
*/
|
|
|
|
@@ -318,7 +320,7 @@ export class DefaultApiClient {
|
|
|
|
|
): Promise<TypedResponse<EntitiesQueryResponse>> {
|
|
|
|
|
const baseUrl = await this.discoveryApi.getBaseUrl(pluginId);
|
|
|
|
|
|
|
|
|
|
const uriTemplate = `/entities/by-query{?fields,limit,offset,orderField*,cursor,filter*,fullTextFilterTerm,fullTextFilterFields}`;
|
|
|
|
|
const uriTemplate = `/entities/by-query{?fields,limit,offset,orderField*,cursor,filter*,totalItems,fullTextFilterTerm,fullTextFilterFields}`;
|
|
|
|
|
|
|
|
|
|
const uri = parser.parse(uriTemplate).expand({
|
|
|
|
|
...request.query,
|
|
|
|
|
Fredrik Adelöw