Skip to content

Commit a35c754

Browse files
pedrosousathomasgauvin
pedrosousa
authored and
thomasgauvin
committed
[Ruleset Engine] Move tables to lists (#23914)
1 parent b036dd5 commit a35c754

File tree

7 files changed

+62
-96
lines changed

7 files changed

+62
-96
lines changed

‎src/content/docs/ruleset-engine/rulesets-api/add-rule.mdx‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ Adds a single rule to an existing ruleset. Use this endpoint to add a rule witho
1212

1313
Use one of the following API endpoints:
1414

15-
| Operation | Method + Endpoint |
16-
| -------------------------------------------- | --------------------------------------------------------- |
17-
| [Create an account ruleset rule][ar-account] | `POST /accounts/{account_id}/rulesets/{ruleset_id}/rules` |
18-
| [Create a zone ruleset rule][ar-zone] | `POST /zones/{zone_id}/rulesets/{ruleset_id}/rules` |
19-
20-
[ar-account]: /api/resources/rulesets/subresources/rules/methods/create/
21-
[ar-zone]: /api/resources/rulesets/subresources/rules/methods/create/
15+
- [Create an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/create/)<br/>
16+
`POST /accounts/{account_id}/rulesets/{ruleset_id}/rules`
17+
- [Create a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/create/)<br/>
18+
`POST /zones/{zone_id}/rulesets/{ruleset_id}/rules`
2219

2320
Include the rule definition in the request body.
2421

‎src/content/docs/ruleset-engine/rulesets-api/create.mdx‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ Creates a ruleset of a given kind in the specified phase. Allows you to create p
1212

1313
Use one of the following API endpoints:
1414

15-
| Operation | Method + Endpoint |
16-
| --------------------------------------- | -------------------------------------- |
17-
| [Create an account ruleset][cr-account] | `POST /accounts/{account_id}/rulesets` |
18-
| [Create a zone ruleset][cr-zone] | `POST /zones/{zone_id}/rulesets` |
19-
20-
[cr-account]: /api/resources/rulesets/methods/create/
21-
[cr-zone]: /api/resources/rulesets/methods/create/
15+
- [Create an account ruleset](/api/resources/rulesets/methods/create/)<br/>
16+
`POST /accounts/{account_id}/rulesets`
17+
- [Create a zone ruleset](/api/resources/rulesets/methods/create/)<br/>
18+
`POST /zones/{zone_id}/rulesets`
2219

2320
The following parameters are required:
2421

‎src/content/docs/ruleset-engine/rulesets-api/delete-rule.mdx‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ Deletes a single rule in a ruleset at the account or zone level.
1212

1313
Use one of the following API endpoints:
1414

15-
| Operation | Method + Endpoint |
16-
| -------------------------------------------- | --------------------------------------------------------------------- |
17-
| [Delete an account ruleset rule][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
18-
| [Delete a zone ruleset rule][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
19-
20-
[dr-account]: /api/resources/rulesets/subresources/rules/methods/delete/
21-
[dr-zone]: /api/resources/rulesets/methods/delete/
15+
- [Delete an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/delete/)<br/>
16+
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}`
17+
- [Delete a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/delete/)<br/>
18+
`DELETE /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}`
2219

2320
If the delete operation succeeds, the API method call returns a `200 OK` HTTP status code with the complete ruleset in the response body.
2421

‎src/content/docs/ruleset-engine/rulesets-api/delete.mdx‎

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,10 @@ Deletes all the versions of an existing ruleset at the account or zone level.
1919

2020
Use one of the following API endpoints:
2121

22-
| Operation | Method + Endpoint |
23-
| --------------------------------------- | ----------------------------------------------------- |
24-
| [Delete an account ruleset][dr-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}` |
25-
| [Delete a zone ruleset][dr-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}` |
26-
27-
[dr-account]: /api/resources/rulesets/methods/delete/
28-
[dr-zone]: /api/resources/rulesets/methods/delete/
22+
- [Delete an account ruleset](/api/resources/rulesets/methods/delete/)<br/>
23+
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}`
24+
- [Delete a zone ruleset](/api/resources/rulesets/methods/delete/)<br/>
25+
`DELETE /zones/{zone_id}/rulesets/{ruleset_id}`
2926

3027
If the delete operation succeeds, the API method call returns a `204 No Content` HTTP status code.
3128

@@ -52,13 +49,10 @@ Deletes a specific version of a ruleset.
5249

5350
Use one of the following API endpoints:
5451

55-
| Operation | Method + Endpoint |
56-
| ------------------------------------------------ | ------------------------------------------------------------------------------- |
57-
| [Delete an account ruleset version][drv-account] | `DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` |
58-
| [Delete a zone ruleset version][drv-zone] | `DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}` |
59-
60-
[drv-account]: /api/resources/rulesets/subresources/versions/methods/delete/
61-
[drv-zone]: /api/resources/rulesets/subresources/versions/methods/delete/
52+
- [Delete an account ruleset version](/api/resources/rulesets/subresources/versions/methods/delete/)<br/>
53+
`DELETE /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}`
54+
- [Delete a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/delete/)<br/>
55+
`DELETE /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}`
6256

6357
If the delete operation succeeds, the method call returns a `204 No Content` HTTP status code.
6458

‎src/content/docs/ruleset-engine/rulesets-api/update-rule.mdx‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,10 @@ Applies one or more changes to an existing rule in a ruleset at the account or z
1212

1313
Use one of the following API endpoints:
1414

15-
| Operation | Method + Endpoint |
16-
| -------------------------------------------- | -------------------------------------------------------------------- |
17-
| [Update an account ruleset rule][ur-account] | `PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
18-
| [Update a zone ruleset rule][ur-zone] | `PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}` |
19-
20-
[ur-account]: /api/resources/rulesets/subresources/rules/methods/edit/
21-
[ur-zone]: /api/resources/rulesets/methods/update/
15+
- [Update an account ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/)<br/>
16+
`PATCH /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}`
17+
- [Update a zone ruleset rule](/api/resources/rulesets/subresources/rules/methods/edit/)<br/>
18+
`PATCH /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}`
2219

2320
You can update the definition of the rule, changing its fields, or change the order of the rule in the ruleset. Invoking this method creates a new version of the ruleset.
2421

‎src/content/docs/ruleset-engine/rulesets-api/update.mdx‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,14 @@ You can use the API to update:
1515

1616
Use one of the following API endpoints:
1717

18-
| Operation | Method + Endpoint |
19-
| ---------------------------------------------------- | -------------------------------------------------------------------- |
20-
| [Update an account ruleset][ur-account] | `PUT /accounts/{account_id}/rulesets/{ruleset_id}` |
21-
| [Update a zone ruleset][ur-zone] | `PUT /zones/{zone_id}/rulesets/{ruleset_id}` |
22-
| [Update an account entry point ruleset][uep-account] | `PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` |
23-
| [Update a zone entry point ruleset][uep-zone] | `PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` |
24-
25-
[ur-account]: /api/resources/rulesets/methods/update/
26-
[ur-zone]: /api/resources/rulesets/methods/update/
27-
[uep-account]: /api/resources/rulesets/subresources/phases/methods/update/
28-
[uep-zone]: /api/resources/rulesets/subresources/phases/methods/update/
18+
- [Update an account ruleset](/api/resources/rulesets/methods/update/)<br/>
19+
`PUT /accounts/{account_id}/rulesets/{ruleset_id}`
20+
- [Update an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)<br/>
21+
`PUT /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint`
22+
- [Update a zone ruleset](/api/resources/rulesets/methods/update/)<br/>
23+
`PUT /zones/{zone_id}/rulesets/{ruleset_id}`
24+
- [Update a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/update/)<br/>
25+
`PUT /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint`
2926

3027
:::note
3128
You cannot update the name of the ruleset or its type. Do not include these fields in the `data` field of your `PUT` request.

‎src/content/docs/ruleset-engine/rulesets-api/view.mdx‎

Lines changed: 30 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,10 @@ Returns the list of existing rulesets at the account level or at the zone level.
2020

2121
Use one of the following API endpoints:
2222

23-
| Operation | Method + Endpoint |
24-
| ----------------------------------- | ------------------------------------- |
25-
| [List account rulesets][lr-account] | `GET /accounts/{account_id}/rulesets` |
26-
| [List zone rulesets][lr-zone] | `GET /zones/{zone_id}/rulesets` |
27-
28-
[lr-account]: /api/resources/rulesets/methods/list/
29-
[lr-zone]: /api/resources/rulesets/methods/list/
23+
- [List account rulesets](/api/resources/rulesets/methods/list/)<br/>
24+
`GET /accounts/{account_id}/rulesets`
25+
- [List zone rulesets](/api/resources/rulesets/methods/list/)<br/>
26+
`GET /zones/{zone_id}/rulesets`
3027

3128
The result includes rulesets across all phases at a given level (account or zone). The `phase` field in each result element indicates the [phase](/ruleset-engine/about/phases/) where that ruleset is defined.
3229

@@ -67,17 +64,14 @@ Returns the properties of the most recent version of the ruleset with the specif
6764

6865
Use one of the following API endpoints:
6966

70-
| Operation | Method + Endpoint |
71-
| ------------------------------------------------- | -------------------------------------------------------------------- |
72-
| [Get an account ruleset][gr-account] | `GET /accounts/{account_id}/rulesets/{ruleset_id}` |
73-
| [Get a zone ruleset][gr-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}` |
74-
| [Get an account entry point ruleset][gep-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint` |
75-
| [Get a zone entry point ruleset][gep-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint` |
76-
77-
[gr-account]: /api/resources/rulesets/methods/get/
78-
[gr-zone]: /api/resources/rulesets/methods/get/
79-
[gep-account]: /api/resources/rulesets/subresources/phases/methods/get/
80-
[gep-zone]: /api/resources/rulesets/subresources/phases/methods/get/
67+
- [Get an account ruleset](/api/resources/rulesets/methods/get/)<br/>
68+
`GET /accounts/{account_id}/rulesets/{ruleset_id}`
69+
- [Get an account entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)<br/>
70+
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint`
71+
- [Get a zone ruleset](/api/resources/rulesets/methods/get/)<br/>
72+
`GET /zones/{zone_id}/rulesets/{ruleset_id}`
73+
- [Get a zone entry point ruleset](/api/resources/rulesets/subresources/phases/methods/get/)<br/>
74+
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint`
8175

8276
:::note
8377
You can only use the _Get a zone ruleset_ operation for zone-level phase entry points (entry points where `kind` is set to `zone`).
@@ -127,17 +121,14 @@ Returns a list of all the versions of a ruleset.
127121

128122
Use one of the following API endpoints:
129123

130-
| Operation | Method + Endpoint |
131-
| -------------------------------------------------------- | ----------------------------------------------------------------------------- |
132-
| [List account ruleset versions][lv-account] | `GET /accounts/{account_id}/rulesets/{ruleset_id}/versions` |
133-
| [List zone ruleset versions][lv-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}/versions` |
134-
| [List account entry point ruleset versions][lev-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions` |
135-
| [List zone entry point ruleset versions][lev-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions` |
136-
137-
[lv-account]: /api/resources/rulesets/subresources/versions/methods/list/
138-
[lv-zone]: /api/resources/rulesets/subresources/versions/methods/list/
139-
[lev-account]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/
140-
[lev-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/list/
124+
- [List account ruleset versions](/api/resources/rulesets/subresources/versions/methods/list/)<br/>
125+
`GET /accounts/{account_id}/rulesets/{ruleset_id}/versions`
126+
- [List account entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)<br/>
127+
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions`
128+
- [List zone ruleset versions](/api/resources/rulesets/subresources/versions/methods/list/)<br/>
129+
`GET /zones/{zone_id}/rulesets/{ruleset_id}/versions`
130+
- [List zone entry point ruleset versions](/api/resources/rulesets/subresources/phases/subresources/versions/methods/list/)<br/>
131+
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions`
141132

142133
The result contains the ruleset properties of each version, but it does not include the list of rules. Refer to [View a specific version of a ruleset](#view-a-specific-version-of-a-ruleset) for instructions on obtaining this information.
143134

@@ -184,17 +175,14 @@ Returns the configuration of a specific version of a ruleset, including its rule
184175

185176
Use one of the following API endpoints:
186177

187-
| Operation | Method + Endpoint |
188-
| ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
189-
| [Get an account ruleset version][grv-account] | `GET /account/{account_id}/rulesets/{ruleset_id}/versions/{version_number}` |
190-
| [Get a zone ruleset version][grv-zone] | `GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}` |
191-
| [Get an account entry point ruleset version][gerv-account] | `GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` |
192-
| [Get a zone entry point ruleset version][gerv-zone] | `GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}` |
193-
194-
[grv-account]: /api/resources/rulesets/subresources/versions/methods/get/
195-
[grv-zone]: /api/resources/rulesets/subresources/versions/methods/get/
196-
[gerv-account]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/get/
197-
[gerv-zone]: /api/resources/rulesets/subresources/phases/subresources/versions/methods/get/
178+
- [Get an account ruleset version](/api/resources/rulesets/subresources/versions/methods/get/)<br/>
179+
`GET /account/{account_id}/rulesets/{ruleset_id}/versions/{version_number}`
180+
- [Get an account entry point ruleset version](/api/resources/rulesets/subresources/phases/subresources/versions/methods/get/)<br/>
181+
`GET /accounts/{account_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}`
182+
- [Get a zone ruleset version](/api/resources/rulesets/subresources/versions/methods/get/)<br/>
183+
`GET /zones/{zone_id}/rulesets/{ruleset_id}/versions/{version_number}`
184+
- [Get a zone entry point ruleset version](/api/resources/rulesets/subresources/phases/subresources/versions/methods/get/)<br/>
185+
`GET /zones/{zone_id}/rulesets/phases/{phase_name}/entrypoint/versions/{version_number}`
198186

199187
When the specified phase entry point ruleset does not exist, this API method returns a `404 Not Found` HTTP status code.
200188

@@ -242,9 +230,8 @@ When you view a specific version of a managed ruleset, each rule listed in the r
242230

243231
Returns a list of all the rules in a managed ruleset with a specific tag.
244232

245-
| Operation | Method + Endpoint |
246-
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
247-
| List rules in account ruleset version by tag | `GET /accounts/{account_id}/rulesets/{managed_ruleset_id}/versions/{version_number}/by_tag/{tag_name}` |
233+
- List an account ruleset version's rules by tag<br/>
234+
`GET /accounts/{account_id}/rulesets/{ruleset_id}/versions/{version_number}/by_tag/{tag_name}`
248235

249236
### Example
250237

0 commit comments

Comments
 (0)