Optimization - reusable components for orderby/expand/select query parameters

Offen

#612 erstellt am 28.11.2024 3 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 35/100

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

Rechercherichtung

Beginne damit, die bestehende Verarbeitung für wiederverwendbare count/top/skip/filter-Parameter und die Einstellung zu finden, die sie steuert. Verfolge, wie orderby, select und expand derzeit ausgegeben werden, und überprüfe anschließend, dass die Aktivierung der Einstellung Verweise auf Komponentenparameter erzeugt, während das bestehende Verhalten bei deaktivierter Einstellung erhalten bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

priority:p1 type:enhancement

Since #197 was implemented through #499, we have a big opportunity to make descriptions much smaller.

Effectively all operations now have the same definition for those query parameters when they support it

        - name: $orderby
          in: query
          description: Order items by property values
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
        - name: $select
          in: query
          description: Select properties to be returned
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
        - name: $expand
          in: query
          description: Expand related entities
          style: form
          explode: false
          schema:
            uniqueItems: true
            type: array
            items:
              type: string

When the setting it on, we should do the same thing we do for count/top/skip/filter... and have instead

 - $ref: '#/components/parameters/expand'
 - $ref: '#/components/parameters/select'
 - $ref: '#/components/parameters/orderby'

Which would save a ton of repetition throughout the final description.

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
Provide a way to not generate navigation paths with key Offen

status:needs-more-information

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

microsoft/OpenAPI.NET.OData#723 · 1 Kommentar · 1 Reaktion · Erstellt am 29.7.2025
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

Alle Issues in microsoft/OpenAPI.NET.OData