Skip to content

Commit 0666e56

Browse files
committed
docs: align naming of http client
1 parent 1ad9cee commit 0666e56

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

16/umbraco-cms/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@
185185
* [Foundation](customizing/foundation/README.md)
186186
* [Fetching Data](customizing/foundation/fetching-data/README.md)
187187
* [Fetch API](customizing/foundation/fetching-data/fetch-api.md)
188-
* [HTTP Client](customizing/foundation/fetching-data/http-client.md)
188+
* [Umbraco HTTP Client](customizing/foundation/fetching-data/http-client.md)
189189
* [Executing Requests](customizing/foundation/fetching-data/try-execute.md)
190190
* [Custom Generated Client](customizing/foundation/fetching-data/custom-generated-client.md)
191191
* [Working with Data](customizing/foundation/working-with-data/README.md)

16/umbraco-cms/customizing/foundation/fetching-data/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Once you have decided which option to use, you can read more about how to use it
3333

3434
The Fetch API is a modern way to make network requests in JavaScript. It provides a more powerful and flexible feature set than the older XMLHttpRequest.
3535

36-
### [HTTP Client](http-client.md)
36+
### [Umbraco HTTP Client](http-client.md)
3737

38-
The HTTP Client is a wrapper around the Fetch API that provides a more convenient way to make network requests. It handles things like request and response parsing, error handling, and retries.
38+
The Umbraco HTTP Client is a wrapper around the Fetch API that provides a more convenient way to make network requests. It handles things like request and response parsing, error handling, and retries.
3939

4040
## Handle Requests
4141

16/umbraco-cms/customizing/foundation/fetching-data/http-client.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Learn more about working with the HTTP Client in Umbraco.
2+
description: Learn more about working with the Umbraco HTTP Client.
33
---
44

55
# HTTP Client
@@ -20,13 +20,13 @@ if (data) {
2020
}
2121
```
2222

23-
The above example shows how to use the HTTP client to make a GET request to the Management API. The `umbHttpClient` object provides methods for making requests, including `get`, `post`, `put`, and `delete`. Each method takes an options object that specifies the URL, headers, and body of the request.
23+
The above example shows how to use the Umbraco HTTP client to make a GET request to the Management API. The `umbHttpClient` object provides methods for making requests, including `get`, `post`, `put`, and `delete`. Each method takes an options object that specifies the URL, headers, and body of the request.
2424

25-
The HTTP client automatically handles authentication and error handling, so you don't have to worry about those details. It also provides a convenient way to parse the response data as JSON.
25+
The Umbraco HTTP client automatically handles authentication and error handling, so you don't have to worry about those details. It also provides a convenient way to parse the response data as JSON.
2626

27-
## Using the HTTP Client
27+
## Using the Umbraco HTTP Client
2828

29-
The HTTP client is a wrapper around the Fetch API that provides a more convenient way to make network requests. It handles things like request and response parsing, error handling, and retries. The HTTP client is available through the `@umbraco-cms/backoffice/http-client` package, which is included in the Umbraco Backoffice. You can use it to make requests to any endpoint in the Management API or to any other API.
29+
The Umbraco HTTP client is a wrapper around the Fetch API that provides a more convenient way to make network requests. It handles things like request and response parsing, error handling, and retries. The Umbraco HTTP client is available through the `@umbraco-cms/backoffice/http-client` package, which is included in the Umbraco Backoffice. You can use it to make requests to any endpoint in the Management API or to any other API.
3030

3131
The recommended approach to use the Umbraco HTTP Client is to use the `tryExecute` function. This function will handle any errors that occur during the request and will automatically refresh the token if it is expired. If the session is expired, the function will also make sure the user logs in again.
3232

16/umbraco-cms/customizing/foundation/fetching-data/try-execute.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When you make a request to the server, you need to execute it. This can be done
1010
You can read the technical documentation for the `tryExecute` function in the [UI API Documentation](https://apidocs.umbraco.com/v16/ui-api/functions/packages_core_resources.tryExecute.html) class.
1111
{% endhint %}
1212

13-
## Using the HTTP Client
13+
## Using the Umbraco HTTP Client
1414

1515
Here is an example of how to use the `tryExecute` function with the Umbraco HTTP client:
1616

0 commit comments

Comments
 (0)