Skip to content

Commit

Permalink
Merge pull request #926 from andreadecorte/OCM-7027
Browse files Browse the repository at this point in the history
OCM-7027 | feat: document pagination and ordering support for break glass
  • Loading branch information
andreadecorte authored Apr 10, 2024
2 parents b08464d + 395bd9f commit c225dbe
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions model/clusters_mgmt/v1/break_glass_credentials_resource.model
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,43 @@ limitations under the License.
// Manages the break glass credentials of a cluster.
resource BreakGlassCredentials {
// Retrieves the list of break glass credentials.
//
// IMPORTANT: This collection doesn't currently support paging or searching, so the returned
// `page` will always be 1 and `size` and `total` will always be the total number of break
// glass credentials for this cluster.
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 break glass credentials
// instead of the names of the columns of a table. For example, in order to retrieve all
// the credentials with a specific username and status the following is required:
//
// ```sql
// username='user1' AND status='expired'
// ```
//
// If the parameter isn't provided, or if the value is empty, then all the
// break glass credentials 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 break glass credentials
// instead of the the names of the columns of a table. For example, in order to sort the
// credentials 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

Expand Down

0 comments on commit c225dbe

Please sign in to comment.