Skip to content

Commit

Permalink
Jobs and services: Added create_parameters property in responses to…
Browse files Browse the repository at this point in the history
… define the parameters that can be submitted suring creation #276
  • Loading branch information
m-mohr committed Nov 15, 2022
1 parent d018e4b commit 0de6500
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- `recovery-form` to link to the credentials recovery page.
- `GET /me`: New Relation types `alternate` and `related` for user-specific external pages. [#404](https://github.com/Open-EO/openeo-api/issues/404)
- `GET /credentials/oidc`: Allow `authorization_code` and `urn:ietf:params:oauth:grant-type:device_code` (both without PKCE) as grants for `default_clients`. [#410](https://github.com/Open-EO/openeo-api/issues/410)
- `GET /jobs` and `GET /services`: Added `create_parameters` property in responses to define the parameters that can be submitted when creating jobs or services. [#276](https://github.com/Open-EO/openeo-api/issues/276)
- `GET /jobs` and `GET /jobs/{job_id}`: Added a links property that can for example link to results and logs. [#453](https://github.com/Open-EO/openeo-api/issues/453)
- `GET /jobs/{job_id}/results`:
- Recommendation to add a link with relation type `canonical` which points to a signed URL with the same content as the response. [#397](https://github.com/Open-EO/openeo-api/issues/397)
Expand Down
20 changes: 20 additions & 0 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2580,6 +2580,8 @@ paths:
$ref: '#/components/schemas/service'
links:
$ref: '#/components/schemas/links_pagination'
create_parameters:
$ref: '#/components/schemas/processing_create_parameters'
4XX:
$ref: '#/components/responses/client_error_auth'
5XX:
Expand Down Expand Up @@ -2824,6 +2826,8 @@ paths:
$ref: '#/components/schemas/batch_job'
links:
$ref: '#/components/schemas/links_pagination'
create_parameters:
$ref: '#/components/schemas/processing_create_parameters'
4XX:
$ref: '#/components/responses/client_error_auth'
5XX:
Expand Down Expand Up @@ -5687,6 +5691,22 @@ components:
"foo" but cannot be 1. See [JSON Schema draft-07](https://json-schema.org/draft-07/json-schema-validation.html#rfc.section.10.2).
allOf:
- $ref: '#/components/schemas/json_schema'
processing_create_parameters:
title: Creation Parameters
description: |-
List of additional custom parameters that a back-end offers during the creation
of batch jobs (`POST /jobs`) and secondary web services (`POST /services`) respectively.
type: array
items:
$ref: '#/components/schemas/parameter'
example:
- name: memory
description: Maximum amount of memory that will be allocated for processing, in gigabytes.
optional: true
default: 32
schema:
type: integer
minimum: 1
error:
title: General Error
description: >-
Expand Down

0 comments on commit 0de6500

Please sign in to comment.