Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,12 @@ internal static partial class OpenApiV2Deserializer

o.Components.RequestBodies = n.CreateMapWithReference(ReferenceType.RequestBody, p =>
{
var parameter = LoadParameter(p, evenBody: true);
if (parameter.In == null)
var parameter = LoadParameter(p, loadRequestBody: true);
if (parameter != null)
{
return CreateRequestBody(n.Context,parameter);
return CreateRequestBody(n.Context, parameter);
}

return null;
}
);
Expand Down
26 changes: 18 additions & 8 deletions src/Microsoft.OpenApi.Readers/V2/OpenApiParameterDeserializer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using System;
using System.Collections.Generic;
using System.Globalization;
using Microsoft.OpenApi.Any;
using Microsoft.OpenApi.Extensions;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Readers.ParseNodes;
Expand All @@ -17,7 +16,7 @@ namespace Microsoft.OpenApi.Readers.V2
/// </summary>
internal static partial class OpenApiV2Deserializer
{
private static ParameterLocation? _in;
private static bool _isBodyOrFormData;

private static readonly FixedFieldMap<OpenApiParameter> _parameterFixedFields =
new FixedFieldMap<OpenApiParameter>
Expand Down Expand Up @@ -205,9 +204,11 @@ private static void ProcessIn(OpenApiParameter o, ParseNode n)
switch (value)
{
case "body":
_isBodyOrFormData = true;
n.Context.SetTempStorage(TempStorageKeys.BodyParameter, o);
break;
case "formData":
_isBodyOrFormData = true;
var formParameters = n.Context.GetFromTempStorage<List<OpenApiParameter>>("formParameters");
if (formParameters == null)
{
Expand All @@ -217,9 +218,13 @@ private static void ProcessIn(OpenApiParameter o, ParseNode n)

formParameters.Add(o);
break;
case "query":
case "header":
case "path":
o.In = value.GetEnumFromDisplayName<ParameterLocation>();
break;
default:
_in = value.GetEnumFromDisplayName<ParameterLocation>();
o.In = _in;
o.In = null;
break;
}
}
Expand All @@ -229,10 +234,10 @@ public static OpenApiParameter LoadParameter(ParseNode node)
return LoadParameter(node, false);
}

public static OpenApiParameter LoadParameter(ParseNode node, bool evenBody)
public static OpenApiParameter LoadParameter(ParseNode node, bool loadRequestBody)
{
// Reset the local variables every time this method is called.
_in = null;
_isBodyOrFormData = false;

var mapNode = node.CheckMapNode("parameter");

Expand All @@ -254,9 +259,14 @@ public static OpenApiParameter LoadParameter(ParseNode node, bool evenBody)
node.Context.SetTempStorage("schema", null);
}

if (_in == null && !evenBody)
if (_isBodyOrFormData && !loadRequestBody)
{
return null; // Don't include Form or Body parameters when normal parameters are loaded.
}

if ( loadRequestBody && !_isBodyOrFormData )
{
return null; // Don't include Form or Body parameters in OpenApiOperation.Parameters list
return null; // Don't include non-Body or non-Form parameters when request bodies are loaded.
}

return parameter;
Expand Down
16 changes: 13 additions & 3 deletions src/Microsoft.OpenApi.Readers/V3/OpenApiParameterDeserializer.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System.Collections.Generic;
using System;
using System.Linq;
using Microsoft.OpenApi.Extensions;
using Microsoft.OpenApi.Models;
Expand All @@ -27,7 +27,18 @@ internal static partial class OpenApiV3Deserializer
{
"in", (o, n) =>
{
o.In = n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>();
var inString = n.GetScalarValue();

if ( Enum.GetValues(typeof(ParameterLocation)).Cast<ParameterLocation>()
.Select( e => e.GetDisplayName() )
.Contains(inString) )
{
o.In = n.GetScalarValue().GetEnumFromDisplayName<ParameterLocation>();
}
else
{
o.In = null;
}
}
},
{
Expand Down Expand Up @@ -115,7 +126,6 @@ public static OpenApiParameter LoadParameter(ParseNode node)
}

var parameter = new OpenApiParameter();
var required = new List<string> {"name", "in"};

ParseMap(mapNode, parameter, _parameterFixedFields, _parameterPatternFields);

Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.OpenApi/Models/OpenApiParameter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
writer.WriteProperty(OpenApiConstants.Name, Name);

// in
writer.WriteProperty(OpenApiConstants.In, In.GetDisplayName());
writer.WriteProperty(OpenApiConstants.In, In?.GetDisplayName());

// description
writer.WriteProperty(OpenApiConstants.Description, Description);
Expand Down Expand Up @@ -237,7 +237,7 @@ public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
}
else
{
writer.WriteProperty(OpenApiConstants.In, In.GetDisplayName());
writer.WriteProperty(OpenApiConstants.In, In?.GetDisplayName());
}

// name
Expand Down
6 changes: 6 additions & 0 deletions src/Microsoft.OpenApi/Validations/OpenApiValidator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,12 @@ public void AddError(OpenApiValidatorError error)
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiTag item) => Validate(item);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiParameter"/>
/// </summary>
/// <param name="item">The object to be validated</param>
public override void Visit(OpenApiParameter item) => Validate(item);

/// <summary>
/// Execute validation rules against an <see cref="OpenApiSchema"/>
/// </summary>
Expand Down
63 changes: 63 additions & 0 deletions src/Microsoft.OpenApi/Validations/Rules/OpenApiParameterRules.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.

using System;
using Microsoft.OpenApi.Models;
using Microsoft.OpenApi.Properties;

namespace Microsoft.OpenApi.Validations.Rules
{
/// <summary>
/// The validation rules for <see cref="OpenApiParameter"/>.
/// </summary>
[OpenApiRule]
public static class OpenApiParameterRules
{
/// <summary>
/// Validate the field is required.
/// </summary>
public static ValidationRule<OpenApiParameter> ParameterRequiredFields =>
new ValidationRule<OpenApiParameter>(
(context, item) =>
{
// name
context.Enter("name");
if (item.Name == null)
{
context.CreateError(nameof(ParameterRequiredFields),
String.Format(SRResource.Validation_FieldIsRequired, "name", "parameter"));
}
context.Exit();

// in
context.Enter("in");
if (item.In == null)
{
context.CreateError(nameof(ParameterRequiredFields),
String.Format(SRResource.Validation_FieldIsRequired, "in", "parameter"));
}
context.Exit();
});

/// <summary>
/// Validate the "required" field is true when "in" is path.
/// </summary>
public static ValidationRule<OpenApiParameter> RequiredMustBeTrueWhenInIsPath =>
new ValidationRule<OpenApiParameter>(
(context, item) =>
{
// required
context.Enter("required");
if ( item.In == ParameterLocation.Path && !item.Required )
{
context.CreateError(
nameof(RequiredMustBeTrueWhenInIsPath),
"\"required\" must be true when parameter location is \"path\"");
}

context.Exit();
});

// add more rule.
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\formDataParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\parameterWithNoLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\parameterWithUnknownLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\parameterWithNullLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V2Tests\Samples\OpenApiParameter\headerParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
Expand Down Expand Up @@ -113,7 +122,36 @@
<EmbeddedResource Include="V3Tests\Samples\OpenApiInfo\minimalInfo.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiOperation\securedOperation.yaml" />
<EmbeddedResource Include="V3Tests\Samples\OpenApiOperation\operationWithParameterWithNoLocation.json">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiOperation\securedOperation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\headerParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\parameterWithNoLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\parameterWithUnknownLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\parameterWithNullLocation.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\pathParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\queryParameterWithObjectTypeAndContent.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\queryParameterWithObjectType.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiParameter\queryParameter.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
<EmbeddedResource Include="V3Tests\Samples\OpenApiSchema\advancedSchemaWithReference.yaml">
<CopyToOutputDirectory>Never</CopyToOutputDirectory>
</EmbeddedResource>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,5 +168,89 @@ public void ParseHeaderParameterShouldSucceed()
}
});
}

[Fact]
public void ParseParameterWithNullLocationShouldSucceed()
{
// Arrange
MapNode node;
using ( var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "parameterWithNullLocation.yaml")) )
{
node = TestHelper.CreateYamlMapNode(stream);
}

// Act
var parameter = OpenApiV2Deserializer.LoadParameter(node);

// Assert
parameter.ShouldBeEquivalentTo(
new OpenApiParameter
{
In = null,
Name = "username",
Description = "username to fetch",
Required = true,
Schema = new OpenApiSchema
{
Type = "string"
}
});
}

[Fact]
public void ParseParameterWithNoLocationShouldSucceed()
{
// Arrange
MapNode node;
using ( var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "parameterWithNoLocation.yaml")) )
{
node = TestHelper.CreateYamlMapNode(stream);
}

// Act
var parameter = OpenApiV2Deserializer.LoadParameter(node);

// Assert
parameter.ShouldBeEquivalentTo(
new OpenApiParameter
{
In = null,
Name = "username",
Description = "username to fetch",
Required = true,
Schema = new OpenApiSchema
{
Type = "string"
}
});
}

[Fact]
public void ParseParameterWithUnknownLocationShouldSucceed()
{
// Arrange
MapNode node;
using ( var stream = Resources.GetStream(Path.Combine(SampleFolderPath, "parameterWithUnknownLocation.yaml")) )
{
node = TestHelper.CreateYamlMapNode(stream);
}

// Act
var parameter = OpenApiV2Deserializer.LoadParameter(node);

// Assert
parameter.ShouldBeEquivalentTo(
new OpenApiParameter
{
In = null,
Name = "username",
Description = "username to fetch",
Required = true,
Schema = new OpenApiSchema
{
Type = "string"
}
});
}
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject
# modified from https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject
name: token
in: header
description: token to be passed as a header
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
name: username
description: username to fetch
required: true
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name: username
in: null
description: username to fetch
required: true
type: string
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
name: username
in: abcde
description: username to fetch
required: true
type: string
Loading