Set request body to optional when all properties are optional
Ein zugehöriger Pull Request wurde bereits gemerged.
- #775 von @baywet — gemerged
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 25/100
Rechercherichtung
Beginnen Sie mit der Durchsicht der verknüpften Microsoft Graph-Pull Requests und der Spezifikation der festen Felder für request-body in OpenAPI 3.0.3. Verfolgen Sie, an welcher Stelle die generierte OpenAPI-Beschreibung requestBody.required festlegt; abgeschlossen ist die Aufgabe, wenn die Optionalität für Bodies, deren Eigenschaften alle optional sind, korrekt dargestellt wird, während erforderliche Bodies weiterhin ausdrücklich als erforderlich gekennzeichnet bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Related to https://github.com/microsoftgraph/msgraph-sdk-java/pull/2163 and https://github.com/microsoftgraph/msgraph-sdk-dotnet/pull/2671#discussion_r1765012196
In a scenario where all the properties in the request body are optional such as an odata action with all parameters being optional, we should set the requestBody.required = false in the generated openApi description otherwise explictly set it to true.
https://spec.openapis.org/oas/v3.0.3.html#fixed-fields-10
This will unlock the generation of request body parameters in the SDKs as optional parameters in the builders to prevent breaking changes in scenarios where optional parametes are added.
- Vorherrschende Sprache
- C#
- Sterne
- 240
- Forks
- 70
- Ø Merge
- 7 Std. 59 Min.
- Gemergte PRs (30 T.)
- 13
Beitragsleitfaden
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
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
microsoft/OpenAPI.NET.OData#661 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 58/100
microsoft/OpenAPI.NET.OData#852 ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 45/100
microsoft/OpenAPI.NET.OData#833 ·
-
status:needs-more-information
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100
microsoft/OpenAPI.NET.OData#723 · 1 Kommentar · 1 Reaktion ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
microsoft/OpenAPI.NET.OData#720 ·
Alle Issues in microsoft/OpenAPI.NET.OData
Ähnliche Issues
-
[Feat] 조합 영역 구분선 개선 Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
type/automation type/tech-debt
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
-
t/bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
-
ci-failure-cause test-failure
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100