Skip to content

Commit

Permalink
Merge pull request #8569 from hashicorp/d/update-scale-request-params
Browse files Browse the repository at this point in the history
Docs: Update Reason to Message in the job scale docs
  • Loading branch information
DingoEatingFuzz committed Jul 30, 2020
2 parents 71c25b0 + 8829123 commit ac7fed9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions website/pages/api-docs/jobs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1811,11 +1811,11 @@ The table below shows this endpoint's support for
- `Target` `(json: required)` - JSON map containing the target of the scaling operation.
Must contain a field `Group` with the name of the task group that is the target of this scaling action.

- `Reason` `(string: <optional>)` - Description of the scale action, persisted as part of the scaling event.
Indicates information or reason for scaling; one of `Reason` or `Error` must be provided.
- `Message` `(string: <optional>)` - Description of the scale action, persisted as part of the scaling event.
Indicates information or reason for scaling; one of `Message` or `Error` must be provided.

- `Error` `(string: <optional>)` - Description of the scale action, persisted as part of the scaling event.
Indicates an error state preventing scaling; one of `Reason` or `Error` must be provided.
Indicates an error state preventing scaling; one of `Message` or `Error` must be provided.

- `Meta` `(json: <optional>)` - JSON block that is persisted as part of the scaling event.

Expand All @@ -1834,7 +1834,7 @@ The table below shows this endpoint's support for
"memory"
]
},
"Reason": "metric did not satisfy SLA",
"Message": "metric did not satisfy SLA",
"Target": {
"Group": "cache"
}
Expand Down

0 comments on commit ac7fed9

Please sign in to comment.