Skip to content

Commit 2c21fad

Browse files
janjezersekjanjezersek
committed
Add documentation for GET /commercial_data/search endpoint: searching available products.
1 parent f55f8d2 commit 2c21fad

File tree

1 file changed

+254
-1
lines changed

1 file changed

+254
-1
lines changed

‎openapi.yaml

Lines changed: 254 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3505,7 +3505,7 @@ paths:
35053505
Lists information about pricing and available parameters for searching and ordering products for a commercial data collection specified by the identifier `collection_id`.
35063506
STAC-compliant general information about the collection must be available at `GET collections/{collection_id}`.
35073507
tags:
3508-
- Commercial data
3508+
- Commercial Data
35093509
security:
35103510
- {}
35113511
- Bearer: []
@@ -3645,6 +3645,259 @@ paths:
36453645
$ref: '#/components/responses/client_error_auth'
36463646
5XX:
36473647
$ref: '#/components/responses/server_error'
3648+
/commercial_data/search:
3649+
post:
3650+
summary: Search for available products in a commercial data collection.
3651+
operationId: commercial-data-search
3652+
description: |-
3653+
Search for products in a commercial data collection. Available filtering parameters are listed at `GET /commercial_data/collections/{collection_id}`.
3654+
tags:
3655+
- Commercial Data
3656+
security:
3657+
- Bearer: []
3658+
parameters:
3659+
- $ref: '#/components/parameters/pagination_limit'
3660+
responses:
3661+
'200':
3662+
description: Lists of available products and related links.
3663+
content:
3664+
application/json:
3665+
schema:
3666+
title: Available Products
3667+
type: object
3668+
required:
3669+
- products
3670+
- links
3671+
properties:
3672+
products:
3673+
type: array
3674+
description: An array of available products as STAC Items.
3675+
title: Item
3676+
items:
3677+
type: object
3678+
required:
3679+
- stac_version
3680+
- id
3681+
- type
3682+
- geometry
3683+
- properties
3684+
- assets
3685+
- links
3686+
properties:
3687+
stac_version:
3688+
$ref: '#/components/schemas/stac_version'
3689+
stac_extensions:
3690+
$ref: '#/components/schemas/stac_extensions'
3691+
id:
3692+
type: string
3693+
description: Unique identifier of a product.
3694+
type:
3695+
type: string
3696+
description: >-
3697+
The GeoJSON type that applies to this metadata document,
3698+
which MUST always be a "Feature" according to the STAC specification.
3699+
3700+
This type does **not** describe the spatial data type of the assets.
3701+
enum:
3702+
- Feature
3703+
bbox:
3704+
description: |-
3705+
Potential *spatial extent* covered by the data.
3706+
3707+
The bounding box is provided as four or six numbers. Six numbers are
3708+
specified, if the coordinate reference system includes a vertical axis
3709+
(height or depth). The order of the elements in the array:
3710+
3711+
- West (lower left corner, coordinate axis 1)
3712+
- South (lower left corner, coordinate axis 2)
3713+
- Base (optional, lower left corner, coordinate axis 3)
3714+
- East (upper right corner, coordinate axis 1)
3715+
- North (upper right corner, coordinate axis 2)
3716+
- Height (optional, upper right corner, coordinate axis 3)
3717+
3718+
The coordinate reference system of the values is WGS84
3719+
longitude/latitude.
3720+
3721+
Specifying the `bbox` is strongly RECOMMENDED for STAC compliance,
3722+
but can be omitted if the result is unlocated and the `geometry`
3723+
is set to `null`.
3724+
type: array
3725+
oneOf:
3726+
- title: 4 elements
3727+
minItems: 4
3728+
maxItems: 4
3729+
- title: 6 elements
3730+
minItems: 6
3731+
maxItems: 6
3732+
items:
3733+
type: number
3734+
example:
3735+
- -180
3736+
- -90
3737+
- 180
3738+
- 90
3739+
geometry:
3740+
description: |-
3741+
Defines the full footprint of the asset represented by this item as
3742+
GeoJSON Geometry.
3743+
3744+
Results without a known location can set this value to `null`.
3745+
nullable: true
3746+
allOf:
3747+
- $ref: '#/components/schemas/GeoJsonGeometry'
3748+
example:
3749+
type: Polygon
3750+
coordinates:
3751+
- - - -180
3752+
- -90
3753+
- - 180
3754+
- -90
3755+
- - 180
3756+
- 90
3757+
- - -180
3758+
- 90
3759+
- - -180
3760+
- -90
3761+
properties:
3762+
type: object
3763+
title: Item Properties
3764+
description: >-
3765+
MAY contain additional properties other than the required property `datetime`,
3766+
e.g. custom properties or properties from the STAC specification or STAC extensions.
3767+
required:
3768+
- datetime
3769+
additionalProperties: true
3770+
properties:
3771+
datetime:
3772+
title: Date and Time
3773+
description: >-
3774+
The searchable date/time of the data, in UTC. Formatted as a
3775+
[RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
3776+
3777+
3778+
If this field is set to `null` (usually for larger time ranges),
3779+
it is STRONGLY RECOMMENDED to specify both `start_datetime` and
3780+
`end_datetime` for STAC compliance.
3781+
type: string
3782+
format: date-time
3783+
nullable: true
3784+
start_datetime:
3785+
type: string
3786+
format: date-time
3787+
description: >-
3788+
For time series: The first or start date and time for the data,
3789+
in UTC. Formatted as a [RFC
3790+
3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
3791+
end_datetime:
3792+
type: string
3793+
format: date-time
3794+
description: >-
3795+
For time series: The last or end date and time for the data, in
3796+
UTC. Formatted as a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)
3797+
date-time.
3798+
title:
3799+
$ref: '#/components/schemas/eo_title'
3800+
description:
3801+
$ref: '#/components/schemas/eo_description'
3802+
license:
3803+
$ref: '#/components/schemas/stac_license'
3804+
providers:
3805+
$ref: '#/components/schemas/stac_providers'
3806+
created:
3807+
$ref: '#/components/schemas/created'
3808+
updated:
3809+
$ref: '#/components/schemas/updated'
3810+
expires:
3811+
type: string
3812+
format: date-time
3813+
description: >-
3814+
Time until which the assets are accessible, in UTC. Formatted as
3815+
a [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html) date-time.
3816+
example: '2020-11-01T00:00:00Z'
3817+
assets:
3818+
$ref: '#/components/schemas/stac_assets'
3819+
links:
3820+
type: array
3821+
description: Links related to this product
3822+
items:
3823+
$ref: '#/components/schemas/link'
3824+
links:
3825+
$ref: '#/components/schemas/links_pagination'
3826+
example:
3827+
products:
3828+
- type: Feature
3829+
stac_version: 0.9.0
3830+
id: c8a1f88d-89cf-4933-9118-45e9c1a5df20
3831+
geometry:
3832+
type: Polygon
3833+
coordinates:
3834+
-
3835+
-
3836+
- 12.36555287044679
3837+
- 41.94403289260048
3838+
-
3839+
- 12.36571746774068
3840+
- 41.86399361096971
3841+
-
3842+
- 12.60746759743069
3843+
- 41.86372776276345
3844+
-
3845+
- 12.60758647471871
3846+
- 41.94379931812686
3847+
-
3848+
- 12.36555287044679
3849+
- 41.94403289260048
3850+
properties:
3851+
constellation: PHR
3852+
acquisitionDate: "2022-03-21T10:11:15.055Z"
3853+
azimuthAngle: 179.9852862071639
3854+
cloudCover: 0
3855+
geometryCentroid:
3856+
lat: 41.903935647240964
3857+
lon: 12.486569672582828
3858+
processingLevel: SENSOR
3859+
sensorType: OPTICAL
3860+
spectralRange: VISIBLE
3861+
links: []
3862+
4XX:
3863+
$ref: '#/components/responses/client_error_auth'
3864+
5XX:
3865+
$ref: '#/components/responses/server_error'
3866+
requestBody:
3867+
required: true
3868+
description: The base data for the secondary web service to create
3869+
content:
3870+
application/json:
3871+
schema:
3872+
title: Search Commercial Products Request
3873+
type: object
3874+
required:
3875+
- collection_id
3876+
- parameters
3877+
properties:
3878+
collection_id:
3879+
type: string
3880+
description: Unique identifier of the collection.
3881+
parameters:
3882+
type: object
3883+
description: Key-value pairs of available `search_parameters` as listed at `GET /commercial_data/collections/{collection_id}` for filtering available products.
3884+
additionalProperties:
3885+
x-additionalPropertiesName: Search Parameter Name
3886+
AnyValue:
3887+
description: Value of the search parameter to be used in the request.
3888+
example:
3889+
collection_id: "PLEIADES"
3890+
parameters:
3891+
bounds:
3892+
- 3
3893+
- 15
3894+
- 4
3895+
- 16
3896+
time_range:
3897+
- "01-01-2022"
3898+
- "01-02-2022"
3899+
processing_level: SENSOR
3900+
max_snow_coverage: 0
36483901
components:
36493902
schemas:
36503903
udf_runtime:

0 commit comments

Comments
 (0)