Skip to content

feat: add slug to v1/listPermissions and v1/getPermission #3466

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

Merged
mcstepp merged 5 commits into from
Jul 7, 2025
Merged

feat: add slug to v1/listPermissions and v1/getPermission #3466

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
45d5242
feat: include slug in the listPermissions response
mcstepp Jul 7, 2025
e1b6081
feat: add slug to getPermission response
mcstepp Jul 7, 2025
efabbf9
Merge branch 'main' into ENG-1879-list-permissions
mcstepp Jul 7, 2025
a32d353
Merge branch 'main' into ENG-1879-list-permissions
mcstepp Jul 7, 2025
dd8f039
[autofix.ci] apply automated fixes
autofix-ci[bot] Jul 7, 2025
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
1 change: 1 addition & 0 deletions apps/api/src/routes/v1_permissions_getPermission.happy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ test("return the role", async (t) => {
expect(res.status, `expected 200, received: ${JSON.stringify(res, null, 2)}`).toBe(200);
expect(res.body.id).toEqual(permission.id);
expect(res.body.name).toEqual(permission.name);
expect(res.body.slug).toEqual(permission.slug);
expect(res.body.description).toBeUndefined();
});
5 changes: 5 additions & 0 deletions apps/api/src/routes/v1_permissions_getPermission.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ const route = createRoute({
description: "The name of the permission.",
example: "domain.record.manager",
}),
slug: z.string().openapi({
description: "The slug of the permission",
example: "domain-record-manager",
}),
description: z.string().optional().openapi({
description:
"The description of what this permission does. This is just for your team, your users will not see this.",
Expand Down Expand Up @@ -75,6 +79,7 @@ export const registerV1PermissionsGetPermission = (app: App) =>
return c.json({
id: permission.id,
name: permission.name,
slug: permission.slug,
description: permission.description ?? undefined,
});
});
1 change: 1 addition & 0 deletions apps/api/src/routes/v1_permissions_listPermissions.happy.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,6 @@ test("return all permissions", async (t) => {
expect(res.body.length).toBe(1);
expect(res.body[0].id).toEqual(permission.id);
expect(res.body[0].name).toEqual(permission.name);
expect(res.body[0].slug).toEqual(permission.slug);
expect(res.body[0].description).toBeUndefined();
});
5 changes: 5 additions & 0 deletions apps/api/src/routes/v1_permissions_listPermissions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ const route = createRoute({
description: "The name of the permission.",
example: "domain.record.manager",
}),
slug: z.string().openapi({
description: "The slug of the permission",
example: "domain-record-manager",
}),
description: z.string().optional().openapi({
description:
"The description of what this permission does. This is just for your team, your users will not see this.",
Expand Down Expand Up @@ -62,6 +66,7 @@ export const registerV1PermissionsListPermissions = (app: App) =>
permissions.map((p) => ({
id: p.id,
name: p.name,
slug: p.slug,
description: p.description ?? undefined,
})),
);
Expand Down
Loading