Skip to content

Commit 4590b58

Browse files
committed
Fixes the schema and docs to make the error.instance property optional to authors
Signed-off-by: Charles d'Avernas <[email protected]>
1 parent eb31542 commit 4590b58

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

dsl-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1451,7 +1451,7 @@ Defines the [Problem Details RFC](https://datatracker.ietf.org/doc/html/rfc7807)
14511451
|----------|:----:|:--------:|-------------|
14521452
| 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> |
14531453
| 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> |
1454-
| instance | `string` | `yes` | 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> |
1454+
| 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> |
14551455
| title | `string` | `no` | A short, human-readable summary of the [`error`](#error). |
14561456
| detail | `string` | `no` | A human-readable explanation specific to this occurrence of the [`error`](#error). |
14571457

schema/workflow.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1098,7 +1098,7 @@ $defs:
10981098
type: string
10991099
title: ErrorDetails
11001100
description: A human-readable explanation specific to this occurrence of the error.
1101-
required: [ type, status, instance ]
1101+
required: [ type, status ]
11021102
endpoint:
11031103
title: Endpoint
11041104
description: Represents an endpoint.

0 commit comments

Comments
 (0)