DOC-2727 Inventory Public api documentation by techsalvator · Pull Request #744 · spotinst/openapi

techsalvator · 2025-02-13T14:39:09Z

https://spotinst.atlassian.net/browse/DOC-2727

…entory-APIs

RachelHooley · 2025-02-17T08:09:14Z

api/services/beci/inventory/paths/cbiV1InventoryServiceIdProperty.yaml

+        anyOf:
+          - type: boolean
+          - type: 'null'
+        description: None returns all the properties, True returns only the default properties, False returns only the non-default properties


None returns all the properties. True returns only the default properties. False returns only the non-default properties.

RachelHooley · 2025-02-17T08:09:20Z

api/services/beci/inventory/paths/cbiV1InventoryServiceIdProperty.yaml

+          - 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


None returns all the properties. True returns only the default properties. False returns only the non-default properties.

RachelHooley · 2025-02-17T08:10:27Z

api/services/beci/inventory/paths/cbiV1InventoryServiceIdProperty.yaml

+        anyOf:
+          - type: boolean
+          - type: 'null'
+        description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties


None returns all the properties. True returns only the properties that can be selected. False returns only the properties that cannot be selected.

RachelHooley · 2025-02-17T08:10:36Z

api/services/beci/inventory/paths/cbiV1InventoryServiceIdProperty.yaml

+          - 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


None returns all the properties. True returns only the properties that can be selected. False returns only the properties that cannot be selected.

RachelHooley · 2025-02-17T08:26:39Z

api/services/beci/inventory/paths/cbiV1InventorySnapshot.yaml

+          - type: string
+            format: date-time
+          - type: 'null'
+        description: If specified, snapshot greater than this timestamp.


If specified, the inventory must have a snapshot after this timestamp.

RachelHooley · 2025-02-17T08:26:49Z

api/services/beci/inventory/paths/cbiV1InventorySnapshot.yaml

+            format: date-time
+          - type: 'null'
+        description: If specified, snapshot greater than this timestamp.
+      description: If specified, snapshot greater than this timestamp.


If specified, the inventory must have a snapshot after this timestamp.

RachelHooley · 2025-02-17T08:27:03Z

api/services/beci/inventory/paths/cbiV1InventorySnapshot.yaml

+          - type: string
+            format: date-time
+          - type: 'null'
+        description: If specified, snapshot less than this timestamp.


If specified, the inventory must have a snapshot before this timestamp.

RachelHooley · 2025-02-17T08:27:08Z

api/services/beci/inventory/paths/cbiV1InventorySnapshot.yaml

+            format: date-time
+          - type: 'null'
+        description: If specified, snapshot less than this timestamp.
+      description: If specified, snapshot less than this timestamp.


If specified, the inventory must have a snapshot before this timestamp.

RachelHooley · 2025-02-17T08:27:47Z

api/services/beci/inventory/paths/cbiV1InventorySnapshotIdServiceIdResource.yaml

+  tags:
+    - Inventory Resources
+  summary: Get Resources
+  description: Returns a list of resources processed in the given snapshot ID and service ID.


Returns a list of resources processed in the snapshot ID and service ID.

RachelHooley · 2025-02-17T08:28:16Z

api/services/beci/inventory/paths/cbiV1InventorySnapshotIdServiceIdResource.yaml

+      required: false
+      schema:
+        type: boolean
+        description: Include the common properties in addition to any properties specified in select


what does it mean - in select?

@RachelHooley In select is referring to another parameter. Line #57

@techsalvator Include the common properties, in addition to the properties you chose for the resource.
?

RachelHooley · 2025-02-17T08:28:30Z

api/services/beci/inventory/paths/cbiV1InventorySnapshotIdServiceIdResource.yaml

+        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


what does it mean - in select?

@RachelHooley In select is referring to another parameter. Line #57

@techsalvator Include the common properties, in addition to the properties you chose for the resource.
?

RachelHooley · 2025-02-17T08:29:12Z

api/services/beci/inventory/paths/cbiV1InventorySnapshotIdServiceIdResourceDetail.yaml

+      required: false
+      schema:
+        type: boolean
+        description: Include the data collected from the cloud provider (as is); structure not guaranteed.


Include the data from the cloud provider as is.

RachelHooley · 2025-02-17T08:29:18Z

api/services/beci/inventory/paths/cbiV1InventorySnapshotIdServiceIdResourceDetail.yaml

+        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.


Include the data from the cloud provider as is.

RachelHooley · 2025-02-17T09:24:02Z

api/services/beci/inventory/schemas/snapshotResponse.yaml

+  snapshotDate:
+    type: string
+    format: date-time
+    description: Timestamp used to "best represent" the point in time that the data being viewed represents.


I'm not sure I understand this one. is it:
The time the data was viewed.

@RachelHooley Timestamp represents time the data was collected from customer

@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?

The time the data was pulled from your cloud account.

RachelHooley · 2025-02-17T09:25:03Z

api/services/beci/inventory/schemas/supportedOptions.yaml

+properties:
+  select:
+    type: boolean
+    description: Property can be selected in the inventory list API.


I'm not sure I understand this one. is it:
This property can be selected in the inventory list API.

RachelHooley · 2025-02-17T09:25:09Z

api/services/beci/inventory/schemas/supportedOptions.yaml

+    description: Property can be selected in the inventory list API.
+  filter:
+    type: boolean
+    description: Property can be filtered in the inventory list API.


I'm not sure I understand this one. is it:
This property can be selected in the inventory list API.

@RachelHooley This property can be filtered in the inventory list API.

@techsalvator You can filter the inventories according to this field.
?

…entory-APIs

DOC-2727 Inventory Public api documentation

86edbc4

techsalvator requested a review from a team as a code owner February 13, 2025 14:39

Merge branch 'master' into DOC-2727-API-publish-Cost-Intelligence-Inv…

55612ae

…entory-APIs

RachelHooley reviewed Feb 17, 2025

View reviewed changes

Merge branch 'master' into DOC-2727-API-publish-Cost-Intelligence-Inv…

5274f4c

…entory-APIs

Conversation

techsalvator commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RachelHooley Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RachelHooley Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RachelHooley Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RachelHooley Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RachelHooley Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

techsalvator commented Feb 13, 2025 •

edited

Loading

RachelHooley Feb 17, 2025 •

edited

Loading

RachelHooley Feb 17, 2025 •

edited

Loading

RachelHooley Feb 17, 2025 •

edited

Loading

RachelHooley Feb 17, 2025 •

edited

Loading

RachelHooley Feb 19, 2025 •

edited

Loading