Skip to content

Commit

Permalink
Add schema of return value for child processes #350
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Dec 21, 2020
1 parent abed573 commit 7b32aab
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -245,9 +245,10 @@ info:
Each process parameter and the return values of a process define a schema that the value MUST comply to. The schemas are based on [JSON Schema draft-07](http://json-schema.org/).
Two custom keywords have been defined:
Three custom keywords have been defined:
* `subtype` for more fine-grained data-types than JSON Schema supports.
* `parameters` to specify parameters that processes can pass to other process graphs.
* `returns` to specify return values that processes can get back from other process graphs.
### Subtypes
Expand Down Expand Up @@ -5311,13 +5312,27 @@ components:
properties:
parameters:
type: array
title: Process Graph Parameters
description: |-
A list of parameters passed to the child process graph.
The order in the array corresponds to the parameter order to
be used in clients that don't support named parameters.
items:
$ref: '#/components/schemas/parameter'
returns:
type: object
title: Process Graph Return Value
description: Description of the data that is returned by the child process graph.
required:
- schema
properties:
description:
$ref: '#/components/schemas/process_description'
schema:
$ref: '#/components/schemas/data_type_schema'
allOf:
- $ref: '#/components/schemas/json_schema'
allOf:
- $ref: '#/components/schemas/json_schema'
json_schema:
Expand Down

0 comments on commit 7b32aab

Please sign in to comment.