Skip to content

Commit 906672c

Browse files
[Ruleset Engine] Update description of raw fields (#18021)
--------- Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
1 parent 09196dc commit 906672c

File tree

6 files changed

+112
-55
lines changed

6 files changed

+112
-55
lines changed

src/content/docs/ruleset-engine/rules-language/fields/http-request-body.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Cloudflare Rules language supports these HTTP body fields.
2828

2929
`http.request.body.raw` `String`
3030

31-
Represents the unaltered HTTP request body.
31+
The unaltered HTTP request body.
3232

3333
When the value of `http.request.body.truncated` is true, the return value may be truncated.
3434

@@ -58,7 +58,7 @@ This field may have a value larger than the one returned by `len(http.request.bo
5858

5959
`http.request.body.form` `Map<Array<String>>`
6060

61-
Represents the HTTP request body of a form as a Map (or associative array). Populated when the Content-Type header is `application/x-www-form-urlencoded`.
61+
The HTTP request body of a form represented as a Map (or associative array). Populated when the `Content-Type` header is `application/x-www-form-urlencoded`.
6262

6363
The values are not pre-processed and retain the original case used in the request.
6464

@@ -83,9 +83,9 @@ Example value:
8383

8484
`http.request.body.form.names` `Array<String>`
8585

86-
Represents the names of the form fields in an HTTP request where the content type is `application/x-www-form-urlencoded`.
86+
The names of the form fields in an HTTP request where the content type is `application/x-www-form-urlencoded`.
8787

88-
The names are not pre-processed and retain the original case used in the request. They are listed in the same order as in the request.
88+
Names are not pre-processed and retain the original case used in the request. They are listed in the same order as in the request.
8989

9090
Duplicate names are listed multiple times.
9191

@@ -109,7 +109,7 @@ Example value:
109109

110110
`http.request.body.form.values` `Array<String>`
111111

112-
Represents the values of the form fields in an HTTP request where the content type is `application/x-www-form-urlencoded`.
112+
The values of the form fields in an HTTP request where the content type is `application/x-www-form-urlencoded`.
113113

114114
The values are not pre-processed and retain the original case used in the request. They are listed in the same order as in the request.
115115

@@ -149,7 +149,7 @@ This field is available on all Cloudflare plans.
149149

150150
`http.request.body.multipart` `Map<Array<String>>`
151151

152-
A Map (or associative array) of multipart names to multipart values in the request body.
152+
A Map (or associative array) representation of multipart names to multipart values in the request body.
153153

154154
Example value:
155155

src/content/docs/ruleset-engine/rules-language/fields/http-request-header.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Cloudflare Rules language supports these HTTP header fields.
1616

1717
`http.request.headers` `Map<Array<String>>`
1818

19-
Represents HTTP request headers as a Map (or associative array).
19+
The HTTP request headers represented as a Map (or associative array).
2020

2121
The keys of the associative array are the names of HTTP request headers converted to lowercase.
2222

@@ -44,7 +44,7 @@ Example value:
4444

4545
`http.request.headers.names` `Array<String>`
4646

47-
Represents the names of the headers in the HTTP request.
47+
The names of the headers in the HTTP request.
4848

4949
The names are not pre-processed and retain the original case used in the request.
5050

@@ -72,7 +72,7 @@ Example value: `["content-type"]`
7272

7373
`http.request.headers.values` `Array<String>`
7474

75-
Represents the values of the headers in the HTTP request.
75+
The values of the headers in the HTTP request.
7676

7777
The values are not pre-processed and retain the original case used in the request.
7878

@@ -122,7 +122,7 @@ When `true`, `http.request.headers`, `http.request.headers.names`, and `http.req
122122

123123
`http.request.accepted_languages` `Array<String>`
124124

125-
Represents the list of language tags provided in the [`Accept-Language`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) HTTP request header, sorted by weight (`;q=<weight>`, with a default weight of `1`) in descending order.
125+
List of language tags provided in the [`Accept-Language`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language) HTTP request header, sorted by weight (`;q=<weight>`, with a default weight of `1`) in descending order.
126126

127127
If the HTTP header is not present in the request or is empty, `http.request.accepted_languages[0]` will return a "[missing value](/ruleset-engine/rules-language/values/#notes)", which the `concat()` function will handle as an empty string.
128128

src/content/docs/ruleset-engine/rules-language/fields/http-request-response.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Cloudflare Rules language supports these HTTP response fields.
1616

1717
`http.response.code` `Integer`
1818

19-
Represents the HTTP status code returned to the client, either set by a Cloudflare product or returned by the origin server.
19+
The HTTP status code returned to the client, either set by a Cloudflare product or returned by the origin server.
2020

2121
Example value:
2222
`403`
@@ -25,7 +25,7 @@ Example value:
2525

2626
`http.response.headers` `Map<Array<String>>`
2727

28-
Represents HTTP response headers as a Map (or associative array).
28+
The HTTP response headers represented as a Map (or associative array).
2929

3030
When there are repeating headers, the array includes them in the order they appear in the response. The keys convert to lowercase.
3131

@@ -47,7 +47,7 @@ Example value:
4747

4848
## `http.response.headers.names`
4949

50-
Represents the names of the headers in the HTTP response. The names are not pre-processed and retain the original case used in the response.
50+
The names of the headers in the HTTP response. The names are not pre-processed and retain the original case used in the response.
5151

5252
The order of header names is not guaranteed but will match `http.response.headers.values`.
5353

@@ -67,7 +67,7 @@ Example value: `["content-type"]`
6767

6868
## `http.response.headers.values`
6969

70-
Represents the values of the headers in the HTTP response.
70+
The values of the headers in the HTTP response.
7171

7272
The values are not pre-processed and retain the original case used in the response.
7373

@@ -155,7 +155,7 @@ Note: This field is only available in [HTTP response header modifications](/rule
155155

156156
`cf.response.error_type` `String`
157157

158-
Contains a string with the type of error in the response being returned. The default value is an empty string (`""`).
158+
A string with the type of error in the response being returned. The default value is an empty string (`""`).
159159

160160
The available values are the following:
161161

0 commit comments

Comments
 (0)