meshery/meshery

[Docs] Missing documentation on how to create a new permission key

Open

#19 568 ouverte le 20 mai 2026

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)HTML (10 013 stars) (3 101 forks)batch import
area/docsframework/hugohelp wantedlanguage/markdown

Description

Summary

While working on adding a permission key for the evaluate action, I went through the two docs shared:

  1. https://docs.meshery.io/reference/permissions/
  2. https://docs.meshery.io/reference/extensibility/authorization/

The first one covers all the existing permission keys, and the second goes into the architecture and how keys are validated in the UI using casl.js, but neither explains how to actually create a new permission key.

What's Missing

  • Guide on how to create a new permission key

Expected

A clear how-to guide so contributors can independently add new permission keys without needing to dig through the codebase.

Contributor Guides and Handbook

Guide contributeur

Stack technique
javascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of Meshery's permission systemFamiliarity with contributing to Meshery docs
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
Review the existing permission documentation at https://docs.meshery.io/reference/permissions/ and https://docs.meshery.io/reference/extensibility/authorization/. Examine the UI authorization implementation using casl.js in the frontend codebase (likely in the ui/ directory). Investigate how existing permission keys are defined and validated in the backend (possibly in the server/ or meshkit/ directories). Look at previous PRs that added permission keys for reference. The guide should step through creating a new key, updating necessary files, and testing. There are 4 comments on the issue that may contain additional context or clarification.