DOC-2727 Inventory Public api documentation #744
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| get: | ||
| tags: | ||
| - Inventory Services | ||
| summary: Get Services | ||
| description: Returns a list of services. | ||
| operationId: getServicesCbiV1InventoryServiceGet | ||
| parameters: | ||
| - name: paginationSize | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: integer | ||
| description: Number of items to include in the response | ||
| description: Number of items to include in the response | ||
| - name: paginationKey | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
| description: Key used to fetch a specific page of items | ||
| description: Key used to fetch a specific page of items | ||
| - name: accountId | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| description: Spot account ID | ||
| description: Spot account ID | ||
| - name: subAccountIds | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: array | ||
| items: | ||
| type: string | ||
| - type: 'null' | ||
| description: Subaccount IDs | ||
| description: Subaccount IDs | ||
| - name: providerName | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: ../schemas/cloudProvider.yaml | ||
| description: Cloud Provider(s) | ||
| default: [] | ||
| description: Cloud Provider(s) | ||
| responses: | ||
| '200': | ||
| $ref: ../responses/get200cbiV1InventoryService.yaml | ||
| '400': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Invalid request error response. Adjust the request before retrying. | ||
| '404': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Not found error response. The requested resource does not exist. | ||
| '422': | ||
| description: Error response. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml |
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,97 @@ | ||
| get: | ||
| tags: | ||
| - Inventory Services | ||
| summary: Get Service Properties | ||
| description: Returns a list of service properties. | ||
| operationId: getPropertiesByServiceCbiV1InventoryServiceServiceIdPropertyGet | ||
| parameters: | ||
| - name: serviceId | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: Service ID | ||
| description: Service ID | ||
| - name: paginationSize | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: integer | ||
| description: Number of items to include in the response | ||
| description: Number of items to include in the response | ||
| - name: paginationKey | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
| description: Key used to fetch a specific page of items | ||
| description: Key used to fetch a specific page of items | ||
| - name: accountId | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| description: Spot account ID | ||
| description: Spot account ID | ||
| - name: subAccountIds | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: array | ||
| items: | ||
| type: string | ||
| - type: 'null' | ||
| description: Subaccount IDs | ||
| description: Subaccount IDs | ||
| - name: default | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - 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 | ||
|
Collaborator
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. |
||
| - name: selectable | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: boolean | ||
| - type: 'null' | ||
| description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties | ||
|
Collaborator
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. |
||
| description: None returns all the properties, True returns only the selectable properties, False returns only the non-selectable properties | ||
|
Collaborator
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. |
||
| - name: region | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: List of region(s) | ||
| default: [] | ||
| description: List of region(s) | ||
| responses: | ||
| '200': | ||
| $ref: ../responses/get200cbiV1InventoryServiceIdProperty.yaml | ||
| '400': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Invalid request error response. Adjust the request before retrying. | ||
| '404': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Not found error response. The requested resource does not exist. | ||
| '422': | ||
| description: Error response. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
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,95 @@ | ||
| get: | ||
| tags: | ||
| - Inventory Services | ||
| summary: Get Service property values | ||
| description: Returns a list of service property values. | ||
| operationId: getValuesByServiceCbiV1InventoryServiceServiceIdPropertyPropertyNameValueGet | ||
| parameters: | ||
| - name: serviceId | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: Service ID | ||
| description: Service ID | ||
| - name: propertyName | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: Property Name | ||
| description: Property Name | ||
| - name: search | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| description: Search for items that contain the specified value (case insensitive). | ||
| description: Search for items that contain the specified value (case insensitive). | ||
| - name: paginationSize | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: integer | ||
| description: Number of items to include in the response | ||
| description: Number of items to include in the response | ||
| - name: paginationKey | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
| description: Key used to fetch a specific page of items | ||
| description: Key used to fetch a specific page of items | ||
| - name: accountId | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| description: Spot account ID | ||
| description: Spot account ID | ||
| - name: subAccountIds | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: array | ||
| items: | ||
| type: string | ||
| - type: 'null' | ||
| description: Subaccount IDs | ||
| description: Subaccount IDs | ||
| - name: region | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: array | ||
| items: | ||
| type: string | ||
| description: List of region(s) | ||
| default: [] | ||
| description: List of region(s) | ||
| responses: | ||
| '200': | ||
| $ref: ../responses/get200cbiV1InventoryServiceIdPropertyIdValue.yaml | ||
| '400': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Invalid request error response. Adjust the request before retrying. | ||
| '404': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Not found error response. The requested resource does not exist. | ||
| '422': | ||
| description: Error response. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml |
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,92 @@ | ||
| get: | ||
| tags: | ||
| - Inventory Snapshots | ||
| summary: Get Snapshots | ||
| description: Returns a list of snapshot id and date. | ||
| operationId: getSnapshotsCbiV1InventorySnapshotGet | ||
| parameters: | ||
| - name: paginationSize | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: integer | ||
| description: Number of items to include in the response | ||
| description: Number of items to include in the response | ||
| - name: paginationKey | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
| description: Key used to fetch a specific page of items | ||
| description: Key used to fetch a specific page of items | ||
| - name: accountId | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| - type: 'null' | ||
| description: Spot account ID | ||
| description: Spot account ID | ||
| - name: subAccountIds | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: array | ||
| items: | ||
| type: string | ||
| - type: 'null' | ||
| description: Subaccount IDs | ||
| description: Subaccount IDs | ||
| - name: minSnapshotDate | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot greater than this timestamp. | ||
|
Collaborator
There was a problem hiding this comment. If specified, the inventory must have a snapshot after this timestamp. |
||
| description: If specified, snapshot greater than this timestamp. | ||
|
Collaborator
There was a problem hiding this comment. If specified, the inventory must have a snapshot after this timestamp. |
||
| - name: maxSnapshotDate | ||
| in: query | ||
| required: false | ||
| schema: | ||
| anyOf: | ||
| - type: string | ||
| format: date-time | ||
| - type: 'null' | ||
| description: If specified, snapshot less than this timestamp. | ||
|
Collaborator
There was a problem hiding this comment. If specified, the inventory must have a snapshot before this timestamp. |
||
| description: If specified, snapshot less than this timestamp. | ||
|
Collaborator
There was a problem hiding this comment. If specified, the inventory must have a snapshot before this timestamp. |
||
| - name: providerName | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: ../schemas/cloudProvider.yaml | ||
| description: Cloud Provider(s) | ||
| default: [] | ||
| description: Cloud Provider(s) | ||
| responses: | ||
| '200': | ||
| $ref: ../responses/get200cbiV1InventorySnapshot.yaml | ||
| '400': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Invalid request error response. Adjust the request before retrying. | ||
| '404': | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
| description: Not found error response. The requested resource does not exist. | ||
| '422': | ||
| description: Error response. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: ../../../../commons/schemas/errorResponse.yaml | ||
Oops, something went wrong.
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.
None returns all the properties. True returns only the default properties. False returns only the non-default properties.