Docs add permission key guide by rishiraj38 · Pull Request #19620 · meshery/meshery

rishiraj38 · 2026-05-22T17:31:35Z

Description

This PR updates the Adding a New Permission Key documentation section to align with the new schema-driven dynamic authorization workflow.

What is changing?

Authoritative Spreadsheet: Documented that the Google Spreadsheet serves as the single source of truth for all permission keys.
Schemas Automation Workflow: Linked the generate-artifacts-from-schemas.yml workflow which automates importing from the spreadsheet, updating permissions.csv, and generating Go and TypeScript files.
Direct UI Consumption: Replaced the guide on manual permission_constants.ts mappings. Instructed developers to directly import Keys from @meshery/schemas/permissions in components and perform checks using the overloaded CAN(Keys.SomeKey) signature.
Pre-verified Build: Validated formatting via local Hugo build.

This PR fixes #19568

Signed commits

Yes, I signed my commits.

gemini-code-assist

Code Review

This pull request introduces a comprehensive guide for adding new permission keys to the extensible authorization system, covering the entire workflow from UUID generation to integration in Go and TypeScript. The review feedback identifies a semantic inconsistency in the Go code examples, suggesting that "Forbidden" be used instead of "Unauthorized" when paired with the 403 status code.

github-actions · 2026-05-22T18:07:27Z

PR Preview Action v1.6.3
Preview removed because the pull request was closed.
2026-07-08 22:42 UTC

hamza-mohd · 2026-05-22T23:12:42Z

Great docs addition. Consider including a minimal working example showing the permission key in context so contributors can quickly see it in action.

hamza-mohd · 2026-05-22T23:13:23Z

Helpful addition. Could you include a short manifest example so readers see the full format end-to-end?

rishiraj38 · 2026-05-23T18:27:30Z

Helpful addition. Could you include a short manifest example so readers see the full format end-to-end?

Thanks for the suggestion! I’ve added a short manifest example to show the complete format end-to-end.

rishiraj38 · 2026-05-23T18:32:25Z

@aabidsofi19 Please take a look when you get a chance.

rishiraj38 · 2026-05-31T07:44:55Z

+
+Each permission key requires a globally unique UUID v4:
+
+{{< code code=`uuidgen | tr '[:upper:]' '[:lower:]'` >}}


Do we have a Make command for generating this UUID? I searched around but couldn't find one. If we do have a dedicated command, it might be better to reference that instead of using the shell command directly.

github-actions · 2026-06-10T13:50:15Z

❌ Docs preview build failed for Build and Preview Docs.
Please review the workflow logs for remediation details.

Signed-off-by: Rishi Raj <[email protected]>

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Rishi Raj <[email protected]>

Signed-off-by: Rishi Raj <[email protected]>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.

Signed-off-by: Rishi Raj <[email protected]>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Signed-off-by: Rishi Raj <[email protected]>

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

+*   **Local Provider**: Set to `TRUE` if this key should be seeded for the Local Provider database.
+
+##### Step 3: Run the Schema Sync & Generation Workflow
+Once added to the spreadsheet, the GitHub Actions workflow [`generate-artifacts-from-schemas.yml`](https://github.com/meshery/schemas/blob/master/.github/workflows/generate-artifacts-from-schemas.yml) in `meshery/schemas` runs automatically on a daily schedule (and can also be triggered manually) to sync the spreadsheet keys to the local [`build/permissions.csv`](https://github.com/meshery/schemas/blob/master/build/permissions.csv).


+1. Run `make ui-lint` to verify that there are no formatting or typescript errors.
+2. Restart Meshery Server (or reset database settings) to seed the local provider with the new key.
+3. Login and verify that your UI component gates correctly.


rishiraj38 marked this pull request as draft May 22, 2026 17:31

github-actions Bot added the area/docs Documentation update needed label May 22, 2026

gemini-code-assist Bot reviewed May 22, 2026

View reviewed changes

Comment thread docs/content/en/reference/extensibility/authorization/index.md Resolved

Comment thread docs/content/en/reference/extensibility/authorization/index.md Resolved

rishiraj38 marked this pull request as ready for review May 23, 2026 18:35

rishiraj38 commented May 31, 2026

View reviewed changes

rishiraj38 and others added 8 commits June 12, 2026 18:09

[Docs] Add step-by-step guide for adding permission keys

7c57008

Signed-off-by: Rishi Raj <[email protected]>

[Docs] Update permission usage to show CAN utility in React UI

6a7c00d

Signed-off-by: Rishi Raj <[email protected]>

Update docs/content/en/reference/extensibility/authorization/index.md

6d5a9f8

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Rishi Raj <[email protected]>

Update docs/content/en/reference/extensibility/authorization/index.md

7725e12

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Rishi Raj <[email protected]>

[Docs] Improve step heading formatting to prevent text merging

90d2aa4

Signed-off-by: Rishi Raj <[email protected]>

[Docs] Add permission examples

29aba7f

Signed-off-by: Rishi Raj <[email protected]>

document permission storage and troubleshooting

8e10786

Signed-off-by: Rishi Raj <[email protected]>

[Docs] Refine and sort extensibility authorization guide

ae654d6

Signed-off-by: Rishi Raj <[email protected]>

rishiraj38 force-pushed the docs-add-permission-key-guide branch from 64f5f25 to ae654d6 Compare June 12, 2026 12:41

Merge branch 'master' into docs-add-permission-key-guide

60f08c7

Copilot AI review requested due to automatic review settings June 24, 2026 12:39

Copilot started reviewing on behalf of rishiraj38 June 24, 2026 12:40

View session

This comment was marked as outdated.

Sign in to view

rishiraj38 marked this pull request as draft June 29, 2026 14:36

rishiraj38 and others added 2 commits July 3, 2026 21:58

Merge branch 'master' into docs-add-permission-key-guide

f323c1d

[Docs] Update authorization guide for dynamic permission keys

9522a2a

Signed-off-by: Rishi Raj <[email protected]>

rishiraj38 marked this pull request as ready for review July 3, 2026 17:03

Copilot AI review requested due to automatic review settings July 3, 2026 17:03

Copilot started reviewing on behalf of rishiraj38 July 3, 2026 17:03

View session

Copilot AI reviewed Jul 3, 2026

View reviewed changes

rishiraj38 added 2 commits July 3, 2026 22:46

[Docs] Address Copilot PR review comments for authorization guide

4754d08

Signed-off-by: Rishi Raj <[email protected]>

[Docs] Document key naming and scoping conventions

240b0a4

Signed-off-by: Rishi Raj <[email protected]>

Copilot AI review requested due to automatic review settings July 3, 2026 17:22

Copilot started reviewing on behalf of rishiraj38 July 3, 2026 17:22

View session

rishiraj38 requested review from NSTKrishna, banana-three-join, chaitanyamedidar and saurabhraghuvanshii July 3, 2026 17:25

Copilot AI reviewed Jul 3, 2026

View reviewed changes

Comment thread docs/content/en/reference/extensibility/authorization/index.md Resolved

Comment thread docs/content/en/reference/extensibility/authorization/index.md Resolved

Comment thread docs/content/en/reference/extensibility/authorization/index.md Resolved

banana-three-join reviewed Jul 3, 2026

View reviewed changes

“applied-suggestions”

40c4acd

Signed-off-by: Rishi Raj <[email protected]>

rishiraj38 requested a review from YASHMAHAKAL July 4, 2026 13:29

NSTKrishna approved these changes Jul 4, 2026

View reviewed changes

Merge branch 'master' into docs-add-permission-key-guide

78ebff3

Copilot AI review requested due to automatic review settings July 8, 2026 18:23

Copilot started reviewing on behalf of rishiraj38 July 8, 2026 18:23

View session

Copilot AI reviewed Jul 8, 2026

View reviewed changes

leecalcote merged commit 67fb480 into meshery:master Jul 8, 2026
3 checks passed

coderabbitai Bot mentioned this pull request Aug 2, 2026

[Blog] Add post on permission key migration and PermissionShield integration meshery/meshery.io#2850

Open

1 task done


		Each permission key requires a globally unique UUID v4:

		{{< code code=`uuidgen \| tr '[:upper:]' '[:lower:]'` >}}

Conversation

rishiraj38 commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What is changing?

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hamza-mohd commented May 22, 2026

Uh oh!

hamza-mohd commented May 22, 2026

Uh oh!

rishiraj38 commented May 23, 2026

Uh oh!

rishiraj38 commented May 23, 2026

Uh oh!

rishiraj38 May 31, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 10, 2026

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rishiraj38 commented May 22, 2026 •

edited

Loading

github-actions Bot commented May 22, 2026 •

edited

Loading