From edd6f9c7fb4266de7db22030650b22ab9abc3b14 Mon Sep 17 00:00:00 2001 From: Jan Kobersky Date: Fri, 9 Feb 2024 11:09:36 +0100 Subject: [PATCH 1/5] Docs fixes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 129bae2..5c2ede6 100644 --- a/README.md +++ b/README.md @@ -211,7 +211,7 @@ networking.post( // specify endpoint to: endpoint, // custom HTTP headers - with: ["MyCustomHeader: "Value"], + with: ["MyCustomHeader": "Value"], // encrypt with the application scope encryptedWith: powerAuth.eciesEncryptorForApplicationScope(), // only wait 10 seconds at max @@ -310,7 +310,7 @@ Each `WPNError` has a `reason` property for why the error was created. Such reas |---|---| |`network_unknown`|When unknown (usually logic error) happened during networking.| |`network_generic`|When generic networking error happened.| -|`network_errorStatusCode`|HTTP response code was different than 200 (success).` +|`network_errorStatusCode`|HTTP response code was different than 200 (success).`| |`network_invalidResponseObject`|An unexpected response from the server.| |`network_invalidRequestObject`|Request is not valid. Such an object is not sent to the server.| |`network_signError`|When the signing of the request failed.| @@ -374,4 +374,4 @@ If you need any assistance, do not hesitate to drop us a line at [hello@wultra.c ### Security Disclosure If you believe you have identified a security vulnerability with this SDK, you should report it as soon as possible via email to [support@wultra.com](mailto:support@wultra.com). Please do not post it to a public issue tracker. - \ No newline at end of file + From 06ce00f3fd673b94150a573ea21caea6a93891b6 Mon Sep 17 00:00:00 2001 From: Jan Kobersky Date: Fri, 9 Feb 2024 11:14:48 +0100 Subject: [PATCH 2/5] More fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c2ede6..5c60620 100644 --- a/README.md +++ b/README.md @@ -21,8 +21,8 @@ We use this SDK in our other open-source projects that you can take inspiration - [Open Source Code](#open-source-code) - [Initialization and Configuration](#initialization-and-configuration) - [Endpoint Definition](#endpoint-definition) -- [Creating an HTTP request](#Creating-an-HTTP-request) -- [Raw Response Observer](#Raw-Response-Observer) +- [Creating an HTTP request](#creating-an-http-request) +- [Raw Response Observer](#raw-response-observer) - [Parallel Requests](#parallel-requests) - [SSL validation](#ssl-validation) - [Error Handling](#error-handling) From 9634b4a3f24a53a8e0b7818aebb987af0f7fbeb1 Mon Sep 17 00:00:00 2001 From: Jan Kobersky Date: Fri, 9 Feb 2024 11:16:18 +0100 Subject: [PATCH 3/5] Docs table fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c60620..19bd5e6 100644 --- a/README.md +++ b/README.md @@ -310,7 +310,7 @@ Each `WPNError` has a `reason` property for why the error was created. Such reas |---|---| |`network_unknown`|When unknown (usually logic error) happened during networking.| |`network_generic`|When generic networking error happened.| -|`network_errorStatusCode`|HTTP response code was different than 200 (success).`| +|`network_errorStatusCode`|HTTP response code was different than 200 (success).| |`network_invalidResponseObject`|An unexpected response from the server.| |`network_invalidRequestObject`|Request is not valid. Such an object is not sent to the server.| |`network_signError`|When the signing of the request failed.| From eb5b9624d1ce691e86a6d0ccc25458e837c20221 Mon Sep 17 00:00:00 2001 From: Jan Kobersky Date: Fri, 9 Feb 2024 11:27:35 +0100 Subject: [PATCH 4/5] More docs fixes --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 19bd5e6..dbd8c60 100644 --- a/README.md +++ b/README.md @@ -283,11 +283,11 @@ Possible values are: Every error produced by this library is of a `WPNError` type. This error contains the following information: -- `reason` - A specific reason, why the error happened. For more information see [WPNErrorReason chapter](#wmterrorreason). +- `reason` - A specific reason, why the error happened. For more information see [WPNErrorReason chapter](#wpnerrorreason). - `nestedError` - Original exception/error (if available) that caused this error. - `httpStatusCode` - If the error is a networking error, this property will provide the HTTP status code of the error. - `httpUrlResponse` - If the error is a networking error, this will hold the original HTTP response that was received from the backend. -- `restApiError` - If the error is a "well-known" API error, it will be filled here. For all available codes follow [the source code](https://github.com/wultra/networking-apple/blob/develop/Sources/WultraPowerauthNetworking/WPNBaseNetworkingObjects.swift#L130). +- `restApiError` - If the error is a "well-known" API error, it will be filled here. For all available codes follow [the source code](https://github.com/wultra/networking-apple/blob/develop/Sources/WultraPowerauthNetworking/WPNBaseNetworkingObjects.swift#L130#docucheck-keep-link). - `networkIsNotReachable` - Convenience property, informs about a state where the network is not available (based on the error type). - `networkConnectionIsNotTrusted` - Convenience property, informs about a TLS error. - `powerAuthErrorResponse` - If the error was caused by the PowerAuth error, you can retrieve it here. From eca1859d7d37ce4add2ef321600be918b178bf89 Mon Sep 17 00:00:00 2001 From: Jan Kobersky Date: Fri, 9 Feb 2024 11:29:04 +0100 Subject: [PATCH 5/5] Added #docucheck-keep-link to the code link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dbd8c60..2242863 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ We recommend using Xcode version 15.0 or newer. ## Open Source Code -The code of the library is open source and you can freely browse it in our GitHub at [https://github.com/wultra/networking-apple](https://github.com/wultra/networking-apple/tree/develop) +The code of the library is open source and you can freely browse it in our GitHub at [https://github.com/wultra/networking-apple](https://github.com/wultra/networking-apple/#docucheck-keep-link) ## Initialization and Configuration