Skip to content
This repository was archived by the owner on Jun 2, 2021. It is now read-only.

Commit 7806c83

Browse files
author
Aakash Shah
committed
Fix v3-docs not including "warning" field for Jobs
* Looks like this was added way back in 903275d [#172704712] Authored-by: Aakash Shah <ashah@pivotal.io>
1 parent c823d47 commit 7806c83

4 files changed

Lines changed: 30 additions & 1 deletion

File tree

docs/v3/source/includes/api_resources/_jobs.erb

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@
1010
"href": "https://api.example.org/v3/jobs/b19ae525-cbd3-4155-b156-dc0c2a431b4c"
1111
}
1212
},
13-
"errors": []
13+
"errors": [],
14+
"warnings": []
1415
}
1516
<% end %>
1617

@@ -35,6 +36,11 @@
3536
"title": "CF-UnprocessableEntity",
3637
"detail": "something went wrong"
3738
}
39+
],
40+
"warnings": [
41+
{
42+
"detail": "warning! warning!"
43+
}
3844
]
3945
}
4046
<% end %>
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Warnings
2+
3+
```
4+
Example Warnings
5+
```
6+
```json
7+
{
8+
"warnings": [
9+
{
10+
"detail": "something went wrong"
11+
}
12+
]
13+
}
14+
```
15+
16+
#### The warning object
17+
18+
Name | Type | Description
19+
---- | ---- | -----------
20+
**detail** | _string_ | Description of the warning.
21+

docs/v3/source/includes/resources/jobs/_object.md.erb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ Name | Type | Description
1616
**state** | _string_ | State of the job. Valid values are `PROCESSING`, `POLLING`, `COMPLETE`, or` FAILED`.
1717
**links** | [_links object_](#links) | Links to related resources.
1818
**errors** | [_errors list_](#errors) | Array of errors that occurred while processing the job.
19+
**warnings** | [_warnings list_](#warnings) | Array of warnings that occurred while processing the job.
1920

2021
Note: `POLLING` happens during asynchronous services operations that require polling the last operation from the service broker.

docs/v3/source/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ includes:
5353
- concepts/procfiles
5454
- concepts/relationships
5555
- concepts/status_codes
56+
- concepts/warnings
5657
- resources/header
5758
- resources/apps/header
5859
- resources/apps/object

0 commit comments

Comments
 (0)