Skip to content

Commit

Permalink
Adds description for name field (#18857)
Browse files Browse the repository at this point in the history
  • Loading branch information
angelampcosta authored Dec 19, 2024
1 parent a45ff79 commit 145455a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/content/docs/logs/get-started/api-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ The `{dataset_id}` argument indicates the log category (such as `http_requests`
| `GET` | Retrieve all jobs for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/jobs/methods/get/) |
| `GET` | Retrieve all available fields for a dataset | [Documentation](/api/resources/logpush/subresources/datasets/subresources/fields/methods/get/) |
| `PUT` | Update job | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
| `PUT` | Update job name. | [Documentation](/api/resources/logpush/subresources/jobs/methods/update/) |
| `DELETE` | Delete job | [Documentation](/api/resources/logpush/subresources/jobs/methods/delete/) |
| `POST` | Check whether destination exists | [Documentation](/api/resources/logpush/subresources/validate/methods/destination/) |
| `POST` | Get ownership challenge | [Documentation](/api/resources/logpush/subresources/ownership/methods/validate/) |
Expand Down Expand Up @@ -169,6 +168,10 @@ Response

:::

## Name

A human-readable, optional job name that does not need to be unique. We recommend choosing a meaningful name, such as the domain name, to help you easily identify and manage your job. You can update the name later if needed.

## Kind

The kind parameter (optional) is used to differentiate between Logpush and Edge Log Delivery jobs. For Logpush jobs, this parameter can be left empty or omitted. For Edge Log Delivery jobs, set `"kind": "edge"`. Currently, Edge Log Delivery is only supported for the `http_requests` dataset.
Expand Down

0 comments on commit 145455a

Please sign in to comment.