From 4522a4ba2422ea692c76dfe596ffa8469c5edb97 Mon Sep 17 00:00:00 2001 From: Vincenzo Scamporlino Date: Fri, 22 Dec 2023 10:45:32 +0100 Subject: [PATCH] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fredrik Adelöw Signed-off-by: Vincenzo Scamporlino --- docs/features/software-catalog/api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/features/software-catalog/api.md b/docs/features/software-catalog/api.md index b7f7c33504..3ab3c0df96 100644 --- a/docs/features/software-catalog/api.md +++ b/docs/features/software-catalog/api.md @@ -171,7 +171,7 @@ Some more real world usable examples: `/entities/by-query?fields=kind,metadata.namespace,metadata.name` -### Ordering +#### Ordering By default the entities are returned ordered by their internal uid. You can customize the `orderField` query parameters to affect that ordering. @@ -186,7 +186,7 @@ Each parameter can be followed by `asc` for ascending lexicographical order or #### Pagination 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 `pageInfo` property: +through the set of entities. The value of `cursor` will be returned in the response, under the `pageInfo` property: ```json "pageInfo": { @@ -211,7 +211,9 @@ if `prevCursor` exists, it can be used to retrieve the previous batch of entitie ### `GET /entities` Lists entities. + **NOTE**: This endpoint is deprecated in favor of `GET /entities/by-query`, which provides a more efficient implementation and cursor based pagination. + The endpoint supports the following query parameters, described in sections below: