You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16Lines changed: 16 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -45,6 +45,22 @@ Here are the other sample apps directly using the NuGet packages (external repos
45
45
This library supports Azure Functions V2 and onwards. If you still want to get your v1 app supported, find the [community contribution](https://github.com/aliencube/AzureFunctions.Extensions) or the [proxy feature](docs/azure-functions-v1-support.md).
46
46
47
47
48
+
## Known Issues ##
49
+
50
+
Due to the Azure Functions Runtime limitation, sometimes some of .dll files are removed while publishing the function app. In this case, try the following workaround with your function app `.csproj` file.
While using this library, if you find any issue, please raise an issue on the [Issue](https://github.com/Azure/azure-functions-openapi-extension/issues) page.
Some attribute classes from [System.Runtime.Serialization](https://docs.microsoft.com/dotnet/api/system.runtime.serialization) are supported for payload definition.
822
+
823
+
824
+
### `DataMemberAttribute` ###
825
+
826
+
Properties decorated with `DataMemberAttribute` attribute class will use `DataMember.Name` value instead of their property names.
827
+
828
+
819
829
## Supported Json.NET Decorators ##
820
830
821
831
Those attribute classes from [Json.NET](https://www.newtonsoft.com/json) are supported for payload definitions.
822
832
823
833
824
-
### `JsonIgnore` ###
834
+
### `JsonIgnoreAttribute` ###
825
835
826
-
Properties decorated with the `JsonIgnore` attribute class will not be included in the response.
836
+
Properties decorated with the `JsonIgnoreAttribute` attribute class will not be included in the response.
827
837
828
838
829
-
### `JsonProperty` ###
839
+
### `JsonPropertyAttribute` ###
830
840
831
-
Properties decorated with `JsonProperty` attribute class will use `JsonProperty.Name` value instead of their property names. In addition to this, if `JsonProperty.Required` property has `Required.Always` or `Required.DisallowNull`, the property will be recognised as the `required` field.
841
+
Properties decorated with `JsonPropertyAttribute` attribute class will use `JsonProperty.Name` value instead of their property names. In addition to this, if `JsonProperty.Required` property has `Required.Always` or `Required.DisallowNull`, the property will be recognised as the `required` field.
832
842
833
843
834
-
### `JsonRequired` ###
844
+
### `JsonRequiredAttribute` ###
835
845
836
-
Properties decorated with `JsonRequired` attribute class will be recognised as the `required` field.
846
+
Properties decorated with `JsonRequiredAttribute` attribute class will be recognised as the `required` field.
837
847
838
848
839
-
### `JsonConverter` ###
849
+
### `JsonConverterAttribute` ###
840
850
841
851
Enums types decorated with `[JsonConverter(typeof(StringEnumConverter))]` will appear in the document with their string names (names mangled based on default property naming standard).
0 commit comments