-
Notifications
You must be signed in to change notification settings - Fork 73
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add specification for delete roles (#2683)
* Add specification for delete roles
- Loading branch information
Showing
6 changed files
with
298 additions
and
11 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
41 changes: 41 additions & 0 deletions
41
specification/security/bulk_delete_role/SecurityBulkDeleteRoleRequest.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you 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. | ||
*/ | ||
|
||
import { RequestBase } from '@_types/Base' | ||
import { Refresh } from '@_types/common' | ||
|
||
/** | ||
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. | ||
* The bulk delete roles API cannot delete roles that are defined in roles files. | ||
* @rest_spec_name security.bulk_delete_role | ||
* @availability stack since=8.15.0 stability=stable | ||
* @availability serverless stability=stable visibility=private | ||
* @cluster_privileges manage_security | ||
*/ | ||
export interface Request extends RequestBase { | ||
query_parameters: { | ||
refresh?: Refresh | ||
} | ||
body: { | ||
/** | ||
* An array of role names to delete | ||
*/ | ||
names: string[] | ||
} | ||
} |
40 changes: 40 additions & 0 deletions
40
specification/security/bulk_delete_role/SecurityBulkDeleteRoleResponse.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/* | ||
* Licensed to Elasticsearch B.V. under one or more contributor | ||
* license agreements. See the NOTICE file distributed with | ||
* this work for additional information regarding copyright | ||
* ownership. Elasticsearch B.V. licenses this file to you 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. | ||
*/ | ||
|
||
import { Dictionary } from '@spec_utils/Dictionary' | ||
import { ErrorCause } from '@_types/Errors' | ||
import { integer } from '@_types/Numeric' | ||
import { BulkError } from '@security/_types/Bulk' | ||
|
||
export class Response { | ||
body: { | ||
/** | ||
* Array of deleted roles | ||
*/ | ||
deleted?: string[] | ||
/** | ||
* Array of roles that could not be found | ||
*/ | ||
not_found?: string[] | ||
/** | ||
* Present if any deletes resulted in errors | ||
*/ | ||
errors?: BulkError | ||
} | ||
} |