-
Notifications
You must be signed in to change notification settings - Fork 69
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
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] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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