Skip to content

Commit

Permalink
Fix #1076 - Make detail and title a runtime expression in the schema
Browse files Browse the repository at this point in the history
Signed-off-by: Ricardo Zanini <[email protected]>
  • Loading branch information
ricardozanini committed Feb 5, 2025
1 parent 48560fd commit e7da821
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions dsl-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -1115,7 +1115,7 @@ Defines the configuration of a catch clause, which a concept used to catch error

| Name | Type | Required | Description |
|:--|:---:|:---:|:---|
| errors | [`errorFilter`](#retry) | `no` | The definition of the errors to catch. |
| errors | [`errorFilter`](#error) | `no` | The definition of the errors to catch. |
| as | `string` | `no` | The name of the runtime expression variable to save the error as. Defaults to 'error'. |
| when | `string`| `no` | A runtime expression used to determine whether or not to catch the filtered error. |
| exceptWhen | `string` | `no` | A runtime expression used to determine whether or not to catch the filtered error. |
Expand Down Expand Up @@ -1958,8 +1958,8 @@ Defines the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807)
| type | [`uri-template`](#uri-template) | `yes` | A URI reference that identifies the [`error`](#error) type. <br><u>For cross-compatibility concerns, it is strongly recommended to use [Standard Error Types](#standard-error-types) whenever possible.<u><br><u>Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error).<u> |
| status | `integer` | `yes` | The status code generated by the origin for this occurrence of the [`error`](#error).<br><u>For cross-compatibility concerns, it is strongly recommended to use [HTTP Status Codes](https://datatracker.ietf.org/doc/html/rfc7231#section-6) whenever possible.<u><br><u>Runtimes **MUST** ensure that the property has been set when raising or escalating the [`error`](#error).<u> |
| instance | `string` | `no` | A [JSON Pointer](https://datatracker.ietf.org/doc/html/rfc6901) used to reference the component the [`error`](#error) originates from.<br><u>Runtimes **MUST** set the property when raising or escalating the [`error`](#error). Otherwise ignore.<u> |
| title | `string` | `no` | A short, human-readable summary of the [`error`](#error). |
| detail | `string` | `no` | A human-readable explanation specific to this occurrence of the [`error`](#error). |
| title | `string` | `no` | A short, human-readable summary of the [`error`](#error) or a [runtime expression](dsl.md#runtime-expressions) |
| detail | `string` | `no` | A human-readable explanation specific to this occurrence of the [`error`](#error) or a [runtime expression](dsl.md#runtime-expressions) |

#### Examples

Expand Down
4 changes: 2 additions & 2 deletions schema/workflow.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1188,11 +1188,11 @@ $defs:
title: ExpressionErrorInstance
description: An expression based error instance.
title:
type: string
$ref: '#/$defs/runtimeExpression'
title: ErrorTitle
description: A short, human-readable summary of the error.
detail:
type: string
$ref: '#/$defs/runtimeExpression'
title: ErrorDetails
description: A human-readable explanation specific to this occurrence of the error.
required: [ type, status ]
Expand Down

0 comments on commit e7da821

Please sign in to comment.