Merge pull request #832 from den-rgb/OCM-3277

OCM-3277 | feat: Added open api model for trusted ips

CHANGES.md

@@ -1,6 +1,8 @@
 # Changes
 
 This document describes the relevant changes between releases of the API model.
+## 0.0.317 September 11 2023
+- Add new resources and type for `TrustedIps`
 
 ## 0.0.316 September 6 2023
 - Add `CIDRBlockp` field to `Subnetwork` and `CloudVPC`

model/clusters_mgmt/v1/root_resource.model

@@ -111,4 +111,9 @@ resource Root {
 	locator NetworkVerifications {
 		target NetworkVerifications
 	}
+
+	// Reference to the resource that manages the collection of trusted ip addresses.
+	locator TrustedIPAddresses {
+		target TrustedIps
+	}
 }

model/clusters_mgmt/v1/trusted_ip_resource.model

@@ -0,0 +1,23 @@
+/*
+Copyright (c) 2023 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Manages a specific trusted ip address.
+resource TrustedIp {
+	// Retrieves the trusted ip adresses.
+	method Get {
+		out Body TrustedIp
+	}
+}

model/clusters_mgmt/v1/trusted_ips_resource.model

@@ -0,0 +1,39 @@
+/*
+Copyright (c) 2023 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Manages the collection of trusted ip addresses of a cluster.
+resource TrustedIps {
+	// Retrieves the list of trusted ip addresses.
+	method List {
+		// Index of the requested page, where one corresponds to the first page.
+		in out Page Integer = 1
+
+		// Number of items contained in the returned page.
+		in out Size Integer = 100
+
+		// Total number of items of the collection.
+		out Total Integer
+
+		// Retrieved list of trusted ip addresses.
+		out Items []TrustedIp
+	}
+
+	// Reference to the resource that manages a specific trusted Ip address.
+	locator TrustedIp {
+		target TrustedIp
+		variable ID
+	}
+}

model/clusters_mgmt/v1/trusted_ips_type.model

@@ -0,0 +1,21 @@
+/*
+Copyright (c) 2023 Red Hat, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Representation of a trusted ip address in clusterdeployment.
+class TrustedIp {
+	// The boolean set to show if the ip is enabled.
+	Enabled Boolean
+}