From 104263b3342415702566c21eb185dccc90f62216 Mon Sep 17 00:00:00 2001 From: Denis Date: Fri, 15 Nov 2024 11:45:09 -0600 Subject: [PATCH] Included controller ID in the location object returned by the available resources API (#138) * Included controller ID in the location object returned by the available resources API * [auto generated] Checking in generated offline HTML doc --------- Co-authored-by: dbozzato81 --- .../components/schemas/LocationInfo.yaml | 5 +++++ v1/html/index.html | 6 +++--- v1/pkg/client/api/openapi.yaml | 18 ++++++++++++++++++ v1/pkg/client/docs/LocationInfo.md | 1 + v1/pkg/client/model_location_info.go | 2 ++ 5 files changed, 29 insertions(+), 3 deletions(-) diff --git a/v1/api/swagger/components/schemas/LocationInfo.yaml b/v1/api/swagger/components/schemas/LocationInfo.yaml index aab42a03..03198a17 100644 --- a/v1/api/swagger/components/schemas/LocationInfo.yaml +++ b/v1/api/swagger/components/schemas/LocationInfo.yaml @@ -9,6 +9,7 @@ required: - DataCenter - PrivateNetworkVIDSupport - PrivateNetworkVNISupport + - ControllerID properties: ID: type: string @@ -30,3 +31,7 @@ properties: PrivateNetworkVNISupport: type: boolean description: Indicates whether or not the fabric dedicated for private networks supports VNI ID. + ControllerID: + type: string + format: uuid + description: Unique ID for the controller that manages the data center. \ No newline at end of file diff --git a/v1/html/index.html b/v1/html/index.html index ecbee128..5db99670 100644 --- a/v1/html/index.html +++ b/v1/html/index.html @@ -2888,7 +2888,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "Images": [
    ],
  • "Locations": [
    ],
  • "Networks": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Volumes": [
    ],
  • "MachineInventory": [
    ],
  • "StorageInventory": [
    ],
  • "SSHKeys": [
    ],
  • "StoragePools": [
    ],
  • "VolumeCollections": [
    ]
}

projects-info

Operations related to listing information related to projects.

+
https://client.greenlake.hpe.com{basePath}/available-resources

Response samples

Content type
application/json
{
  • "Images": [
    ],
  • "Locations": [
    ],
  • "Networks": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Volumes": [
    ],
  • "MachineInventory": [
    ],
  • "StorageInventory": [
    ],
  • "SSHKeys": [
    ],
  • "StoragePools": [
    ],
  • "VolumeCollections": [
    ]
}

projects-info

Operations related to listing information related to projects.

List of all projects info within an organization or cluster for which user is authorized.

Returns an object with information on projects, machine sizes, and volume flavors. The 'Projects' list includes projects authorized for a user, and the 'MachineSizes' and 'VolumeFlavors' list include only those machine sizes and volume flavors permitted for projects. When GreenLake Cloud Services IAM issued token is used for authentication, it is required to pass either 'Space' or 'spaceid' header. When both are set, 'Space' header is ignored. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

@@ -2901,7 +2901,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "Projects": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Summary": {
    }
}

ippools

Operations related to IP pools.

+
https://client.greenlake.hpe.com{basePath}/projects-info

Response samples

Content type
application/json
{
  • "Projects": [
    ],
  • "MachineSizes": [
    ],
  • "VolumeFlavors": [
    ],
  • "Summary": {
    }
}

ippools

Operations related to IP pools.

List all ip pools in project

Returns an array of all ip pool objects defined within the project. If GreenLake Platform IAM issued token is used for authentication, then it is required to pass 'X-Role' and 'X-Workspaceid' headers.

Authorizations:
(BearerAuthProject) (BearerAuthMembership)
header Parameters
X-Role
string
Example: metal-infra-admin

GreenLake Platform role name

X-Workspaceid
string
Example: 1a2ba81600dd11efa47076a3447ec4eb

GreenLake Platform workspace ID

@@ -3057,7 +3057,7 @@

Option 2: Getting the token directly from UI

Response samples

Content type
application/json
{
  • "message": "string",
  • "details": "string"
}