DOC-2727 Inventory Public api documentation #744
Conversation
| anyOf: | ||
| - type: boolean | ||
| - type: 'null' | ||
| description: None returns all the properties, True returns only the default properties, False returns only the non-default properties |
There was a problem hiding this comment.
None returns all the properties. True returns only the default properties. False returns only the non-default properties.
| - type: boolean | ||
| - type: 'null' | ||
| description: None returns all the properties, True returns only the default properties, False returns only the non-default properties | ||
| description: None returns all the properties, True returns only the default properties, False returns only the non-default properties |
There was a problem hiding this comment.
None returns all the properties. True returns only the default properties. False returns only the non-default properties.
| anyOf: | ||
| - type: boolean | ||
| - type: 'null' | ||
| description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties |
There was a problem hiding this comment.
None returns all the properties. True returns only the properties that can be selected. False returns only the properties that cannot be selected.
| - type: boolean | ||
| - type: 'null' | ||
| description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties | ||
| description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties |
There was a problem hiding this comment.
None returns all the properties. True returns only the properties that can be selected. False returns only the properties that cannot be selected.
| - type: string | ||
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot greater than this timestamp. |
There was a problem hiding this comment.
If specified, the inventory must have a snapshot after this timestamp.
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot greater than this timestamp. | ||
| description: If specified, snapshot greater than this timestamp. |
There was a problem hiding this comment.
If specified, the inventory must have a snapshot after this timestamp.
| - type: string | ||
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot less than this timestamp. |
There was a problem hiding this comment.
If specified, the inventory must have a snapshot before this timestamp.
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot less than this timestamp. | ||
| description: If specified, snapshot less than this timestamp. |
There was a problem hiding this comment.
If specified, the inventory must have a snapshot before this timestamp.
| tags: | ||
| - Inventory Resources | ||
| summary: Get Resources | ||
| description: Returns a list of resources processed in the given snapshot ID and service ID. |
There was a problem hiding this comment.
Returns a list of resources processed in the snapshot ID and service ID.
| required: false | ||
| schema: | ||
| type: boolean | ||
| description: Include the common properties in addition to any properties specified in select |
There was a problem hiding this comment.
what does it mean - in select?
There was a problem hiding this comment.
@RachelHooley In select is referring to another parameter. Line #57
There was a problem hiding this comment.
@techsalvator Include the common properties, in addition to the properties you chose for the resource.
?
| type: boolean | ||
| description: Include the common properties in addition to any properties specified in select | ||
| default: true | ||
| description: Include the common properties in addition to any properties specified in select |
There was a problem hiding this comment.
what does it mean - in select?
There was a problem hiding this comment.
@RachelHooley In select is referring to another parameter. Line #57
There was a problem hiding this comment.
@techsalvator Include the common properties, in addition to the properties you chose for the resource.
?
| required: false | ||
| schema: | ||
| type: boolean | ||
| description: Include the data collected from the cloud provider (as is); structure not guaranteed. |
There was a problem hiding this comment.
Include the data from the cloud provider as is.
| type: boolean | ||
| description: Include the data collected from the cloud provider (as is); structure not guaranteed. | ||
| default: false | ||
| description: Include the data collected from the cloud provider (as is); structure not guaranteed. |
There was a problem hiding this comment.
Include the data from the cloud provider as is.
| snapshotDate: | ||
| type: string | ||
| format: date-time | ||
| description: Timestamp used to "best represent" the point in time that the data being viewed represents. |
There was a problem hiding this comment.
I'm not sure I understand this one. is it:
The time the data was viewed.
There was a problem hiding this comment.
@RachelHooley Timestamp represents time the data was collected from customer
There was a problem hiding this comment.
@techsalvator When the snapshot was taken from the ____
this is for the customer so we can't say customer. where does the data come from?
There was a problem hiding this comment.
The time the data was pulled from your cloud account.
| properties: | ||
| select: | ||
| type: boolean | ||
| description: Property can be selected in the inventory list API. |
There was a problem hiding this comment.
I'm not sure I understand this one. is it:
This property can be selected in the inventory list API.
| description: Property can be selected in the inventory list API. | ||
| filter: | ||
| type: boolean | ||
| description: Property can be filtered in the inventory list API. |
There was a problem hiding this comment.
I'm not sure I understand this one. is it:
This property can be selected in the inventory list API.
There was a problem hiding this comment.
@RachelHooley This property can be filtered in the inventory list API.
There was a problem hiding this comment.
@techsalvator You can filter the inventories according to this field.
?
https://spotinst.atlassian.net/browse/DOC-2727