Provide a way to not generate navigation paths with key

Offen

#723 erstellt am 29.7.2025 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 4/5
Geschätzter Aufwand: 3-5 Tage
Anfängerfreundlichkeit: 42/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: csharp
Bereich: api, backend-api-design

Rechercherichtung

Verfolgen Sie die Konvertierung von ODataConventionModelBuilder durch die Generierung von OpenApiDocument und die Routing-Konventionen. Identifizieren Sie, wo Navigationpfade mit Schlüssel hinzugefügt werden, bestimmen Sie anschließend, wie die Konfiguration sie unterdrücken könnte, und überprüfen Sie, dass generierte Dokumente diese nicht unterstützten Pfade auslassen, ohne gültige Navigationsrouten zu entfernen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

status:needs-more-information

I am new to implementing my first OData service. I am using OData for .NET 8+ with the ODataConventionModelBuilder to generate my model.

When a navigation property references an entity that is indexable, a path is generated of the form
Entity({ID})/NavEntity({ID1}) or Entity/{ID}/NavEntity/{ID1}.

The routing conventions don't include this path. They only support navigation to the NavEntity level. It would be helpful if there were a way to configure the conversion not to generate navigation paths with the key, even though the entity has one. As a practical matter, I'm not sure when I would need to query the navigation property by key, especially if the navigation property is available as a root entity.

As a workaround, I have added code to remove the unsupported paths from the OpenApiDocument before serializing it. As the OData service evolves, this code has to also evolve. If the conversion didn't generate the path with multiple keys, this workaround code would be unnecessary.

Vorherrschende Sprache: C#
Sterne: 240
Forks: 70
Ø Merge: 7 Std. 59 Min.
Gemergte PRs (30 T.): 13

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus microsoft/OpenAPI.NET.OData

IEdmModel.ConvertToOpenApi() throws System.InvalidOperationException when having dollar-count similar path in controller Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

microsoft/OpenAPI.NET.OData#661 · Erstellt am 14.2.2025
Microsoft.OpenApi.OData.Reader.dll ships unversioned (0.0.0.0) since the 2026-01-16 releases Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100

microsoft/OpenAPI.NET.OData#852 · Erstellt am 04.8.2026
Microsoft.OData.Edm 9.0.0-rc compat: MissingMethodException on ExtensionMethods.GetReturn(IEdmOperation) Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100

microsoft/OpenAPI.NET.OData#833 · Erstellt am 18.6.2026
Action bound to abstract entity type is not present in OpenAPI output when using hidi to convert from CSDL Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100

microsoft/OpenAPI.NET.OData#720 · Erstellt am 10.7.2025
Action and Operation do not expose $select and $expand over entity types Offen

Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100

microsoft/OpenAPI.NET.OData#710 · 2 Kommentare · 1 Reaktion · Erstellt am 02.7.2025

Alle Issues in microsoft/OpenAPI.NET.OData