Skip to content

Commit

Permalink
Merge pull request #878 from chenz4027/OCM-5156
Browse files Browse the repository at this point in the history
OCM-5156 | add search and order param to nodepools
  • Loading branch information
andreadecorte authored Dec 8, 2023
2 parents 9d74417 + 068754d commit 7d5fccd
Showing 1 changed file with 56 additions and 26 deletions.
82 changes: 56 additions & 26 deletions model/clusters_mgmt/v1/node_pools_resource.model
Original file line number Diff line number Diff line change
Expand Up @@ -16,30 +16,60 @@ limitations under the License.

// Manages the collection of node pools of a cluster.
resource NodePools {
// Retrieves the list of node pools.
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 node pools.
out Items []NodePool
}

// Adds a new node pool to the cluster.
method Add {
// Description of the node pool
in out Body NodePool
}

// Reference to the service that manages a specific node pool.
locator NodePool {
target NodePool
variable ID
}
// Retrieves the list of node pools.
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

// Search criteria.
//
// The syntax of this parameter is similar to the syntax of the _where_ clause of a
// SQL statement, but using the names of the attributes of the node pools instead of
// the names of the columns of a table. For example, in order to retrieve all the
// node pools with replicas of two the following is required:
//
// ```sql
// replicas = 2
// ```
//
// If the parameter isn't provided, or if the value is empty, then all the
// node pools that the user has permission to see will be returned.
in Search String

// Order criteria.
//
// The syntax of this parameter is similar to the syntax of the _order by_ clause of
// a SQL statement, but using the names of the attributes of the node pools instead of
// the names of the columns of a table. For example, in order to sort the node pools
// descending by identifier the value should be:
//
// ```sql
// id desc
// ```
//
// If the parameter isn't provided, or if the value is empty, then the order of the
// results is undefined.
in Order String

// Total number of items of the collection.
out Total Integer

// Retrieved list of node pools.
out Items []NodePool
}

// Adds a new node pool to the cluster.
method Add {
// Description of the node pool
in out Body NodePool
}

// Reference to the service that manages a specific node pool.
locator NodePool {
target NodePool
variable ID
}
}

0 comments on commit 7d5fccd

Please sign in to comment.