microsoft / microsoft/OpenAPI.NET.OData
[Feature Request] Standardize operationIds to ensure uniqueness
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- C#
- Sterne
- 240
- Forks
- 70
- Ø Merge
- 7 Std. 59 Min.
- Gemergte PRs (30 T.)
- 13
Beschreibung
We should consider standardizing the naming convention of operationIds to what we currently have in DevX API (PowerShell style) - https://github.com/microsoftgraph/microsoft-graph-devx-api/blob/dev/OpenAPIService/PowershellFormatter.cs? For example:
- Remove hash suffix values from operationIds for
functionall paths. - Add '_' to separate verb (action) in an operationId. This typically the last
.or second from last.for OData cast paths. - PUT operations should have Set as the verb in an operationId
{xxx}_Set{yyy}.
In PowerShell, we use operationIds to form command names.
As part of this exercise, we should add validation to ensure operationIds are unique for a given document.
Edit: This is a continuation of https://github.com/microsoft/OpenAPI.NET.OData/pull/338#discussion_r1097802458.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit der referenzierten Datei OpenAPIService/PowershellFormatter.cs und der Diskussion, die von pull request 338 verlinkt wird, um die bestehenden Konventionen für operationId zu verstehen. Verfolgen Sie, wo operationIds für OData-Pfade generiert werden, und identifizieren Sie anschließend den Einstiegspunkt der Dokumentvalidierung; abgeschlossen ist die Aufgabe, wenn die angeforderten Benennungsregeln angewendet und doppelte operationIds abgelehnt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- csharp, powershell
- Bereich
- api, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100