Skip to content

Commit 4803f76

Browse files
Josh SagerDorthu
authored andcommitted
Added object and endpoint for managed history
Some of the object information will probably come out, but wanted to leave it in for now, until the POST/PUT endpoints have been completed. I'm perfectly fine to have a lot of this stripped out in the future.
1 parent 2fe377d commit 4803f76

File tree

2 files changed

+135
-0
lines changed

2 files changed

+135
-0
lines changed

docs/src/data/endpoints/managed.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,17 @@ endpoints:
8080
"group": "Developers"
8181
}' \
8282
https://$api_root/$version/account/oauth-clients/$client_id
83+
/managed/history:
84+
group: History
85+
type: resource
86+
description: >
87+
A list of the issues created from monitoring your Services.
88+
methods:
89+
GET:
90+
response: ManagedHistory
91+
description: >
92+
Returns your managed service issue history list.
93+
examples:
94+
curl: |
95+
curl https://$api_root/$version/managed/history
8396
Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# vim: set et ts=2 sw=2 tw=80 :
2+
name: ManagedHistory
3+
prefix: managed/history
4+
description: >
5+
Managed History objects describe support ticket issues that have occurred while subscribed to your Managed service.
6+
schema:
7+
created:
8+
type: Datetime
9+
value: 2017-10-31T11:12:21
10+
entity:
11+
description: >
12+
Displays information related to the type of issue being monitored by your Service.
13+
id:
14+
type: Integer
15+
value: 1234567
16+
type:
17+
type: String
18+
value: ticket
19+
description: >
20+
The type of service issue being reported.
21+
label:
22+
type: String
23+
value: Could not connect to URL
24+
description: >
25+
A summary of the issue being reported.
26+
url:
27+
type: String
28+
value: /support/tickets/1234567
29+
description: >
30+
The endpoint URI related to the Support Ticket that was created.
31+
service:
32+
description: >
33+
Displays information related to the Service being monitored.
34+
id:
35+
type: Integer
36+
value: 111
37+
updated:
38+
type: Datetime
39+
value: 2017-10-31T22:34:50
40+
status:
41+
type: Enum
42+
subtype: ManagedServiceStatus
43+
value: "active"
44+
description: >
45+
Describes the status of your Service.
46+
label:
47+
type: String
48+
value: myLabel
49+
description: >
50+
Describes the Service you want monitored.
51+
type:
52+
type: Enum
53+
subtype: ManagedServiceType
54+
value: "url"
55+
description: >
56+
Describes the type of monitoring you want.
57+
body:
58+
type: String
59+
value: String to match.
60+
description: >
61+
Response must contain this string or an alert will be triggered.
62+
method:
63+
type: Enum
64+
subtype: ManagedServiceMethod
65+
value: "get"
66+
description: >
67+
The method by which the URL is accessed.
68+
#TODO credentials:
69+
created:
70+
type: Datetime
71+
value: 2017-10-31T19:20:33
72+
consultation_group:
73+
type: String
74+
value: Support Manager
75+
description: >
76+
If we need help along the way, we'll contact someone from this group.
77+
path:
78+
type: String
79+
value: /
80+
description: >
81+
Defaults to "/" for url.
82+
url:
83+
type: String
84+
value: https://mydomain.domain.com/
85+
description: >
86+
The URL to request.
87+
timeout:
88+
type: Integer
89+
value: 10
90+
description: >
91+
Response must be received before this timeout or an alert will be triggered.
92+
port:
93+
type: Integer
94+
value: 80
95+
description: >
96+
Defaults to 80 if HTTP/TCP, 443 if HTTPS
97+
protocol:
98+
type: Enum
99+
subtype: ManagedServiceProtocol
100+
value: "https"
101+
description: >
102+
Defaults to HTTP in URL mode, TCP in TCP mode.
103+
domain:
104+
type: String
105+
value: mydomain.domain.com
106+
description: >
107+
The domain name of the URL to request.
108+
enums:
109+
ManagedServiceStatus:
110+
new: A newly-created Service.
111+
active: An active Service to monitor.
112+
disabled: A disabled Service to monitor.
113+
ManagedServiceType:
114+
url: Monitor a specific URL.
115+
tcp: Monitor a port via TCP.
116+
ManagedServiceMethod:
117+
get: Monitor a specific URL/port via GET.
118+
post: Monitor a specific URL/port via POST.
119+
ManagedServiceProtocol:
120+
http: HTTP
121+
https: HTTPS
122+
tcp: TCP

0 commit comments

Comments
 (0)