Skip to content

docs: clarify sortOrder default and name uniqueness #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mehrn0ush wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify sortOrder default and name uniqueness #263

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions spec/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down