Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation fixes #55

Merged
merged 5 commits into from
Feb 9, 2024
Merged

Documentation fixes #55

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
edd6f9c
Docs fixes
kober32 Feb 9, 2024
06ce00f
More fixes
kober32 Feb 9, 2024
9634b4a
Docs table fix
kober32 Feb 9, 2024
eb5b962
More docs fixes
kober32 Feb 9, 2024
eca1859
Added #docucheck-keep-link to the code link
kober32 Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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.|
Expand Down Expand Up @@ -374,4 +374,4 @@ If you need any assistance, do not hesitate to drop us a line at [[email protected]
### 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 [[email protected]](mailto:[email protected]). Please do not post it to a public issue tracker.
<!-- end -->
<!-- end -->
Loading