Skip to content

add managed issues to docs #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 20, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 28 additions & 15 deletions src/data/endpoints/managed.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -89,21 +89,34 @@ endpoints:
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://$api_root/$version/managed/contact/$contact_id

#/managed/history:
# group: History
# type: resource
# description: >
# A list of the issues created from monitoring your Services.
# methods:
# GET:
# response: ManagedHistory
# description: >
# Returns your managed service issue history list.
# examples:
# curl: |
# curl -H "Authorization: Bearer $TOKEN" \
# https://$api_root/$version/managed/history
/managed/issues:
group: Issues
authenticated: true
description: >
A list of the issues created from monitoring your Services.
methods:
GET:
response: ManagedIssue
description: >
Returns your managed service issue list.
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/managed/issues
/managed/issues/$id:
group: Issues
authenticated: true
description: >
Retrieve a particular issue.
methods:
GET:
response: ManagedIssue
description: >
Returns information about this issue.
examples:
curl: |
curl -H "Authorization: Bearer $TOKEN" \
https://$api_root/$version/managed/issues/$issue_id
/managed/services:
group: Services
type: resource
Expand Down
122 changes: 0 additions & 122 deletions src/data/objects/managedhistory.yaml

This file was deleted.

57 changes: 57 additions & 0 deletions src/data/objects/managedissue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# vim: set et ts=2 sw=2 tw=80 :
name: ManagedIssue
prefix: managed/issue
description: >
Managed Issue objects describe support ticket issues that have occurred while subscribed to your Managed service.
schema:
id:
type: Integer
value: 1234567
description: ID of this Managed Issue.
created:
type: Datetime
value: 2017-10-31T11:12:21
description: Time at which the issue was reported.
entity:
description: >
Displays information related to the type of issue being monitored by your Service.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description should not be inside of entity here

id:
type: Integer
value: 1234567
description: ID of the created Support Ticket.
type:
type: String
value: ticket
description: >
The type of service issue being reported.
label:
type: String
value: Could not connect to URL
description: >
A summary of the issue being reported.
url:
type: String
value: /support/tickets/1234567
description: >
The endpoint URI related to the Support Ticket that was created.
services:
type: Array
description: >
List of impacted service IDs.
seeAlso: ["/endpoints/managed/services"]
value: [111, 123]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing "id" attribute (outside of entity)

enums:
ManagedServiceStatus:
new: A newly-created Service.
active: An active Service to monitor.
disabled: A disabled Service to monitor.
ManagedServiceType:
url: Monitor a specific URL.
tcp: Monitor a port via TCP.
ManagedServiceMethod:
get: Monitor a specific URL/port via GET.
post: Monitor a specific URL/port via POST.
ManagedServiceProtocol:
http: HTTP
https: HTTPS
tcp: TCP