Skip to content

[Rules] Update list of Snippets API endpoints #17847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 29, 2024
Merged

[Rules] Update list of Snippets API endpoints #17847

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions src/content/docs/rules/snippets/create-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,16 @@ The `{zone_id}` argument is the [zone ID](/fundamentals/setup/find-account-and-z

The following table summarizes the available operations.

| Operation | Verb + Endpoint |
| ------------------------------------------ | ------------------------------------------------------ |
| List all code snippets | `GET /zones/{zone_id}/snippets` |
| Create/update code snippet | `PUT /zones/{zone_id}/snippets/{snippet_name}` |
| Delete code snippet | `DELETE /zones/{zone_id}/snippets/{snippet_name}` |
| List snippet rules | `GET /zones/{zone_id}/snippets/snippet_rules` |
| Create/update/delete snippet rules | `PUT /zones/{zone_id}/snippets/snippet_rules` |
| Operation | Verb + Endpoint |
| ---------------------------------- | ------------------------------------------------------ |
| List all code snippets | `GET /zones/{zone_id}/snippets` |
| Create/update code snippet | `PUT /zones/{zone_id}/snippets/{snippet_name}` |
| Get code snippet details | `GET /zones/{zone_id}/snippets/{snippet_name}` |
| Get code snippet content | `GET /zones/{zone_id}/snippets/{snippet_name}/content` |
| Delete code snippet | `DELETE /zones/{zone_id}/snippets/{snippet_name}` |
| List snippet rules | `GET /zones/{zone_id}/snippets/snippet_rules` |
| Create/update/delete snippet rules | `PUT /zones/{zone_id}/snippets/snippet_rules` |
| Delete all snippet rules | `DELETE /zones/{zone_id}/snippets/snippet_rules` |

## Example API calls

Expand All @@ -63,14 +66,14 @@ To make this example work, save your JavaScript code in a file named `example.js

```json title="Example response"
{
"errors": [],
"messages": [],
"success": true,
"result": {
"created_on": "2023-07-24-00:00:00",
"modified_on": "2023-07-24-00:00:00",
"snippet_name": "snippet_name_01"
}
"errors": [],
"messages": [],
"success": true,
"result": {
"created_on": "2023-07-24-00:00:00",
"modified_on": "2023-07-24-00:00:00",
"snippet_name": "snippet_name_01"
}
}
```

Expand All @@ -97,4 +100,4 @@ curl --request PUT \
}
]
}'
```
```
Loading