Skip to content

[Update] GET /account/events and GET /account/events/{eventId} #116

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.

Sign up for GitHub

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 4 commits into from
Sep 6, 2019
Merged

[Update] GET /account/events and GET /account/events/{eventId} #116

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50f88e1
Updated Event schema object added secondary_entity object
Aug 28, 2019
420d4c1
added filterable tag to properties id and created per map
Aug 28, 2019
291791e
updated type to enum and description. also updated cli display order.
Sep 3, 2019
eb6f6fc
removed enum from type, made id a string, made label non-changing, al…
Sep 6, 2019
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: 38 additions & 5 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12276,6 +12276,7 @@ components:
description: The unique ID of this Event.
example: 123
x-linode-cli-display: 1
x-linode-filterable: true
action:
type: string
enum:
Expand Down Expand Up @@ -12391,7 +12392,8 @@ components:
format: date-time
description: When this Event was created.
example: '2018-01-01T00:01:01'
x-linode-cli-display: 5
x-linode-cli-display: 6
x-linode-filterable: true
entity:
type: object
readOnly: true
Expand Down Expand Up @@ -12453,7 +12455,7 @@ components:
- volume
readOnly: true
description: >
The type of entity this Event is related to.
The type of entity that is being referenced by the Event.
example: ticket
x-linode-filterable: true
url:
Expand All @@ -12463,6 +12465,37 @@ components:
a relative URL, it is relative to the domain you retrieved the
Event from.
example: /v4/support/tickets/11111
secondary_entity:
type: object
readOnly: true
description: |
Detailed information about the Event's secondary entity, which provides additional information
for events such as, but not limited to, `linode_boot`, `linode_create`, and `linode_clone` Event actions.
x-linode-cli-display: 5
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is probably not going to display correctly; entity is listed as displaying in column 4, but in practice doesn't show up when you run linode-cli events list

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We noticed this as well and assumed this is because it's not displaying entity because it is an object? We assume this will be skipped as well but put it here in the case that should it in the future be displayed, that it will appear next to entity.

properties:
id:
type: string
description: >
The ID of the object that is the secondary entity.
example: linode/debian9
label:
type: string
description: >
The label of this object.
example: linode1234
type:
type: string
readOnly: true
description: >
The type of entity that is being referenced by the Event.
example: linode
url:
type: string
description: >
The URL where you can access the object this Event is for. If
a relative URL, it is relative to the domain you retrieved the
Event from.
example: /v4/linode/instances/1234
percent_complete:
type: integer
readOnly: true
Expand All @@ -12483,13 +12516,13 @@ components:
readOnly: true
description: If this Event has been read.
example: true
x-linode-cli-display: 8
x-linode-cli-display: 9
seen:
type: boolean
readOnly: true
description: If this Event has been seen.
example: true
x-linode-cli-display: 7
x-linode-cli-display: 8
status:
type: string
readOnly: true
Expand All @@ -12500,7 +12533,7 @@ components:
- notification
- scheduled
- started
x-linode-cli-display: 6
x-linode-cli-display: 7
x-linode-cli-color:
failed: red
finished: green
Expand Down