nutanix_clustermgmt 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9fa698270f26407706dc64a3fb4558c82f68e42fbb77845f5749dd7ad850d91
-  data.tar.gz: ee3f57b6e71cac870a988ab6f5c6aaa88eabd851bc1cf180cc47e6f23534ac7c
+  metadata.gz: 54069c8875f9785a079f551d463876d3f3f1a6ecc00ad80d5da082a068e5b2d0
+  data.tar.gz: 456000c6281864ee2584f527e1a169a3069ec3f2aa35de3ca6cd97daaf4b54ea
 SHA512:
-  metadata.gz: ebf39a39bf5261dbe6ab1053666696b22cc6264950b888f62464cf45443d1b4f5c72acb83d998d69c5a9b40c93611d12691e3b9c5efbaa896a12593bab53b678
-  data.tar.gz: 12391d85f5ef25faea81d4a0e704a69cd7864bd418eac3bc51798511aa8361c861a980eb9419042f5e4413905db9f21113feca3125ab32847907d7f9e789610e
+  metadata.gz: 80326ee814e1f5a05d72782cf38d97b469c3cae706d845b1fc60ab0b10b229f086ec4eef6fcc87b60e6ca7ffdcdaf23a0c7c084625bc1bfab7722fc6df661e00
+  data.tar.gz: 233f225376d710fcd2a1b5394085942dc3ecee30a62dce9556f8b66bf12c33d2229eec3d85726c156df676f9cac482996bc69d85e68dc6adeaf10e851f23ca6f

data/CHANGELOG.md

@@ -4,10 +4,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
-## [0.1.2] - 2026-05-01
-### Fixed
-- Drop docs from published gem ([#27](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/27))
-- Use git ls-files -z for gemspec files list ([#20](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/20))
+## [0.2.0] - 2025-11-24
+### Added
+- Add GitHub Action to autogenerate from the openapi spec ([#12](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/12))
+- Add ability to one off ci jobs. ([#15](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/15))
+
+### Changed
+- Update actions/checkout action to v5 ([#11](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/11))
+- Update nutanix_clustermgmt gem ([#13](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/13))
+- Update the PR body to point to the dev page and not a direct download ([#14](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/14))
+- Update openapi generator to `v7.17.0` to use `api_model_base` ([#16](https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/pull/16))
 
 ## [0.1.1] - 2025-07-19
 ### Fixed
@@ -17,6 +23,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Initial release
 
-[0.1.2]: https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/compare/v0.1.1...v0.1.2
+[0.2.0]: https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/ManageIQ/nutanix_clustermgmt-sdk-ruby/tree/v0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -8,7 +8,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 
 - API version: 4.0.2
 - Package version: 1.0.0
-- Generator version: 7.9.0
+- Generator version: 7.17.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nutanix_clustermgmt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/openapi-generate

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+if [ -z "$INPUT_SPEC_VERSION" ]; then
+  echo "ERROR: INPUT_SPEC_VERSION must be set"
+  exit 1
+fi
+
+if [ -z "$OPENAPI_GENERATOR_JAR" ]; then
+  # Detect the latest version of the openapi-generator-cli package
+  version=`wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/maven-metadata.xml -O - 2>/dev/null | xq -x "//metadata/versioning/latest"`
+  OPENAPI_GENERATOR_JAR=openapi-generator-cli-$version.jar
+
+  # Download the openapi-generator-cli jar if we don't already have it locally
+  if [ ! -f "$OPENAPI_GENERATOR_JAR" ]; then
+    echo "Downloading '$OPENAPI_GENERATOR_JAR'..."
+    wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/$version/$OPENAPI_GENERATOR_JAR
+  fi
+fi
+
+# Clear out any existing files in paths that are autogenerated to prevent deleted files
+# from remaining after running the generate
+rm -rf ./docs ./lib ./spec
+
+# Generate the gem from the current openapi-spec
+input_spec=https://developers.nutanix.com/api/v1/namespaces/clustermgmt/versions/$INPUT_SPEC_VERSION/yaml
+java -jar $OPENAPI_GENERATOR_JAR generate --input-spec $input_spec --skip-validate-spec --generator-name ruby --config .openapi-config.json

data/docs/AddDisk202Response.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AddDisk202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**PrismV40ConfigTaskReference**](PrismV40ConfigTaskReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AddDisk202Response.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/AddDisk4XXResponse.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AddDisk4XXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**ClustermgmtV40ErrorErrorResponse**](ClustermgmtV40ErrorErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AddDisk4XXResponse.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/AddSnmpTransport202Response.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AddSnmpTransport202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**PrismV40ConfigTaskReference**](PrismV40ConfigTaskReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AddSnmpTransport202Response.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/AddSnmpTransport4XXResponse.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AddSnmpTransport4XXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**ClustermgmtV40ErrorErrorResponse**](ClustermgmtV40ErrorErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AddSnmpTransport4XXResponse.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/ApplyClusterProfile202Response.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::ApplyClusterProfile202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**PrismV40ConfigTaskReference**](PrismV40ConfigTaskReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::ApplyClusterProfile202Response.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/ApplyClusterProfile4XXResponse.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::ApplyClusterProfile4XXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**ClustermgmtV40ErrorErrorResponse**](ClustermgmtV40ErrorErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::ApplyClusterProfile4XXResponse.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/AssociateCategoriesToCluster202Response.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AssociateCategoriesToCluster202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**PrismV40ConfigTaskReference**](PrismV40ConfigTaskReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AssociateCategoriesToCluster202Response.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/AssociateCategoriesToCluster4XXResponse.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::AssociateCategoriesToCluster4XXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**ClustermgmtV40ErrorErrorResponse**](ClustermgmtV40ErrorErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::AssociateCategoriesToCluster4XXResponse.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/BmcApi.md

@@ -0,0 +1,169 @@
+# NutanixClustermgmt::BmcApi
+
+All URIs are relative to *https://:9440/api*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_bmc_info**](BmcApi.md#get_bmc_info) | **GET** /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{extId}/bmc-info | Get BMC details |
+| [**update_bmc_info**](BmcApi.md#update_bmc_info) | **PUT** /clustermgmt/v4.0/config/clusters/{clusterExtId}/hosts/{extId}/bmc-info | Update BMC info summary |
+
+
+## get_bmc_info
+
+> <GetBmcInfo200Response> get_bmc_info(cluster_ext_id, ext_id)
+
+Get BMC details
+
+Get BMC details of a host
+
+### Examples
+
+```ruby
+require 'time'
+require 'nutanix_clustermgmt'
+# setup authorization
+NutanixClustermgmt.configure do |config|
+  # Configure API key authorization: apiKeyAuthScheme
+  config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
+
+  # Configure HTTP basic authorization: basicAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = NutanixClustermgmt::BmcApi.new
+cluster_ext_id = '960de8e0-115b-4bb8-b263-e69bd907a6f4' # String | Cluster UUID
+ext_id = '9241b35f-1ba4-4f8a-b6a1-9ee30de274c6' # String | Host UUID
+
+begin
+  # Get BMC details
+  result = api_instance.get_bmc_info(cluster_ext_id, ext_id)
+  p result
+rescue NutanixClustermgmt::ApiError => e
+  puts "Error when calling BmcApi->get_bmc_info: #{e}"
+end
+```
+
+#### Using the get_bmc_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetBmcInfo200Response>, Integer, Hash)> get_bmc_info_with_http_info(cluster_ext_id, ext_id)
+
+```ruby
+begin
+  # Get BMC details
+  data, status_code, headers = api_instance.get_bmc_info_with_http_info(cluster_ext_id, ext_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetBmcInfo200Response>
+rescue NutanixClustermgmt::ApiError => e
+  puts "Error when calling BmcApi->get_bmc_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_ext_id** | **String** | Cluster UUID |  |
+| **ext_id** | **String** | Host UUID |  |
+
+### Return type
+
+[**GetBmcInfo200Response**](GetBmcInfo200Response.md)
+
+### Authorization
+
+[apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_bmc_info
+
+> <UpdateBmcInfo202Response> update_bmc_info(cluster_ext_id, ext_id, if_match, ntnx_request_id, clustermgmt_v40_config_bmc_info)
+
+Update BMC info summary
+
+Update BMC info
+
+### Examples
+
+```ruby
+require 'time'
+require 'nutanix_clustermgmt'
+# setup authorization
+NutanixClustermgmt.configure do |config|
+  # Configure API key authorization: apiKeyAuthScheme
+  config.api_key['X-ntnx-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-ntnx-api-key'] = 'Bearer'
+
+  # Configure HTTP basic authorization: basicAuthScheme
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = NutanixClustermgmt::BmcApi.new
+cluster_ext_id = 'ed880147-2ee6-4e21-82f1-84c87133dff8' # String | Cluster UUID
+ext_id = 'c43707cf-64fe-4164-a3b3-68f89628d7d8' # String | Host UUID
+if_match = 'if_match_example' # String | The If-Match request header makes the request conditional. When not provided, the server will respond with  an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned.
+ntnx_request_id = 'b1e2f9c3-c419-40fa-9e25-02c3cd026e07' # String | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request. 
+clustermgmt_v40_config_bmc_info = NutanixClustermgmt::ClustermgmtV40ConfigBmcInfo.new # ClustermgmtV40ConfigBmcInfo | Update BMC info body
+
+begin
+  # Update BMC info summary
+  result = api_instance.update_bmc_info(cluster_ext_id, ext_id, if_match, ntnx_request_id, clustermgmt_v40_config_bmc_info)
+  p result
+rescue NutanixClustermgmt::ApiError => e
+  puts "Error when calling BmcApi->update_bmc_info: #{e}"
+end
+```
+
+#### Using the update_bmc_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateBmcInfo202Response>, Integer, Hash)> update_bmc_info_with_http_info(cluster_ext_id, ext_id, if_match, ntnx_request_id, clustermgmt_v40_config_bmc_info)
+
+```ruby
+begin
+  # Update BMC info summary
+  data, status_code, headers = api_instance.update_bmc_info_with_http_info(cluster_ext_id, ext_id, if_match, ntnx_request_id, clustermgmt_v40_config_bmc_info)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateBmcInfo202Response>
+rescue NutanixClustermgmt::ApiError => e
+  puts "Error when calling BmcApi->update_bmc_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cluster_ext_id** | **String** | Cluster UUID |  |
+| **ext_id** | **String** | Host UUID |  |
+| **if_match** | **String** | The If-Match request header makes the request conditional. When not provided, the server will respond with  an HTTP-428 (Precondition Required) response code indicating that the server requires the request to be conditional. The server will allow the successful completion of PUT and PATCH operations, if the resource matches the ETag value returned to the response of a GET operation. If the conditional does not match, then an HTTP-412 (Precondition Failed) response will be returned. |  |
+| **ntnx_request_id** | **String** | A unique identifier that is associated with each request. The provided value must be opaque and preferably in Universal Unique Identifier (UUID) format. This identifier is also used as an idempotence token for safely retrying requests in case of network errors. All the supported Nutanix API clients add this auto-generated request identifier to each request.  |  |
+| **clustermgmt_v40_config_bmc_info** | [**ClustermgmtV40ConfigBmcInfo**](ClustermgmtV40ConfigBmcInfo.md) | Update BMC info body |  |
+
+### Return type
+
+[**UpdateBmcInfo202Response**](UpdateBmcInfo202Response.md)
+
+### Authorization
+
+[apiKeyAuthScheme](../README.md#apiKeyAuthScheme), [basicAuthScheme](../README.md#basicAuthScheme)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CheckHypervisorRequirements202Response.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::CheckHypervisorRequirements202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**PrismV40ConfigTaskReference**](PrismV40ConfigTaskReference.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::CheckHypervisorRequirements202Response.new(
+  metadata: null,
+  data: null
+)
+```
+

data/docs/CheckHypervisorRequirements4XXResponse.md

@@ -0,0 +1,20 @@
+# NutanixClustermgmt::CheckHypervisorRequirements4XXResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**CommonV10ResponseApiResponseMetadata**](CommonV10ResponseApiResponseMetadata.md) |  | [optional] |
+| **data** | [**ClustermgmtV40ErrorErrorResponse**](ClustermgmtV40ErrorErrorResponse.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'nutanix_clustermgmt'
+
+instance = NutanixClustermgmt::CheckHypervisorRequirements4XXResponse.new(
+  metadata: null,
+  data: null
+)
+```
+