You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`GET /...` (*Endpoint name to be chosen by implementation*) |`GET /collections`|`https://api.stacspec.org/v1.0.0-rc.1/collection-search#sortables`|`GET /collections/{collectionId}/items`|
125
+
126
+
An example for a link to the sortables endpoint could be:
Copy file name to clipboardExpand all lines: openapi.yaml
+117-1
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,113 @@ info:
9
9
license:
10
10
name: Apache License 2.0
11
11
url: 'http://www.apache.org/licenses/LICENSE-2.0'
12
-
paths: {}
12
+
tags:
13
+
- name: Sort Extension
14
+
description: |
15
+
An extension to the STAC API that allows sorting of results based on specified properties.
16
+
paths:
17
+
/sortables:
18
+
get:
19
+
summary: Sortables
20
+
operationId: getSortables
21
+
description: |-
22
+
This endpoint returns a list of properties (or aliases) that can be used in the `sortby` parameter
23
+
for the cross-collection item search (i.e. `GET /search` and `POST /search`).
24
+
It returns a JSON Schema that defines the properties allowed in `sortby`.
25
+
The precise definition of this can be found in the OGC API - Features - Part 5: Schemas.
26
+
tags:
27
+
- Sort Extension
28
+
responses:
29
+
"200":
30
+
$ref: "#/components/responses/Sortables"
31
+
default:
32
+
$ref: "#/components/responses/Error"
33
+
/collections/{collectionId}/sortables:
34
+
get:
35
+
summary: Sortables for Item lists of a specific Collection
36
+
operationId: getCollectionForCollection
37
+
description: |-
38
+
This endpoint returns a list of properties (or aliases) that can be used in the `sortby` parameter
39
+
for the item lists of a collection (i.e. `GET /collections/{collectionId}/items`).
40
+
It returns a JSON Schema that defines the properties allowed in `sortby`.
41
+
The precise definition of this can be found in the OGC API - Features - Part 5: Schemas.
42
+
tags:
43
+
- Sort Extension
44
+
parameters:
45
+
- in: path
46
+
name: collectionId
47
+
schema:
48
+
type: string
49
+
required: true
50
+
description: ID of Collection
51
+
responses:
52
+
"200":
53
+
$ref: "#/components/responses/Sortables"
54
+
default:
55
+
$ref: "#/components/responses/Error"
13
56
components:
57
+
responses:
58
+
Sortables:
59
+
description: A JSON Schema defining the properties allowed in `sortby`.
60
+
content:
61
+
application/schema+json:
62
+
schema:
63
+
type: object
64
+
properties:
65
+
$schema:
66
+
type: string
67
+
format: uri
68
+
enum:
69
+
- https://json-schema.org/draft/2020-12/schema
70
+
$id:
71
+
type: string
72
+
format: uri
73
+
type:
74
+
type: string
75
+
enum:
76
+
- object
77
+
properties:
78
+
type: object
79
+
additionalProperties:
80
+
type: object
81
+
required:
82
+
- type
83
+
properties:
84
+
type:
85
+
type: string
86
+
title:
87
+
type: string
88
+
description:
89
+
type: string
90
+
additionalProperties: true
91
+
additionalProperties:
92
+
description: |-
93
+
If `additionalProperties` is not included or has the default value `true`, any property name is valid in a sorting expression on the collection that is evaluated by the server and the property reference SHALL evaluate to `null`, if the property does not exist for a resource.
94
+
95
+
If `additionalProperties` is set to `false`, property references that are not explicitly declared in the sortables schema SHALL result in a 400 response.
0 commit comments