From 643a106d5d2d31d7edc3956616be098207cf388f Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Mon, 19 Oct 2020 13:29:57 -0700 Subject: [PATCH 1/2] Add Description to Error --- models/Error.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/models/Error.yaml b/models/Error.yaml index bcc7745..6f2e47b 100644 --- a/models/Error.yaml +++ b/models/Error.yaml @@ -42,6 +42,22 @@ properties: the details field. type: string example: "Invalid account format" + description: + description: | + Description allows the implementer to optionally provide additional information + about an error. In many cases, the content of this field will be a copy-and-paste + from existing developer documentation. + + Description can ONLY be populated with generic information about a particular + type of error. It MUST NOT be populated with information about a particular + instantiation of an error (use `details` for this). + + Whereas the content of Error.Message should stay stable across releases, the + content of Error.Description will likely change across releases (as implementers + improve error documentation). For this reason, the content in this field + is not part of any type assertion (unlike Error.Message). + type: string + example: "This error is returned when the requested AccountIdentifier is improperly formatted." retriable: description: | An error is retriable if the same request may succeed if submitted From 377d42fb35e17267a4f6c70ed4041556b7b0d2c4 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Mon, 19 Oct 2020 13:30:35 -0700 Subject: [PATCH 2/2] gen --- api.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api.json b/api.json index 48efc90..d10459f 100644 --- a/api.json +++ b/api.json @@ -2004,6 +2004,11 @@ "type":"string", "example":"Invalid account format" }, + "description": { + "description":"Description allows the implementer to optionally provide additional information about an error. In many cases, the content of this field will be a copy-and-paste from existing developer documentation. Description can ONLY be populated with generic information about a particular type of error. It MUST NOT be populated with information about a particular instantiation of an error (use `details` for this). Whereas the content of Error.Message should stay stable across releases, the content of Error.Description will likely change across releases (as implementers improve error documentation). For this reason, the content in this field is not part of any type assertion (unlike Error.Message).", + "type":"string", + "example":"This error is returned when the requested AccountIdentifier is improperly formatted." + }, "retriable": { "description":"An error is retriable if the same request may succeed if submitted again.", "type":"boolean"