paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

Merge pull request #34214 from backstage/freben/queryentities-total-items

Browse Source 
catalog-backend: split queryEntities list + count, add totalItems mode
This commit is contained in:
Fredrik Adelöw
2026-05-26 14:47:46 +02:00
committed by GitHub
parent af8b07e602 2139bf53d1
commit 40e3e0e24d
20 changed files with 341 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/catalog-backend-totalitems-mode.md
+9
View File
@@ -0,0 +1,9 @@
---
'@backstage/plugin-catalog-backend': minor
---
`/entities/by-query` now accepts a `totalItems` parameter (`'include'` or `'exclude'`, default `'include'`) that controls whether the response's `totalItems` count is computed. Pass `'exclude'` to skip the count entirely when the caller doesn't need it — useful for cursor-paginated user interfaces that only display the count cosmetically. The accepted values list is forward-compatible: future modes (e.g. approximate counts) can be added without breaking existing callers.
The internal `QueryEntitiesInitialRequest.skipTotalItems` option has been replaced by `totalItems: 'include' | 'exclude'`. Note that `skipTotalItems` was never exposed as a REST API parameter, so this is only a TypeScript-level change affecting direct callers of `EntitiesCatalog.queryEntities`.
Sort field keys are now lowercased before comparing against `search.key`, fixing silent mismatches for camelCase field names. The `NULLS LAST` ordering clause has been removed since NULL sort values are already excluded by the `WHERE` clause.
.changeset/catalog-client-totalitems-mode.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/catalog-client': minor
---
`CatalogApi.queryEntities` now accepts a `totalItems` option (`'include'` or `'exclude'`, default `'include'`) on initial requests. Pass `'exclude'` to skip the `totalItems` count when the caller doesn't need it.