Skip to content

Commit 3806f5e

Browse files
committed
Update RFC links
1 parent 397e5bc commit 3806f5e

File tree

3 files changed

+23
-23
lines changed

3 files changed

+23
-23
lines changed

docs/api/rest_api_authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ you can get the JWT token through the following request:
353353

354354
## HTTP basic authentication
355355

356-
For more information, see [HTTP Authentication: Basic and Digest Access Authentication](http://tools.ietf.org/html/rfc2617).
356+
For more information, see [HTTP Authentication: Basic and Digest Access Authentication](https://datatracker.ietf.org/doc/html/rfc2617).
357357

358358
### Configuration
359359

@@ -381,7 +381,7 @@ If the installation has a dedicated host for REST, you can enable HTTP basic aut
381381
### Usage example
382382

383383
Basic authentication requires the username and password to be sent *(username:password)*, base64 encoded, with each request.
384-
For details, see [RFC 2617](http://tools.ietf.org/html/rfc2617).
384+
For details, see [RFC 2617](https://datatracker.ietf.org/doc/html/rfc2617).
385385

386386
Most HTTP client libraries as well as REST libraries support this method.
387387
[Creating content with binary attachments](rest_api_requests.md#creating-content-with-binary-attachments) has an example using basic authentication with [cURL](https://www.php.net/manual/en/book.curl.php) and its `CURLOPT_USERPWD`.

docs/api/rest_api_requests.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,18 @@ Depending on the HTTP method used, different actions will be possible on the sam
2020
The following list of available methods gives an overview of the kind of action a method triggers on a resource, if available.
2121
For method action details per resource, see the [REST API reference](rest_api_reference/rest_api_reference.html).
2222

23-
| HTTP method | Status | Description | Safe |
24-
|------------------------------------------------------------|----------|------------------------|------|
25-
| [OPTIONS](https://tools.ietf.org/html/rfc2616#section-9.2) | Standard | List available methods | Yes |
26-
| [GET](https://tools.ietf.org/html/rfc2616#section-9.3) | Standard | Collect data | Yes |
27-
| [HEAD](https://tools.ietf.org/html/rfc2616#section-9.4) | Standard | Check existence | Yes |
28-
| [POST](https://tools.ietf.org/html/rfc2616#section-9.5) | Standard | Create an item | No |
29-
| [PATCH](http://tools.ietf.org/html/rfc5789) | Custom | Update an item | No |
30-
| COPY | Custom | Duplicate an item | No |
31-
| [MOVE](http://tools.ietf.org/html/rfc2518) | Custom | Move an item | No |
32-
| SWAP | Custom | Swap two Locations | No |
33-
| PUBLISH | Custom | Publish an item | No |
34-
| [DELETE](https://tools.ietf.org/html/rfc2616#section-9.7) | Standard | Remove an item | No |
23+
| HTTP method | Status | Description | Safe |
24+
|---------------------------------------------------------------------|----------|------------------------|------|
25+
| [OPTIONS](https://datatracker.ietf.org/doc/html/rfc2616#section-9.2) | Standard | List available methods | Yes |
26+
| [GET](https://datatracker.ietf.org/doc/html/rfc2616#section-9.3) | Standard | Collect data | Yes |
27+
| [HEAD](https://datatracker.ietf.org/doc/html/rfc2616#section-9.4) | Standard | Check existence | Yes |
28+
| [POST](https://datatracker.ietf.org/doc/html/rfc2616#section-9.5) | Standard | Create an item | No |
29+
| [PATCH](https://datatracker.ietf.org/doc/html/rfc5789) | Custom | Update an item | No |
30+
| COPY | Custom | Duplicate an item | No |
31+
| [MOVE](https://datatracker.ietf.org/doc/html/rfc2518) | Custom | Move an item | No |
32+
| SWAP | Custom | Swap two Locations | No |
33+
| PUBLISH | Custom | Publish an item | No |
34+
| [DELETE](https://datatracker.ietf.org/doc/html/rfc2616#section-9.7) | Standard | Remove an item | No |
3535

3636
!!! note "Caution with custom HTTP methods"
3737

@@ -47,7 +47,7 @@ Unsafe methods will require a CSRF token if [session-based authentication](rest_
4747

4848
Any URI resource that the REST API responds to will respond to an `OPTIONS` request.
4949

50-
The response contains an [`Allow` header](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.7), which lists the methods accepted by the resource.
50+
The response contains an [`Allow` header](https://www.rfc-editor.org/rfc/rfc9110.html#name-allow), which lists the methods accepted by the resource.
5151

5252
```shell
5353
curl -IX OPTIONS https://api.example.com/api/ezp/v2/content/objects/1
@@ -81,8 +81,8 @@ Allow: GET,PATCH,DELETE,COPY,MOVE,SWAP
8181

8282
You can use the following HTTP headers with a REST request:
8383

84-
- [`Accept`](https://tools.ietf.org/html/rfc2616#section-14.1) describing the desired response type and format;
85-
- [`Content-Type`](https://toos.ietf.org/html/rfc2616#section-14.17) describing the payload type and format;
84+
- [`Accept`](https://datatracker.ietf.org/doc/html/rfc2616#section-14.1) describing the desired response type and format;
85+
- [`Content-Type`](https://datatracker.ietf.org/doc/html/rfc2616#section-14.17) describing the payload type and format;
8686
- [`X-Siteaccess`](#siteaccess) specifying the target SiteAccess;
8787
- `X-HTTP-Method-Override` allowing to pass a custom method while using `POST` method as previously seen in [HTTP method](#request-method).
8888
- [`Destination`](#destination) specifying where to move an item
@@ -114,8 +114,8 @@ On top of methods, HTTP request headers allow you to personalize the request's b
114114
On every resource, you can use the `Accept` header to indicate which format you want to communicate in, JSON or XML.
115115
This header is also used to specify the response type you want the server to send when multiple types are available.
116116

117-
- `Accept: application/vnd.ez.api.Content+xml` to get `Content` (full data, Fields included) as **[XML](http://www.w3.org/XML/)**
118-
- `Accept: application/vnd.ez.api.ContentInfo+json` to get `ContentInfo` (metadata only) as **[JSON](http://www.json.org/)**
117+
- `Accept: application/vnd.ez.api.Content+xml` to get `Content` (full data, Fields included) as **[XML](https://www.w3.org/XML/)**
118+
- `Accept: application/vnd.ez.api.ContentInfo+json` to get `ContentInfo` (metadata only) as **[JSON](https://www.json.org/)**
119119

120120
Media types are also used with the [`Content-Type` header](rest_api_responses.md#content-type-header) to characterize a [request body](#request-body) or a [response body](rest_api_responses.md#response-body).
121121
See [Creating content with binary attachments](#creating-content-with-binary-attachments) below.
@@ -142,11 +142,11 @@ You can pass some short scalar parameters in the URIs or as GET parameters, but
142142
in particular the ones to create (`POST`) or update (`PATCH`) items.
143143
In the [REST API reference](rest_api_reference/rest_api_reference.html), request payload examples are given when needed.
144144

145-
One example is the [creation of an authentication session](rest_api_authentication.md#establishing-a-session).
145+
One example is the [creation of an authentication session](rest_api_authentication.md#establishing-session).
146146

147147
When creating a Content item, a special payload is needed if the ContentType has some [Image](field_types_reference/imagefield.md) or [BinaryFile](field_types_reference/binaryfilefield.md) Fields as files need to be attached. See the example of a [script uploading images](#creating-content-with-binary-attachments) below.
148148

149-
When searching for Content items (or Locations), the query grammar is also particular. See the [Search section](#search-view) below.
149+
When searching for Content items (or Locations), the query grammar is also particular. See the [Search section](#search-views) below.
150150

151151
### Creating content with binary attachments
152152

docs/guide/personalization/developer_guide/recommendation_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For the request to return recommendations, you must provide the following parame
4040
### Customizing the recommendation request
4141

4242
You can customize the recommendation request by using additional query string parameters.
43-
For example, you can send the following request to the recommendation engine: 
43+
For example, you can send the following request to the recommendation engine:
4444

4545
`GET https://reco.yoochoose.net/api/v2/00000/john.doe/landing_page.json ?contextitems=123&categorypath=%2FCamera%2FCompact&attribute=title&attribute=deeplink,description&numrecs=8`
4646

@@ -258,7 +258,7 @@ Error messages can change, do not use them for automated processing.
258258

259259
In most cases the recommendation engine's response can be cached.
260260
Depending on the recommendation model and context, it can drastically reduce the number of recommendation requests.
261-
The recommendation service supports the following HTTP headers to enable cache control on the client side (all date values must follow the "HTTP-date" format as defined by [RFC 2616](https://tools.ietf.org/html/rfc2616)):
261+
The recommendation service supports the following HTTP headers to enable cache control on the client side (all date values must follow the "HTTP-date" format as defined by [RFC 2616](https://datatracker.ietf.org/doc/html/rfc2616)):
262262

263263
|Scope|Header|Description|Example|
264264
|---|---|---|---|

0 commit comments

Comments
 (0)