diff --git a/v1/api/swagger/components/schemas/OSServiceImage.yaml b/v1/api/swagger/components/schemas/OSServiceImage.yaml index ba9de67..a54c01a 100644 --- a/v1/api/swagger/components/schemas/OSServiceImage.yaml +++ b/v1/api/swagger/components/schemas/OSServiceImage.yaml @@ -20,6 +20,7 @@ allOf: - UserDefinedSteps - Classifiers - ProjectID + - DownloadHealth properties: ProjectID: type: string @@ -27,6 +28,8 @@ allOf: description: >- Unique ID of the project that owns this OS service image. example: 046b6c7f-0b8a-43b9-b35d-6489e6daee92 + DownloadHealth: + $ref: OSServiceImageDownloadHealth.yaml Description: type: string example: Description of the image diff --git a/v1/api/swagger/components/schemas/OSServiceImageDetailedDownloadHealth.yaml b/v1/api/swagger/components/schemas/OSServiceImageDetailedDownloadHealth.yaml new file mode 100644 index 0000000..f5d73be --- /dev/null +++ b/v1/api/swagger/components/schemas/OSServiceImageDetailedDownloadHealth.yaml @@ -0,0 +1,3 @@ +type: object +additionalProperties: + $ref: OSServiceImageDownloadHealthDetails.yaml \ No newline at end of file diff --git a/v1/api/swagger/components/schemas/OSServiceImageDownloadHealth.yaml b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealth.yaml new file mode 100644 index 0000000..8d35438 --- /dev/null +++ b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealth.yaml @@ -0,0 +1,11 @@ +type: object +required: + - DetailedDownloadHealth + - DownloadHealthSummary +properties: + DetailedDownloadHealth: + $ref: OSServiceImageDetailedDownloadHealth.yaml + DownloadHealthSummary: + $ref: OSServiceImageDownloadHealthSummary.yaml +description: >- + Provides download health info of the OS service image. \ No newline at end of file diff --git a/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthDetails.yaml b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthDetails.yaml new file mode 100644 index 0000000..f869cd1 --- /dev/null +++ b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthDetails.yaml @@ -0,0 +1,24 @@ +type: object +required: + - Changed + - Details + - Reason + - Summary +properties: + Changed: + type: string + format: date-time + example: 2019-06-27T22:59:01.661Z + description: >- + Indicates last time this download health has been updated. + Details: + type: object + additionalProperties: + $ref: OSServiceImageDownloadHealthSummary.yaml + Reason: + type: string + example: "Service download health timed out" + description: >- + Indicates the reason for the reported download health status if not OK. + Summary: + $ref: OSServiceImageDownloadHealthSummary.yaml \ No newline at end of file diff --git a/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthSummary.yaml b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthSummary.yaml new file mode 100644 index 0000000..dc1581d --- /dev/null +++ b/v1/api/swagger/components/schemas/OSServiceImageDownloadHealthSummary.yaml @@ -0,0 +1,9 @@ +type: string +enum: + - OK + - Warning + - Critical + - Unknown +example: OK +description: > + Indicates the download health summary of the OS service image. \ No newline at end of file diff --git a/v1/pkg/client/README.md b/v1/pkg/client/README.md index 39472a2..1e34a8e 100644 --- a/v1/pkg/client/README.md +++ b/v1/pkg/client/README.md @@ -157,6 +157,9 @@ Class | Method | HTTP request | Description - [OsServiceImage](docs/OsServiceImage.md) - [OsServiceImageAllOf](docs/OsServiceImageAllOf.md) - [OsServiceImageApproach](docs/OsServiceImageApproach.md) + - [OsServiceImageDownloadHealth](docs/OsServiceImageDownloadHealth.md) + - [OsServiceImageDownloadHealthDetails](docs/OsServiceImageDownloadHealthDetails.md) + - [OsServiceImageDownloadHealthSummary](docs/OsServiceImageDownloadHealthSummary.md) - [OsServiceImageOrigin](docs/OsServiceImageOrigin.md) - [Partition](docs/Partition.md) - [PartitionFormula](docs/PartitionFormula.md) diff --git a/v1/pkg/client/api/openapi.yaml b/v1/pkg/client/api/openapi.yaml index 785c4af..6991233 100644 --- a/v1/pkg/client/api/openapi.yaml +++ b/v1/pkg/client/api/openapi.yaml @@ -5866,6 +5866,19 @@ components: - AllocatedCount - ServiceType type: object + OSServiceImageDownloadHealth: + description: Provides download health info of the OS service image. + properties: + DetailedDownloadHealth: + additionalProperties: + $ref: '#/components/schemas/OSServiceImageDownloadHealthDetails' + type: object + DownloadHealthSummary: + $ref: '#/components/schemas/OSServiceImageDownloadHealthSummary' + required: + - DetailedDownloadHealth + - DownloadHealthSummary + type: object OSServiceImageOrigin: description: | Indicates the origin of the OS service image. @@ -6539,6 +6552,19 @@ components: - InUse - Total type: object + OSServiceImageDetailedDownloadHealth: + additionalProperties: + $ref: '#/components/schemas/OSServiceImageDownloadHealthDetails' + type: object + OSServiceImageDownloadHealthSummary: + description: Indicates the download health summary of the OS service image. + enum: + - OK + - Warning + - Critical + - Unknown + example: OK + type: string PartitionTable: description: Defines the type of partition table. enum: @@ -6674,6 +6700,30 @@ components: required: - SubAttributeRules type: object + OSServiceImageDownloadHealthDetails: + properties: + Changed: + description: Indicates last time this download health has been updated. + example: 2019-06-27T22:59:01.661Z + format: date-time + type: string + Details: + additionalProperties: + $ref: '#/components/schemas/OSServiceImageDownloadHealthSummary' + type: object + Reason: + description: Indicates the reason for the reported download health status + if not OK. + example: Service download health timed out + type: string + Summary: + $ref: '#/components/schemas/OSServiceImageDownloadHealthSummary' + required: + - Changed + - Details + - Reason + - Summary + type: object PartitionType: description: It defines the available partition types. This should be defined to correspond to target OS known partition types (as known by name on that @@ -7506,6 +7556,8 @@ components: example: 046b6c7f-0b8a-43b9-b35d-6489e6daee92 format: uuid type: string + DownloadHealth: + $ref: '#/components/schemas/OSServiceImageDownloadHealth' Description: example: Description of the image type: string @@ -7585,6 +7637,7 @@ components: - Classifiers - Description - DeviceLayouts + - DownloadHealth - FWBaselineID - Files - Flavor diff --git a/v1/pkg/client/docs/OsServiceImage.md b/v1/pkg/client/docs/OsServiceImage.md index a2d8354..7e144f4 100644 --- a/v1/pkg/client/docs/OsServiceImage.md +++ b/v1/pkg/client/docs/OsServiceImage.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **Created** | [**time.Time**](time.Time.md) | Time when the resource was created in the database | **Modified** | [**time.Time**](time.Time.md) | Time when the resource was last modified in the database | **ProjectID** | **string** | Unique ID of the project that owns this OS service image. | +**DownloadHealth** | [**OsServiceImageDownloadHealth**](OSServiceImageDownloadHealth.md) | | **Description** | **string** | | **Category** | **string** | A high level classification of the service. | **Flavor** | **string** | An high level description of the OS image type. | diff --git a/v1/pkg/client/docs/OsServiceImageAllOf.md b/v1/pkg/client/docs/OsServiceImageAllOf.md index 6af414f..99de7be 100644 --- a/v1/pkg/client/docs/OsServiceImageAllOf.md +++ b/v1/pkg/client/docs/OsServiceImageAllOf.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ProjectID** | **string** | Unique ID of the project that owns this OS service image. | +**DownloadHealth** | [**OsServiceImageDownloadHealth**](OSServiceImageDownloadHealth.md) | | **Description** | **string** | | **Category** | **string** | A high level classification of the service. | **Flavor** | **string** | An high level description of the OS image type. | diff --git a/v1/pkg/client/docs/OsServiceImageDownloadHealth.md b/v1/pkg/client/docs/OsServiceImageDownloadHealth.md new file mode 100644 index 0000000..1e0b17c --- /dev/null +++ b/v1/pkg/client/docs/OsServiceImageDownloadHealth.md @@ -0,0 +1,12 @@ +# OsServiceImageDownloadHealth + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**DetailedDownloadHealth** | [**map[string]OsServiceImageDownloadHealthDetails**](OSServiceImageDownloadHealthDetails.md) | | +**DownloadHealthSummary** | [**OsServiceImageDownloadHealthSummary**](OSServiceImageDownloadHealthSummary.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/pkg/client/docs/OsServiceImageDownloadHealthDetails.md b/v1/pkg/client/docs/OsServiceImageDownloadHealthDetails.md new file mode 100644 index 0000000..f2ae12a --- /dev/null +++ b/v1/pkg/client/docs/OsServiceImageDownloadHealthDetails.md @@ -0,0 +1,14 @@ +# OsServiceImageDownloadHealthDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Changed** | [**time.Time**](time.Time.md) | Indicates last time this download health has been updated. | +**Details** | [**map[string]OsServiceImageDownloadHealthSummary**](OSServiceImageDownloadHealthSummary.md) | | +**Reason** | **string** | Indicates the reason for the reported download health status if not OK. | +**Summary** | [**OsServiceImageDownloadHealthSummary**](OSServiceImageDownloadHealthSummary.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/pkg/client/docs/OsServiceImageDownloadHealthSummary.md b/v1/pkg/client/docs/OsServiceImageDownloadHealthSummary.md new file mode 100644 index 0000000..0ae1c36 --- /dev/null +++ b/v1/pkg/client/docs/OsServiceImageDownloadHealthSummary.md @@ -0,0 +1,10 @@ +# OsServiceImageDownloadHealthSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/v1/pkg/client/model_os_service_image.go b/v1/pkg/client/model_os_service_image.go index 4d58215..6a364ce 100644 --- a/v1/pkg/client/model_os_service_image.go +++ b/v1/pkg/client/model_os_service_image.go @@ -27,6 +27,7 @@ type OsServiceImage struct { Modified time.Time `json:"Modified"` // Unique ID of the project that owns this OS service image. ProjectID string `json:"ProjectID"` + DownloadHealth OsServiceImageDownloadHealth `json:"DownloadHealth"` Description string `json:"Description"` // A high level classification of the service. Category string `json:"Category"` diff --git a/v1/pkg/client/model_os_service_image_all_of.go b/v1/pkg/client/model_os_service_image_all_of.go index 0760826..fb4d639 100644 --- a/v1/pkg/client/model_os_service_image_all_of.go +++ b/v1/pkg/client/model_os_service_image_all_of.go @@ -14,6 +14,7 @@ package client type OsServiceImageAllOf struct { // Unique ID of the project that owns this OS service image. ProjectID string `json:"ProjectID"` + DownloadHealth OsServiceImageDownloadHealth `json:"DownloadHealth"` Description string `json:"Description"` // A high level classification of the service. Category string `json:"Category"` diff --git a/v1/pkg/client/model_os_service_image_download_health.go b/v1/pkg/client/model_os_service_image_download_health.go new file mode 100644 index 0000000..7e4df35 --- /dev/null +++ b/v1/pkg/client/model_os_service_image_download_health.go @@ -0,0 +1,17 @@ +// (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP + +/* + * HPE GreenLake for bare metal API + * + * This Metal Client REST API provides access to bare metal as-a-service (BMaaS) within a single project context. Clients are able to create fully-provisioned hosts, storage volumes, and project-specific private networks in an isolated project environment. Project-owned resources that can be accessed via this API include - Host, Volume, VolumeAttachment, Network (project private), and SSH Key. Each API call is done within a single project context. The specific Project identifier must be provided within the header of for each REST call. The server will validate that the provided authentication credentials (JWTs) are valid for the referenced project before any operation is performed. If a single credential is valid for multiple projects, the client must still reference a single project in the header for each API call. Clients can also access information about available services and resources through the AvailableResources object. This object provides detailed information about the OS imaging options, the machine size options, the storage volume options, and data center locations which are needed when creating hosts and volumes. + * + * API version: v1 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package client +// OsServiceImageDownloadHealth Provides download health info of the OS service image. +type OsServiceImageDownloadHealth struct { + DetailedDownloadHealth map[string]OsServiceImageDownloadHealthDetails `json:"DetailedDownloadHealth"` + DownloadHealthSummary OsServiceImageDownloadHealthSummary `json:"DownloadHealthSummary"` +} diff --git a/v1/pkg/client/model_os_service_image_download_health_details.go b/v1/pkg/client/model_os_service_image_download_health_details.go new file mode 100644 index 0000000..6bec35b --- /dev/null +++ b/v1/pkg/client/model_os_service_image_download_health_details.go @@ -0,0 +1,24 @@ +// (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP + +/* + * HPE GreenLake for bare metal API + * + * This Metal Client REST API provides access to bare metal as-a-service (BMaaS) within a single project context. Clients are able to create fully-provisioned hosts, storage volumes, and project-specific private networks in an isolated project environment. Project-owned resources that can be accessed via this API include - Host, Volume, VolumeAttachment, Network (project private), and SSH Key. Each API call is done within a single project context. The specific Project identifier must be provided within the header of for each REST call. The server will validate that the provided authentication credentials (JWTs) are valid for the referenced project before any operation is performed. If a single credential is valid for multiple projects, the client must still reference a single project in the header for each API call. Clients can also access information about available services and resources through the AvailableResources object. This object provides detailed information about the OS imaging options, the machine size options, the storage volume options, and data center locations which are needed when creating hosts and volumes. + * + * API version: v1 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package client +import ( + "time" +) +// OsServiceImageDownloadHealthDetails struct for OsServiceImageDownloadHealthDetails +type OsServiceImageDownloadHealthDetails struct { + // Indicates last time this download health has been updated. + Changed time.Time `json:"Changed"` + Details map[string]OsServiceImageDownloadHealthSummary `json:"Details"` + // Indicates the reason for the reported download health status if not OK. + Reason string `json:"Reason"` + Summary OsServiceImageDownloadHealthSummary `json:"Summary"` +} diff --git a/v1/pkg/client/model_os_service_image_download_health_summary.go b/v1/pkg/client/model_os_service_image_download_health_summary.go new file mode 100644 index 0000000..c93de99 --- /dev/null +++ b/v1/pkg/client/model_os_service_image_download_health_summary.go @@ -0,0 +1,22 @@ +// (C) Copyright 2021-2024 Hewlett Packard Enterprise Development LP + +/* + * HPE GreenLake for bare metal API + * + * This Metal Client REST API provides access to bare metal as-a-service (BMaaS) within a single project context. Clients are able to create fully-provisioned hosts, storage volumes, and project-specific private networks in an isolated project environment. Project-owned resources that can be accessed via this API include - Host, Volume, VolumeAttachment, Network (project private), and SSH Key. Each API call is done within a single project context. The specific Project identifier must be provided within the header of for each REST call. The server will validate that the provided authentication credentials (JWTs) are valid for the referenced project before any operation is performed. If a single credential is valid for multiple projects, the client must still reference a single project in the header for each API call. Clients can also access information about available services and resources through the AvailableResources object. This object provides detailed information about the OS imaging options, the machine size options, the storage volume options, and data center locations which are needed when creating hosts and volumes. + * + * API version: v1 + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package client +// OsServiceImageDownloadHealthSummary Indicates the download health summary of the OS service image. +type OsServiceImageDownloadHealthSummary string + +// List of OSServiceImageDownloadHealthSummary +const ( + OSSERVICEIMAGEDOWNLOADHEALTHSUMMARY_OK OsServiceImageDownloadHealthSummary = "OK" + OSSERVICEIMAGEDOWNLOADHEALTHSUMMARY_WARNING OsServiceImageDownloadHealthSummary = "Warning" + OSSERVICEIMAGEDOWNLOADHEALTHSUMMARY_CRITICAL OsServiceImageDownloadHealthSummary = "Critical" + OSSERVICEIMAGEDOWNLOADHEALTHSUMMARY_UNKNOWN OsServiceImageDownloadHealthSummary = "Unknown" +)