Skip to content

Commit

Permalink
rename notification and recommendation in the Bulk doc
Browse files Browse the repository at this point in the history
Signed-off-by: Saad Khan <[email protected]>
  • Loading branch information
khansaad committed Nov 15, 2024
1 parent f808cfe commit 5dd63e9
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions design/BulkAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,25 +237,25 @@ resource optimization in Kubernetes environments. Below is a breakdown of the JS

- Each object in the `experiments` array has the following structure:

| Field | Type | Description |
|------------------|----------|-------------------------------------------------------------------------------------|
| `name` | `string` | Name of the experiment, typically indicating a service name and deployment context. |
| `notification` | `object` | Notifications specific to this experiment (if any). |
| `recommendation` | `object` | Recommendation status and notifications specific to this experiment. |
| Field | Type | Description |
|-------------------|----------|-------------------------------------------------------------------------------------|
| `name` | `string` | Name of the experiment, typically indicating a service name and deployment context. |
| `notifications` | `object` | Notifications specific to this experiment (if any). |
| `recommendations` | `object` | Recommendation status and notifications specific to this experiment. |

#### Recommendation Object

The `recommendation` field within each experiment provides information about recommendation processing status and
The `recommendations` field within each experiment provides information about recommendation processing status and
errors (if any).

| Field | Type | Description |
|----------------|----------|--------------------------------------------------------------------------------------------------|
| `status` | `string` | Status of the recommendation (e.g., `"unprocessed"`, `"processed"`, `"processing"`, `"failed"`). |
| `notification` | `object` | Notifications related to recommendation processing. |
| Field | Type | Description |
|-----------------|----------|--------------------------------------------------------------------------------------------------|
| `status` | `string` | Status of the recommendation (e.g., `"unprocessed"`, `"processed"`, `"processing"`, `"failed"`). |
| `notifications` | `object` | Notifications related to recommendation processing. |

#### Notification Object

Both the `notification` and `recommendation.notification` fields may contain error messages or warnings as follows:
Both the `notifications` and `recommendations.notifications` fields may contain error messages or warnings as follows:

| Field | Type | Description |
|-------------------------|--------------|----------------------------------------------------------------------------|
Expand Down

0 comments on commit 5dd63e9

Please sign in to comment.