OAuth documentation for GET /api/v2/users/me/ appears inconsistent with required global read scope

Abierto Apto para principiantes
#10,201 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
typescript

Línea de trabajo

Empieza en Developer Docs → API Reference → v2 → Authentication → Who am I y compara el requisito de scope de GET /api/v2/users/me con la respuesta de ejemplo. Comprueba el comportamiento del endpoint o su código fuente para determinar qué scopes son necesarios y cuáles se devuelven. Actualiza la respuesta de ejemplo o añade una explicación para que el ejemplo y el requisito coincidan.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Page:
Developer Docs → API Reference → v2 → Authentication → Who am I

Problem

The documentation states:

"An OAuth token needs the global read scope; a token with only fine-grained scopes such as projects.states:read cannot call it."

However, the example response for the endpoint shows:

"principal_kind": "oauth",
"scopes": [
"projects.work_items:read",
"projects.states:read"
]

These are only fine-grained scopes, which seems to contradict the statement above.

Question

If GET /api/v2/users/me requires the global read scope, why does the sample response show only fine-grained scopes?

Is this:

an incorrect example response,

expected behavior that needs additional explanation?

Suggested improvement

Either:

Update the sample response to include the required global read scope, or

Add a note explaining why the response displays only fine-grained scopes even though the endpoint requires the global read scope.

Thank you!

Lenguaje dominante
TypeScript
Estrellas
61.9k
Forks
6.3k
Merge medio
1 d 18 h
PR fusionados (30 d)
74

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de makeplane/plane

Todos los issues de makeplane/plane

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.