Feature/#139 OpenAPI query string/path parameter examples

[choipureum]

related issue : #139

This PR can provide examples for query string/path parameters. It is based on the form written on the existing payloadAttribute.

OverView:

• trigger

 [OpenApiParameter(name: "dateTimeParameter", In = ParameterLocation.Query, Required = true, Example = typeof(DateTimeParameterExample), Type = typeof(DateTime), Description = "The **dateTime** parameter")]

• model

    public class DateTimeParameterExample : OpenApiExample<DateTime>
    {
        public override IOpenApiExample<DateTime> Build(NamingStrategy namingStrategy = null)
        {
            this.Examples.Add(OpenApiExampleResolver.Resolve("dateTimeValue1", DateTime.Parse("2021-01-01"), namingStrategy));
            this.Examples.Add(OpenApiExampleResolver.Resolve("dateTimeValue2", DateTime.Parse("2021-01-01T12:34:56Z"), namingStrategy));
            return this;
        }
    }

• openapi.json

          {
            "name": "dateTimeParameter",
            "in": "query",
            "description": "The **dateTime** parameter",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "example": "2021-01-01T00:00:00.0000000+09:00",
            "examples": {
              "dateTimeValue1": {
                "value": "2021-01-01T00:00:00.0000000+09:00"
              },
              "dateTimeValue2": {
                "value": "2021-01-01T21:34:56.0000000+09:00"
              }
            }
          },

[justinyoo]

Thanks for the PR! I found that we should update OpenApiExampleResolver as well because it assumes only an object is coming in – it always converts the object into an escaped JSON string.

azure-functions-openapi-extension/src/Microsoft.Azure.WebJobs.Extensions.OpenApi.Core/Resolvers/OpenApiExampleResolver.cs

Line 68 in 36621a6

Value = new OpenApiString(JsonConvert.SerializeObject(instance, settings)),

However, with this PR, it SHOULD NOT assume the example is an object.

Depending on the type of the example – string, number, boolean, etc. the example value should be one of OpenApiString, OpenApiInteger, OpenApiBoolean, etc.

Could you have a further look?

[choipureum]

I understand. Thank you for the review. I will revise and commit as soon as possible. 😀

[justinyoo]

Thanks for your update! I left comments here mainly about declaring your test object types. Please take a further look and update your code in accordance with that.

Please make sure that you're testing all the possible value types.

[justinyoo]

Thanks for your comprehensive updates! It's almost there.

We've now got DateTime related ones, but not yet DateTimeOffset related ones. Could you please consider the DateTimeOffset related examples, tests, etc?

[justinyoo]

LGTM! Thanks for your contribution!