search

microsoft / OpenAPI.NET.OData

Generates OpenAPI document from OData CSDL
MIT License
207 stars 63 forks source link

Set request body to optional when all properties are optional #582

Open andrueastman opened 1 month ago

andrueastman commented 1 month ago

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.

andrueastman commented 1 month ago

Once this is fixed and released, we should revert this PR. https://github.com/microsoftgraph/msgraph-metadata/pull/697

andrueastman commented 3 weeks ago

Updated the description here. Should be Odata action not function. Functions do not have request bodies as the parameters are in the path.

irvinesunday commented 3 weeks ago

Also, point of note is that, if requestBody.required = false the OAS does not emit the required property in the requestBody schema.

andrueastman commented 3 weeks ago

According to the spec.

Determines if the request body is required in the request. Defaults to false.

So what we should do is set it to true when required parameters are present...

irvinesunday commented 3 weeks ago

Trying to retrieve the annotations in-lined in the Action parameters fails to retrieve the Org.OData.Core.V1.OptionalParameter annotation using the extensions from the Edm lib.

var annotations =  model.FindVocabularyAnnotationsIncludingInheritedAnnotations(parameter);
<Parameter Name="transitive" Type="Edm.Boolean" Nullable="false">
  <Annotation Term="Org.OData.Core.V1.OptionalParameter" />
</Parameter>

Checking with the OData team to check for its support.