Skip to content

Commit b1761b5

Browse files
committed
Update documentation.
1 parent 42211b6 commit b1761b5

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/NETWORKING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ At the moment, we provide four implementations of `URLRequestConvertible`:
4545
* [`JetpackRequest`](../Networking/Networking/Requests/JetpackRequest.swift) represents a Jetpack-Tunneled WordPress.com
4646
* [`AuthenticatedRequest`](../Networking/Networking/Requests/AuthenticatedRequest.swift) Wraps up a `URLRequestConvertible` instance, and injects credentials (username and token) when required
4747
* [`WordPressOrgRequest`](../Networking/Networking/Requests/WordPressOrgRequest.swift) model requests to the WordPress.org REST API.
48+
* [`UnauthenticatedRequest`](../Networking/Networking/Requests/UnauthenticatedRequest.swift) Wraps up a `URLRequestConvertible` instance, and injects a custom user-agent header
4849

4950
## [`Mapper`](../Networking/Networking/Mapper/Mapper.swift)
5051
A protocol that abstracts the different parsers.

docs/architecture-overview.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,10 +171,12 @@ of performing this task for us:
171171

172172
3. **AuthenticatedRequest**
173173

174-
Injects a set of Credentials into anything that conforms to the URLConvertible protocol. Usually wraps up
174+
Injects a set of Credentials and a custom user-agent header into anything that conforms to the URLConvertible protocol. Usually wraps up
175175
a DotcomRequest (OR) JetpackRequest.
176176

177+
4. **UnauthenticatedRequest**
177178

179+
Wraps up a `URLConvertible` with a custom user-agent header. Used when the request does not require WordPress.com authentication.
178180

179181
### Remote Endpoints
180182

0 commit comments

Comments
 (0)