Documentation on well-known actor_id values?
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 58/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- github, openapi
- Área
- api, documentation
Línea de trabajo
Comienza con el endpoint de rulesets de la GitHub REST API y su documentación vinculada, centrándote en bypass_actors.actor_id y actor_type. Verifica qué valores conocidos son estables y aplicables y, después, documenta los valores confirmados, como OrganizationAdmin y DeployKey, además del administrador del repositorio si se admite. Se considera completado cuando la descripción de la API o la documentación enumera claramente los valores y su aplicabilidad.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Coming over from https://docs.github.com/en/rest/repos/rules?apiVersion=2022-11-28#create-a-repository-ruleset--fine-grained-access-tokens > bypass_actors > actor_id:
The ID of the actor that can bypass a ruleset. If
actor_typeisOrganizationAdmin, this should be1. Ifactor_typeisDeployKey, this should benull.OrganizationAdminis not applicable for personal repositories.
That's a good and helpful start on known actor_id values. But there seem to be other well-known -or at least well-defined- values in play. For example, I've found across all repositories I've checked that the Repository admin role is 5.
Is there documentation somewhere on what those well-known actor_id values are? If not, could that be created please?
Context: this is useful for automating creation of branch rulesets. If someone wants to, say, create a standard branch protection for their default branch that exempts repo admins, they'll need to have the actor_id for bypass_actors. Pinging the GitHub API to fetch an ID that's always set to the same value would be extra complexity and time.
- Lenguaje dominante
- Sin datos de lenguaje
- Estrellas
- 1.6k
- Forks
- 342
- Merge medio
- 2 h 23 min
- PR fusionados (30 d)
- 57
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/rest-api-description
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
github/rest-api-description#7220 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
github/rest-api-description#7201 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
github/rest-api-description#7163 ·
-
Runner deprecations: registration_deprecates_at is declared on the response but never returned Abiertofeature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7162 ·
-
feature
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
github/rest-api-description#7135 ·
Todos los issues de github/rest-api-description
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
external-issue to-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
googleapis/google-cloud-swift#1151 ·
-
SqliteSaver.list(filter=...) silently misses nested metadata values containing non-ASCII text Abiertoexternal
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
langchain-ai/langgraph#9074 · 1 comentario ·
-
documentation specification
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
openai/openai-openapi#584 ·