Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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
19,180 changes: 6,519 additions & 12,661 deletions openapi/ogcapi-processes.bundled.json

Large diffs are not rendered by default.

312 changes: 288 additions & 24 deletions openapi/ogcapi-processes.yaml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions openapi/parameters/processes-core/bbox-crs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: |-
in: query
description: |-
Asserts the CRS used for the coordinate values of a bounding
box input parameter.
box input parameter.
required: false
schema:
schema:
type: object
patternProperties:
"^.+[crs]$":
Expand Down
9 changes: 4 additions & 5 deletions openapi/parameters/processes-core/response.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@ name: response
in: query
description: |-
For executing the process using the _Collection Output_ mechanism, where the
client is redirected (_303_ status) to either an OGC API landing page or
collection resource, from which one or more OGC API data access mechanism
is available. Data access requests may trigger processing on-demand for
a given area, time and resolution of interest.
client is redirected (_303_ status) to a collection resource, from which one
or more OGC API data access mechanism is available. Data access requests may
trigger processing on-demand for a given area, time and resolution of interest.
required: false
schema:
type: string
enum: [ collection, landingPage ]
enum: [ collection ]
10 changes: 0 additions & 10 deletions openapi/parameters/processes-workflows/response.yaml

This file was deleted.

3 changes: 0 additions & 3 deletions openapi/paths/common-geodata/pCollectionsList.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ get:
operationId: getCollectionsList
summary: Retrieve the list of geospatial data collections available from this service.
parameters:
- $ref: '../../parameters/common-geodata/datetime.yaml'
- $ref: '../../parameters/common-geodata/bbox.yaml'
- $ref: '../../parameters/common-geodata/limit-collections.yaml'
- $ref: '../../parameters/unspecified/f-metadata.yaml'
responses:
'200':
Expand Down
3 changes: 3 additions & 0 deletions openapi/paths/processes-core/pExecution.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ post:
- Processes
parameters:
- $ref: "../../parameters/processes-core/processID-path.yaml"
- $ref: "../../parameters/processes-core/response.yaml"
- $ref: "../../parameters/processes-core/prefer-header-execution.yaml"
requestBody:
description: |-
Expand All @@ -27,6 +28,8 @@ post:
$ref: "../../responses/processes-core/rExecuteAsync.yaml"
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
303:
$ref: "../../responses/processes-core/rExecuteCollectionRedirect.yaml"
404:
$ref: "../../responses/common-core/rNotFound.yaml"
500:
Expand Down
11 changes: 7 additions & 4 deletions openapi/paths/processes-dru/pDeploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@ post:
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
application/cwl:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+json:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+yaml:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
responses:
201:
$ref: "../../schemas/processes-core/processSummary.yaml"
$ref: "../../responses/processes-dru/rProcessSummary.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
Expand Down
12 changes: 9 additions & 3 deletions openapi/paths/processes-dru/pPackage.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,18 @@ get:
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
application/cwl:
schema:
$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+json:
schema:
$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+yaml:
schema:
$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://raw.githubusercontent.com/common-workflow-lab/cwl-ts-auto/main/json_schemas/cwl_schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
404:
$ref: "../../responses/common-core/rNotFound.yaml"
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,16 @@ put:
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
application/cwl:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+json:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+yaml:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
responses:
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
Expand Down
11 changes: 7 additions & 4 deletions openapi/paths/processes-dru/pProcessListDeploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,19 @@ post:
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
application/cwl:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+json:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+yaml:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
responses:
201:
$ref: "../../schemas/processes-core/processSummary.yaml"
$ref: "../../responses/processes-dru/rProcessSummary.yaml"
400:
$ref: "../../responses/processes-dru/rWorkflowNotFound.yaml"
403:
Expand Down
9 changes: 6 additions & 3 deletions openapi/paths/processes-dru/pReplace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,16 @@ put:
$ref: "../../schemas/processes-dru/ogcapppkg.yaml"
application/cwl:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+json:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
application/cwl+yaml:
schema:
$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
#$ref: "https://w3id.org/cwl/v1.2/cwl-json-schema.yaml"
$ref: "../../schemas/cwl/cwl.yaml"
responses:
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
Expand Down
4 changes: 2 additions & 2 deletions openapi/paths/processes-workflows/pExecution-workflows.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ post:
- Processes
parameters:
- $ref: "../../parameters/processes-core/processID-path.yaml"
- $ref: "../../parameters/processes-workflows/response.yaml"
- $ref: "../../parameters/processes-core/response.yaml"
- $ref: "../../parameters/processes-core/prefer-header-execution.yaml"
requestBody:
description: An execution request specifying any inputs for the process to execute, and optionally to select specific outputs.
Expand All @@ -26,7 +26,7 @@ post:
204:
$ref: "../../responses/processes-core/rEmpty.yaml"
303:
$ref: "../../responses/processes-workflows/rExecuteCollectionRedirect.yaml"
$ref: "../../responses/processes-core/rExecuteCollectionRedirect.yaml"
404:
$ref: "../../responses/common-core/rNotFound.yaml"
500:
Expand Down
8 changes: 5 additions & 3 deletions openapi/responses/common-geodata/rCollection.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
description: |-
Information about a particular collection of (mostly geospatial) data available from this API. The collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is contained in the response, with the corresponding relation type, as well as key information about the collection. This information includes:
Information about a particular collection of (mostly geospatial) data available from this API. The collection is accessible via one or more OGC API set of specifications, for which a link to relevant accessible resources, e.g. /collections/{collectionId}/(items, coverage, map, tiles...) is contained in the response, with the corresponding relation type, as well as key information about the collection. This information includes (among other things):
* a local identifier for the collection that is unique for the dataset;
* a list of coordinate reference systems (CRS) in which data may be returned by the server. The first CRS is the default coordinate reference system (the default is always WGS 84 with axis order longitude/latitude);
* a list of coordinate reference systems (CRS) in which data may be returned by the server;
* an optional title and description for the collection;
* an optional extent that can be used to provide an indication of the spatial and temporal extent of the collection - typically derived from the data;
* for collections accessible via the Features or Records API, an optional indicator about the type of the items in the collection (the default value, if the indicator is not provided, is 'feature').
content:
application/json:
schema:
$ref: '../../schemas/common-geodata/collectionInfo.yaml'
$ref: '../../schemas/common-geodata/collectionDesc.yaml'
# For APIs conforming to the Uniform Additional Dimensions requirements class, reference the collectionDesc-UAD.yaml schema instead
# $ref: '../../schemas/common-geodata/collectionDesc-UAD.yaml'
example:
id: buildings
title: Buildings
Expand Down
23 changes: 12 additions & 11 deletions openapi/responses/processes-core/rExecuteSync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@ description: Result of synchronous execution
content:
application/json:
schema:
oneOf:
- type: string
- type: number
- type: integer
- type: object
nullable: true
- type: array
items: { }
- type: boolean
- type: string
format: binary
anyOf:
- oneOf:
- type: string
- type: number
- type: integer
- type: object
nullable: true
- type: array
items: { }
- type: boolean
- type: string
format: binary
- $ref: "../../schemas/processes-core/results.yaml"
image/png:
schema:
Expand Down
5 changes: 5 additions & 0 deletions openapi/responses/processes-dru/rProcessSummary.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
description: A process summary.
content:
application/json:
schema:
$ref: "../../schemas/processes-core/processSummary.yaml"
9 changes: 9 additions & 0 deletions openapi/responses/processes-dru/rWorkflowNotFound.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# NOTE: References to this missing file were added in 3cd54af60cd7fede3fc9647aa39c5fbeddd219f0 -- the correct version should be added.
description: The requested workflow does not exist on the server.
content:
application/json:
schema:
$ref: '../../schemas/common-core/exception.yaml'
text/html:
schema:
type: string
71 changes: 71 additions & 0 deletions openapi/schemas/common-geodata/additionalDimensionExtent.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
title: Extent of any additional dimensions
description: The domain intervals for any additional dimensions of the extent (envelope) beyond those described in temporal and spatial.
type: object
oneOf:
- required: [ interval, definition ]
- required: [ interval, trs ]
- required: [ interval, vrs ]
properties:
interval:
title: Interval of the extent of this dimension
description: |-
One or more intervals that describe the extent for this dimension of the dataset.
The value `null` is supported and indicates an unbounded or half-bounded interval.
The first interval describes the overall extent of the data for this dimension.
All subsequent intervals describe more precise intervals, e.g., to identify clusters of data.
Clients only interested in the overall extent will only need
to access the first item (a pair of lower and upper bound values).
type: array
minItems: 1
items:
description: |-
Lower and upper bound values of the interval. The values
are in the coordinate reference system specified in `crs`, `trs` or `vrs`.
type: array
minItems: 2
maxItems: 2
items:
oneOf:
- type: string
nullable: true
example: '2011-11-11T12:22:11Z' #, '2011-11-11T08:22:11-04:00', null
- type: number
example: 32.7
trs:
title: Temporal Coordinate Reference System
description: Temporal Coordinate Reference System (e.g. as defined by Features for 'temporal'). This should be a URI to a registered TRS if one is available, or a full description of the TRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.
anyOf:
- type: string
- type: object
vrs:
title: Vertical Coordinate Reference System
description: Vertical Coordinate Reference System (e.g. as defined in EDR for 'vertical'). This should be a URI to a registered VRS if one is available, or a full description of the VRS otherwise using e.g., a WKT2CRS string, or a PROJJSON, or CRS JSON object.
anyOf:
- type: string
- type: object
grid:
$ref: 'grid.yaml'
definition:
type: string
format: uri
title: Observed property definition
description: A URI for the definition of the measured or observed property corresponding to this dimension.
unit:
type: string
title: Units of measurement
description: The unit of measure in which the interval and/or grid values are expressed.
unitLang:
type: string
default: UCUM
title: Units of measurement vocabulary
description: The language (or vocabulary) in which the unit is expressed (defaults to "UCUM" if not specified).
variableType:
title: Variable type
description: The type of variable which may inform correct interpretation and interpolation methods.
type: string
enum:
- continuous
- numericalOrdinal
- numericalNominal
- categoricalOrdinal
- categoricalNominal
6 changes: 6 additions & 0 deletions openapi/schemas/common-geodata/collectionDesc-UAD.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
allOf:
- $ref: 'collectionProperties.yaml'
- type: object
properties:
extent:
$ref: 'extent-UAD.yaml'
6 changes: 6 additions & 0 deletions openapi/schemas/common-geodata/collectionDesc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
allOf:
- $ref: 'collectionProperties.yaml'
- type: object
properties:
extent:
$ref: 'extent.yaml'
Loading