Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

OpenAPI docs: identityname should be identity.name, and token scope admin should be global

Aperta Adatta ai principianti
  • Qualcosa non va?
#2,707 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
78/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
csharp, openapi
Ambito
api, documentation

Direzione di ricerca

Leggi le descrizioni dei parametri in src/Exceptionless.Web/Api/Endpoints/EventEndpoints.cs e le descrizioni degli scope dei token in TokenEndpoints.cs, confrontandole con EventHandler.cs e AuthorizationRoles.cs. Aggiorna le descrizioni OpenAPI in modo che usino identity.name ed elenchino client, user, global e source-maps:write; rigenera lo snapshot in tests/Exceptionless.Tests/Api/Data/openapi.json. Il lavoro è completato quando le descrizioni e lo snapshot incluso nel repository corrispondono al comportamento del server.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug documentation

The generated OpenAPI document has two errors that make API calls fail or behave unexpectedly:

  1. The event submit GET endpoints document an identityname query parameter. The server reads identity.name.
  2. The token create endpoints say valid scopes are client, user, admin. The scope is actually named global, and admin is rejected.

Where

What happens

  • GET /api/v2/events/submit?...&[email protected]&identityname=Jane stores identityname as 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.

Lingua principale
C#
Stelle
2.5k
Fork
508
Merge medio
2g 17h
PR unite (30g)
40

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di exceptionless/Exceptionless

Tutte le issue di exceptionless/Exceptionless

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.