OpenAPI docs: identityname should be identity.name, and token scope admin should be global
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
- 78/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- csharp, openapi
- Área
- api, documentation
Línea de trabajo
Lee las descripciones de los parámetros en src/Exceptionless.Web/Api/Endpoints/EventEndpoints.cs y las descripciones de los ámbitos de los tokens en TokenEndpoints.cs, y compáralas con EventHandler.cs y AuthorizationRoles.cs. Actualiza las descripciones de OpenAPI para que usen identity.name y enumeren client, user, global y source-maps:write; vuelve a generar la instantánea en tests/Exceptionless.Tests/Api/Data/openapi.json. La tarea estará completa cuando las descripciones y la instantánea incluida en el repositorio coincidan con el comportamiento del servidor.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The generated OpenAPI document has two errors that make API calls fail or behave unexpectedly:
- The event submit GET endpoints document an
identitynamequery parameter. The server readsidentity.name. - The token create endpoints say valid scopes are
client, user, admin. The scope is actually namedglobal, andadminis rejected.
Where
identitynamedescriptions: EventEndpoints.cs#L610, #L650, #L682, #L715, #L923- Server parsing: EventHandler.cs#L504-L509
- Scope descriptions: TokenEndpoints.cs#L101, #L122, #L146
- Actual scope names: AuthorizationRoles.cs#L10, #L24; validation in TokenHandler.cs#L222-L244
- Checked-in snapshot: openapi.json#L735, #L906, #L2179, #L2324, #L2633
What happens
GET /api/v2/events/submit?...&[email protected]&identityname=Janestoresidentitynameas a custom data property, and the user's name isn't set.- Creating a token with
"scopes": ["admin"]returns a validation error, "Invalid token scope requested."
Expected
The parameter is documented as identity.name, and the scope descriptions list client, user, global (global admins only), and source-maps:write.
Suggested fix
Rename the parameter key and description in EventEndpoints.cs, fix the three token descriptions, and regenerate openapi.json. Optionally accept identityname as an alias in EventHandler for clients that followed the docs.
- Lenguaje dominante
- C#
- Estrellas
- 2.5k
- Forks
- 508
- Merge medio
- 2 d 17 h
- PR fusionados (30 d)
- 40
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la 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 exceptionless/Exceptionless
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
exceptionless/Exceptionless#2706 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
exceptionless/Exceptionless#2705 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
exceptionless/Exceptionless#2704 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
exceptionless/Exceptionless#2703 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
exceptionless/Exceptionless#2701 ·
Los mantenedores suelen responder en 1 día
Todos los issues de exceptionless/Exceptionless
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día
-
[Bug] Dashboard renders attachment links that resolve to 404 when the FILES binding is absentAbiertobug 優先: 低
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
-
.NET area: storage bug good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Larson-Logan/medal-sync#61 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
Los mantenedores suelen responder en 1 día