Skip to content

Commit 2127bb3

Browse files
committed
Merge branch 'release/v1.0.0' into main
2 parents 142b7f8 + 1686213 commit 2127bb3

File tree

3 files changed

+46
-7
lines changed

3 files changed

+46
-7
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,22 @@ Here are the other sample apps directly using the NuGet packages (external repos
4545
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).
4646

4747

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.
51+
52+
```xml
53+
<Project Sdk="Microsoft.NET.Sdk">
54+
...
55+
<PropertyGroup>
56+
...
57+
<_FunctionsSkipCleanOutput>true</_FunctionsSkipCleanOutput>
58+
</PropertyGroup>
59+
...
60+
</Project>
61+
```
62+
63+
4864
## Issues? ##
4965

5066
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.

docs/openapi-core.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -816,26 +816,36 @@ Properties decorated with the `MaxLengthAttribute` class impacts on either `Open
816816
* If `OpenApiSchema.Type` is NOT `array`: `OpenApiSchema.MaxLength`
817817

818818

819+
## Supported System.Runtime.Serialization Decorators ##
820+
821+
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+
819829
## Supported Json.NET Decorators ##
820830

821831
Those attribute classes from [Json.NET](https://www.newtonsoft.com/json) are supported for payload definitions.
822832

823833

824-
### `JsonIgnore` ###
834+
### `JsonIgnoreAttribute` ###
825835

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.
827837

828838

829-
### `JsonProperty` ###
839+
### `JsonPropertyAttribute` ###
830840

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.
832842

833843

834-
### `JsonRequired` ###
844+
### `JsonRequiredAttribute` ###
835845

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.
837847

838848

839-
### `JsonConverter` ###
849+
### `JsonConverterAttribute` ###
840850

841851
Enums types decorated with `[JsonConverter(typeof(StringEnumConverter))]` will appear in the document with their string names (names mangled based on default property naming standard).

release-notes/v1.0.0.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Release Notes ##
2+
3+
🎉🎉🎉 General Availability of Azure Functions OpenAPI Extension `v1.0.0` 🎉🎉🎉
4+
5+
6+
### Changes & Fixes ###
7+
8+
* #308 Fix the API prefix overly trimmed #307
9+
* #288 Uint16 bug fix
10+
* #287 Fix uint32 error
11+
* #268 Fixed throwing StackOverflowException when contains exception class #251
12+
* #263 Fix Data Member Attribute json Serialized Model Casing Applied #212
13+
* #260 Add integration testing for Uri Object Type #143

0 commit comments

Comments
 (0)