US46899 - Update metal client (#73)

* US46899-Included OS Service Image

* US46899-Refactored v1 models to have separate struct based on the purpose

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed update models

* US46899-Rigenerated client

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed formatting

* US46899-Fixed formatting

* [auto generated] Checking in generated offline HTML doc

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed UpdateHost

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed NewHost

* US46899-Generated client

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed OsServiceImage

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed typo in project

* [auto generated] Checking in generated offline HTML doc

* [auto generated] Checking in generated offline HTML doc

* US46899-Updated services path

* US46899-Fixed generated code

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed typo

* US46899-Fixed generated code

* US46899-Fixed generated code

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed typo on service POST

* [auto generated] Checking in generated offline HTML doc

* US46899-Fixed typo on service update

* [auto generated] Checking in generated offline HTML doc

* US46899-Included space name for service create

* [auto generated] Checking in generated offline HTML doc

---------

Co-authored-by: dbozzato81 <[email protected]>

v1/api/swagger/components/schemas/Algorithm.yaml

@@ -0,0 +1,8 @@
+type: string
+enum:
+  - sha256sum
+  - sha512sum
+description: >-
+  The algorithm used to generate the Image Signature. 
+  Currently sha256sum and sha512sum are supported.
+example: sha512sum

v1/api/swagger/components/schemas/Allocation.yaml

@@ -1,5 +1,12 @@
 type: object
 description: allocation of servers for each PCE service.
+required: 
+  - ResourceType
+  - Total
+  - InstanceFamily
+  - InstanceType
+  - Available
+  - AllocationInfo
 properties:
   ResourceType:
     type: string

v1/api/swagger/components/schemas/AllocationStorage.yaml

@@ -1,5 +1,12 @@
 type: object
 description: Allocation of storage for each PCE service.
+required: 
+  - ResourceType
+  - Total
+  - InstanceFamily
+  - InstanceType
+  - Available
+  - AllocationInfo
 properties:
   ResourceType:
     type: string

v1/api/swagger/components/schemas/AttributeRule.yaml

@@ -0,0 +1,20 @@
+type: object
+description: >-
+  Describes a machine classifier attribute rule.
+required:
+  - Attribute
+  - Value
+  - Operator
+properties:
+  Attribute: 
+    type: string
+    description: The machine attribute.
+    example: model
+  Value: 
+    type: string
+    description: The value for the attribute.
+    example: Gen10
+  Operator:
+    $ref: ClassifierOperator.yaml
+    description: >-
+      Describes the operator used for comparison.

v1/api/swagger/components/schemas/AvailableImage.yaml

@@ -1,5 +1,11 @@
 type: object
 description: Entry describing an available imaging service
+required: 
+  - ID
+  - Category
+  - Flavor
+  - Version
+  - Description
 properties:
   ID:
     type: string

v1/api/swagger/components/schemas/AvailableNetwork.yaml

@@ -1,5 +1,15 @@
 type: object
 description: Entry of a network available within a data center location
+required: 
+  - ID
+  - Name
+  - LocationID
+  - Description
+  - HostUse
+  - Purpose
+  - IPPoolID
+  - VLAN
+  - VNI
 properties:
   ID:
     type: string

v1/api/swagger/components/schemas/AvailableResources.yaml

@@ -1,4 +1,14 @@
 type: object
+required: 
+  - Images 
+  - Locations
+  - Networks
+  - MachineSizes
+  - VolumeFlavors
+  - Volumes
+  - MachineInventory
+  - StorageInventory
+  - SSHKeys
 properties:
   Images:
     type: array

v1/api/swagger/components/schemas/BondMode.yaml

@@ -0,0 +1,9 @@
+type: string
+enum:
+  - ""
+  - none
+  - balance-xor
+  - balance-tlb
+example: "none"
+description: >-
+  Specifies the policy indicating how bonding slaves are used during network transmission.

v1/api/swagger/components/schemas/BootMethod.yaml

@@ -0,0 +1,9 @@
+type: string
+enum:
+  - pxe
+  - uefi-shell
+  - svc-os
+  - na
+example: na
+description: >-
+  Indicates how the service expects the machine to be booted.

v1/api/swagger/components/schemas/ClassifierOperator.yaml

@@ -0,0 +1,20 @@
+type: string
+enum:
+  - contains
+  - containsnocase
+  - omits
+  - omitsnocase
+  - startswith
+  - startswithnocase
+  - endswith
+  - endswithnocase
+  - ==
+  - '!='
+  - <
+  - <=
+  - '>'
+  - '>='
+  - match
+example: contains
+description: >-
+  The operator used for comparison.

v1/api/swagger/components/schemas/DiskPartitions.yaml

@@ -0,0 +1,32 @@
+type: object
+description: Disk partition to be created on the host.
+required:
+  - Device
+  - Description
+  - StartOffset
+  - TableType
+  - Partitions
+properties:
+  Device:
+    type: string
+    example: /dev/sda
+    description: >-
+      Indicates the device name of the disk of the form /dev/sdX as known by the os e.g. /dev/sda
+      This is the default device that will be used to deploy the OS Image to the host.
+      The default value may be overridden when creating the host by a UUID/NAA/EUI 
+      logical volume ID (BootDeviceID).
+  Description:
+    type: string
+  StartOffset:
+    type: integer
+    format: int64
+    example: 0
+    description: >-
+      StartOffset is the offset from the start of the disk to the first partition, 
+      if zero a default of 1 MiB (2048 sectors) will be used, units bytes.
+  TableType:
+    $ref: PartitionTable.yaml
+  Partitions:
+    type: array
+    items:
+      $ref: Partition.yaml

v1/api/swagger/components/schemas/Encoding.yaml

@@ -0,0 +1,7 @@
+type: string
+enum: 
+  - base64
+  - hex
+  - none
+example: base64
+description: Describes how a file's contents may be encoded.

v1/api/swagger/components/schemas/FileInfo.yaml

@@ -0,0 +1,63 @@
+type: object
+description: >-
+  Information about the file associated with the OS service image.
+required:
+  - ID
+  - Path
+  - FileSize
+  - DownloadTimeout
+  - Signature
+  - Algorithm
+  - Expand
+  - DisplayURL
+  - SecureURL
+properties:
+  ID:
+    type: string
+    format: uuid
+    description: >-
+      Unique ID of this FileInfo.
+    example: 046b6c7f-0b8a-43b9-b35d-6489e6daee92
+  Path:
+    type: string
+    description: >-
+      Depending upon the service approach, this is either
+      the mount-path where the file should be placed or 
+      the relative URL where it should be served.
+    example: image.tgz
+  FileSize:
+    type: integer
+    description: >- 
+      Size of the files in bytes.
+    example: 934960345
+  DownloadTimeout:
+    type: integer
+    format: int64
+    description: >-
+      Maximum amount of time in seconds to download the Service image.
+    example: 32000
+  Signature:
+    type: string
+    description: >-
+      The signature (checksum) of the image to download. 
+      This ensure the integrity and authenticity of the images downloaded.
+    example: 5260deb631d6a9f29bca14043d406bea36d704677dff4cae1a4d48dc568406eb
+  Algorithm:
+    $ref: Algorithm.yaml
+  Expand:
+    type: boolean
+    description: >-
+      Indicates if the file is compressed and should be expanded 
+      using the filename suffix in the Path as a guide.
+    example: true
+  DisplayURL:
+    type: string
+    description: >-
+      URL of the file that should be returned in REST response or used for display purpose.
+      The file is downloaded from this URL only when SecureURL is not set.
+    example: s3://bmmas-images20210506193558893900000003/images/linux/ubuntu/18.04-20220404/v2-kiwi-ubuntu18.04-15616.04_appliance.x86_64-1.16.4.tar.gz
+  SecureURL: 
+    type: string
+    description: >-
+      URL of the file that should be kept secret. 
+      If this field is set, it will be used for accessing the file and DisplayURL will be ignored.

v1/api/swagger/components/schemas/FlavorDesc.yaml

@@ -1,5 +1,12 @@
 type: object
 description: Describes the details of machine size or volume flavor
+required: 
+  - Collection
+  - Banner1
+  - Banner2
+  - Bullets
+  - InfoLink
+  - Tooltip
 properties:
   Collection:
     type: string

v1/api/swagger/components/schemas/HealthStatus.yaml

@@ -3,4 +3,4 @@ enum:
   - OK
   - Warning
   - Critical
-  - Unknown
+  - Unknown

v1/api/swagger/components/schemas/Host.yaml

@@ -3,9 +3,37 @@ allOf:
   - type: object
     required:
       - Description
+      - ServiceID
+      - ServiceFlavor
+      - ServiceVersion
+      - LocationID
+      - MachineSizeName
+      - MachineSizeID
+      - MachineID
+      - SSHKeyIDs
+      - SSHAuthorizedKeys
       - NetworkIDs
       - NetworkForDefaultRoute
       - NetworkUntagged
+      - PreAllocatedIPs
+      - ServiceNetsProviderMAC
+      - UserData
+      - NodeID
+      - ISCSIConfig
+      - Connections
+      - Deleted
+      - PortalCommOkay
+      - PowerStatus
+      - State
+      - Substate
+      - StateTime
+      - SubstateTime
+      - Progress
+      - Alert
+      - AlertInfo
+      - Workflow
+      - SummaryStatus
+      - Labels
     properties:
       Description:
         type: string
@@ -162,9 +190,4 @@ allOf:
         $ref: ./HealthStatus.yaml
         description: Host health summary status
       Labels:
-        type: object
-        additionalProperties:
-          type: string
-        description: The map of label name to label value for the host.
-        example:
-          serviceType: BMaaS
+        $ref: ./Labels.yaml

v1/api/swagger/components/schemas/HostAlertInfo.yaml

@@ -1,4 +1,11 @@
 type: object
+required: 
+  - Alert
+  - State
+  - Substate
+  - Message
+  - Time
+  - Ack
 properties:
   Alert:
     type: string

v1/api/swagger/components/schemas/HostConnection.yaml

@@ -1,4 +1,10 @@
 type: object
+required: 
+  - Name
+  - Ports
+  - HA
+  - Speed
+  - Networks
 properties:
   Name:
     type: string

v1/api/swagger/components/schemas/HostISCSIConfig.yaml

@@ -2,6 +2,9 @@ type: object
 nullable: true
 required:
   - InitiatorName
+  - CHAPSecret
+  - CHAPUser
+  - ISCSIDiscoveryAddress
 properties:
   InitiatorName:
     type: string

v1/api/swagger/components/schemas/HostNetworkConnection.yaml

@@ -1,4 +1,17 @@
 type: object
+required: 
+  - Name
+  - NetworkID
+  - IP
+  - Subnet
+  - Netmask
+  - Gateway
+  - DNS
+  - VLAN
+  - VNI
+  - Untagged
+  - Proxy
+  - NoProxy
 properties:
   Name:
     type: string

v1/api/swagger/components/schemas/HostServerPort.yaml

@@ -1,4 +1,7 @@
 type: object
+required: 
+  - Name
+  - HWAddr
 properties:
   Name:
     type: string

v1/api/swagger/components/schemas/HostUsageEntry.yaml

@@ -1,6 +1,11 @@
 allOf:
   - $ref: ./UsageEntryBase.yaml
   - type: object
+    required: 
+      - MachineSizeName
+      - MachineSizeID
+      - HostName
+      - HostID
     properties:
       MachineSizeName:
         type: string