[Update] GET /account/events and GET /account/events/{eventId} #116
Conversation
leslitagordita
requested review from
yoshizzle and
Dorthu
and removed request for
yoshizzle
| description: | | ||
| Detailed information about the Event's secondary entity, which provides additional information | ||
| for `linode_boot`, `linode_create`, and `linode_clone` Event actions. | ||
| x-linode-cli-display: 5 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
openapi.yaml
Outdated
| readOnly: true | ||
| description: | | ||
| Detailed information about the Event's secondary entity, which provides additional information | ||
| for `linode_boot`, `linode_create`, and `linode_clone` Event actions. |
There was a problem hiding this comment.
There will be others in the future.
openapi.yaml
Outdated
| The unique ID for an Event's secondary entity. | ||
|
|
||
|
|
||
| Secondary Entities are assigned the ID of the Linode they correspond to. |
There was a problem hiding this comment.
This isn't true; this is the ID of the object that is the secondary entity (i.e. if I deploy a Linode from the official Debain9 image, the secondary entity's ID will be linode/debain9 because that's the ID of that image). They may have nothing to do with a Linode.
openapi.yaml
Outdated
| x-linode-cli-display: 5 | ||
| properties: | ||
| id: | ||
| type: integer |
There was a problem hiding this comment.
Not always; images have slugs, for example
There was a problem hiding this comment.
Will update to be a string.
There was a problem hiding this comment.
That's probably safer. This could also come back as an int, but it doesn't look like openapi3 supports this.
openapi.yaml
Outdated
| type: string | ||
| description: > | ||
| The current label of this object. The label may reflect changes | ||
| that occur with this Event. |
There was a problem hiding this comment.
Actually no; secondary entity labels won't change. Entity labels may stop being updated in the future, also.
openapi.yaml
Outdated
| enum: | ||
| - backup | ||
| - image | ||
| - linode |
There was a problem hiding this comment.
This could be any entity type. Right now secondary entity specifically will only come back with "linode", "image", "linode_config", or "backup", but there may be more in the future.
There was a problem hiding this comment.
Cool - I'll make this a regular string - Also - noticed that this was "backup" in this test but other places in the code this was was "backups"...
…low for possibility of more event actions
Release 1.0.14
Release 1.1.6
Added secondary_entity object to Event schema object which appears in both
GET /account/events
and
GET /account/events/{eventId}
Additionally, while researching discovered that "filterable" should have been set on Event properties id and created - added that in second commit.
Documents:
https://bits.linode.com/LinodeAPI/apinext/pull/1793