From cda3ff959dab6888747754feb25dc3cd3e3407fe Mon Sep 17 00:00:00 2001 From: Mehrn0ush Date: Wed, 26 Aug 2026 18:34:51 +0800 Subject: [PATCH] docs: clarify sortOrder default and name uniqueness Document the global ascending sortOrder default and recommend desc for newest releases/collections (#247). Document product/component name uniqueness as a per-type implementation recommendation (#248). Signed-off-by: Mehrn0ush --- spec/openapi.yaml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/spec/openapi.yaml b/spec/openapi.yaml index 11f5187..cf7128d 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -642,7 +642,11 @@ components: "$ref": "#/components/schemas/uuid" name: type: string - description: Product name + description: | + Product name. Within a TEA server, product names SHOULD be unique among + products. Uniqueness is an implementation recommendation, not a hard API + requirement. Product and component names are separate namespaces; a product + and a component MAY share the same name. identifiers: type: array description: | @@ -735,7 +739,11 @@ components: "$ref": "#/components/schemas/uuid" name: type: string - description: Component name + description: | + Component name. Within a TEA server, component names SHOULD be unique among + components. Uniqueness is an implementation recommendation, not a hard API + requirement. Product and component names are separate namespaces; a product + and a component MAY share the same name. identifiers: type: array description: List of identifiers for the component @@ -1696,6 +1704,9 @@ components: name: sortOrder description: | The direction of the sort. + + The default is `asc` for all paginated resources. Clients that need newest + release or collection versions first can request `sortOrder=desc`. The selected sort order applies to both the primary `sortField` and the resource-specific deterministic secondary tie-breaker. For products, components,