meshery/meshery

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

Open

#19.568 aberto em 20 de mai. de 2026

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)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

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic understanding of Meshery's permission systemFamiliarity with contributing to Meshery docs
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
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.