[FS-1075] Extend the Swagger documentation for federation error types (…

…#3045) * Extend the docs on the federation error type
wireapp · Feb 10, 2023 · 14479e6 · 14479e6
1 parent 764cc98
commit 14479e6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/changelog.d/4-docs/federation-error-type b/changelog.d/4-docs/federation-error-type
@@ -0,0 +1 @@
+Extend the docs on the federation error type
diff --git a/services/brig/docs/swagger.md b/services/brig/docs/swagger.md
@@ -37,6 +37,7 @@ For errors that are more likely to be transient, we suggest clients to retry wha
 
 **Note**: when a failure occurs as a result of making a federated RPC to another backend, the error response contains the following extra fields:
 
+ - `type`: "federation" (just the literal string in quotes, which can be used as an error type identifier when parsing errors)
  - `domain`: the target backend of the RPC that failed;
  - `path`: the path of the RPC that failed.