Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[HTTP/OAS] Add descriptions for role management APIs #184265

Merged
merged 7 commits into from
May 30, 2024
Merged

[HTTP/OAS] Add descriptions for role management APIs #184265

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a467047
[HTTP/OAS] Add descriptions for role management APIs
lcawl May 24, 2024
3fd3564
Add user session management API
lcawl May 24, 2024
cd1148c
Remove access option
lcawl May 28, 2024
745f9e5
Merge branch 'main' into role-mgmt-descriptions
lcawl May 28, 2024
e5bb58d
fix: update session invalidate route test to account for added descri…
azasypkin May 29, 2024
deca968
Merge branch 'main' into role-mgmt-descriptions
kibanamachine May 29, 2024
2f8f05b
Merge branch 'main' into role-mgmt-descriptions
lcawl May 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions x-pack/plugins/security/server/routes/authorization/roles/delete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ export function defineDeleteRolesRoutes({ router }: RouteDefinitionParams) {
router.delete(
{
path: '/api/security/role/{name}',
options: {
access: 'public',
lcawl marked this conversation as resolved.
Show resolved Hide resolved
description: `Delete a role`,
},
validate: {
params: schema.object({ name: schema.string({ minLength: 1 }) }),
},
Expand Down
4 changes: 4 additions & 0 deletions x-pack/plugins/security/server/routes/authorization/roles/get.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ export function defineGetRolesRoutes({
router.get(
{
path: '/api/security/role/{name}',
options: {
access: 'public',
description: `Get a role`,
},
validate: {
params: schema.object({ name: schema.string({ minLength: 1 }) }),
},
Expand Down
9 changes: 8 additions & 1 deletion x-pack/plugins/security/server/routes/authorization/roles/get_all.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ export function defineGetAllRolesRoutes({
config,
}: RouteDefinitionParams) {
router.get(
{ path: '/api/security/role', validate: false },
{
path: '/api/security/role',
options: {
access: 'public',
description: `Get all roles`,
},
validate: false,
},
createLicensedRouteHandler(async (context, request, response) => {
try {
const hideReservedRoles = buildFlavor === 'serverless';
Expand Down
4 changes: 4 additions & 0 deletions x-pack/plugins/security/server/routes/authorization/roles/put.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ export function definePutRolesRoutes({
router.put(
{
path: '/api/security/role/{name}',
options: {
access: 'public',
description: `Create or update a role`,
},
validate: {
params: schema.object({ name: schema.string({ minLength: 1, maxLength: 1024 }) }),
query: schema.object({ createOnly: schema.boolean({ defaultValue: false }) }),
Expand Down
6 changes: 5 additions & 1 deletion x-pack/plugins/security/server/routes/session_management/invalidate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ export function defineInvalidateSessionsRoutes({ router, getSession }: RouteDefi
),
}),
},
options: { tags: ['access:sessionManagement'] },
options: {
tags: ['access:sessionManagement'],
access: 'public',
description: `Invalidate user sessions`,
},
},
async (_context, request, response) => {
return response.ok({
Expand Down