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

Commit 1f16a1f

Browse files
reidmitBrian Cunnie
andcommitted
V3: Document service usage events
The API documentation includes an example service usage event. `GET /v3/usage_events/:guid` Usage events are a union of app usage events and service usage events. Our documentation included an example of an app usage event but not a service usage event. [finishes #172985853] Co-authored-by: Reid Mitchell <rmitchell@pivotal.io> Co-authored-by: Brian Cunnie <bcunnie@pivotal.io>
1 parent b35e2d8 commit 1f16a1f

2 files changed

Lines changed: 17 additions & 3 deletions

File tree

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
<% content_for :single_usage_event do %>
1+
<% content_for :single_app_usage_event do %>
22
{
33
"guid": "a595fe2f-01ff-4965-a50c-290258ab8582",
44
"created_at": "2020-05-28T16:41:23Z",
55
"updated_at": "2020-05-28T16:41:26Z",
66
"type": "app"
77
}
88
<% end %>
9+
<% content_for :single_service_usage_event do %>
10+
{
11+
"guid": "c9976002-96f4-435a-888e-db1e1178df62",
12+
"created_at": "2020-05-28T12:34:56Z",
13+
"updated_at": "2020-05-28T12:34:56Z",
14+
"type": "service"
15+
}
16+
<% end %>

docs/v3/source/includes/experimental_resources/usage_events/_object.md.erb

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
### The usage event object
22

33
```
4-
Example Usage Event object
4+
Example of an App Usage Event object
55
```
66
```json
7-
<%= yield_content :single_usage_event %>
7+
<%= yield_content :single_app_usage_event %>
8+
```
9+
```
10+
Example of a Service Usage Event object
11+
```
12+
```json
13+
<%= yield_content :single_service_usage_event %>
814
```
915

1016
Name | Type | Description

0 commit comments

Comments
 (0)