From 52aee00a8cdbc8823db2dbe1392ce6261831a4c0 Mon Sep 17 00:00:00 2001 From: Pavel Perestoronin Date: Mon, 27 Nov 2023 17:25:04 +0100 Subject: [PATCH] =?UTF-8?q?OPT:=20add=20SOAP=20fault=20notes=20?= =?UTF-8?q?=F0=9F=93=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- combadge/support/soap/response.py | 19 ++++++++++++------- docs/support/soap.md | 7 +++++++ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/combadge/support/soap/response.py b/combadge/support/soap/response.py index c90fc54..adafdd1 100644 --- a/combadge/support/soap/response.py +++ b/combadge/support/soap/response.py @@ -7,15 +7,20 @@ class BaseSoapFault(ErrorResponse): """ - SOAP Fault model. + [SOAP Fault][1] error response model. - Notes: - - This class matches the SOAP Fault specification. - For custom errors returned in a SOAP response body (such as `` tag), - subclass the `ErrorResponse`. + [1]: https://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383507 - See Also: - - https://www.w3.org/TR/2000/NOTE-SOAP-20000508/#_Toc478383507 + Note: This class is intended for use with the SOAP Fault specification + For custom errors returned in a SOAP response body (such as `` tag), + subclass the `ErrorResponse`. + + Tip: + SOAP backends should **always** fall back to `BaseSoapFault` if the actual SOAP fault + does not match any of the protocol's return types. + + For client developers, this means that it is a good idea to include `BaseSoapFault` + as the last possible `Union` variant to let users know that is should be handled. """ code: str diff --git a/docs/support/soap.md b/docs/support/soap.md index c346d93..5cbbd7b 100644 --- a/docs/support/soap.md +++ b/docs/support/soap.md @@ -15,3 +15,10 @@ tags: options: heading_level: 3 show_bases: true + +## Responses + +::: combadge.support.soap.response + options: + heading_level: 3 + show_bases: true