Skip to content

Fixes paths for functions with structured or collection-valued parameters #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Mar 29, 2022
Merged

Fixes paths for functions with structured or collection-valued parameters #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3de0285
Update In property value for structured and col-valued func. params
irvinesunday Mar 25, 2022
52de01f
Replace parameter alias for structured and col-valued func. params wi…
irvinesunday Mar 25, 2022
e1a9cdf
Remove comment
irvinesunday Mar 25, 2022
a54484a
Add workflow_dispatch
irvinesunday Mar 29, 2022
59b43c4
PR feedback
irvinesunday Mar 29, 2022
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
1 change: 1 addition & 0 deletions .github/workflows/codeql-analysis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ on:
branches: [ master ]
schedule:
- cron: '32 2 * * 6'
workflow_dispatch:

jobs:
analyze:
Expand Down
17 changes: 4 additions & 13 deletions src/Microsoft.OpenApi.OData.Reader/Edm/ODataOperationSegment.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,22 +139,13 @@ private string FunctionName(IEdmFunction function, OpenApiConvertSettings settin
functionName.Append(function.FullName());
}
functionName.Append("(");

// Structured or collection-valued parameters are represented as a parameter alias in the path template
// and the parameters array contains a Parameter Object for the parameter alias as a query option of type string.

int skip = function.IsBound ? 1 : 0;
functionName.Append(String.Join(",", function.Parameters.Skip(skip).Select(p =>
functionName.Append(string.Join(",", function.Parameters.Skip(skip).Select(p =>
{
string uniqueName = Utils.GetUniqueName(p.Name, parameters);
if (p.Type.IsStructured() || p.Type.IsCollection())
{
return p.Name + "=@" + uniqueName;
}
else
{
var quote = p.Type.Definition.ShouldPathParameterBeQuoted(settings) ? "'" : string.Empty;
return p.Name + $"={quote}{{{uniqueName}}}{quote}";
}
var quote = p.Type.Definition.ShouldPathParameterBeQuoted(settings) ? "'" : string.Empty;
return p.Name + $"={quote}{{{uniqueName}}}{quote}";
})));

functionName.Append(")");
Expand Down
7 changes: 2 additions & 5 deletions src/Microsoft.OpenApi.OData.Reader/Generator/OpenApiParameterGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,17 +81,14 @@ public static IList<OpenApiParameter> CreateParameters(this ODataContext context
}
}

OpenApiParameter parameter;
// Structured or collection-valued parameters are represented as a parameter alias
// in the path template and the parameters array contains a Parameter Object for
// the parameter alias as a query option of type string.
OpenApiParameter parameter;
if (edmParameter.Type.IsStructured() ||
edmParameter.Type.IsCollection())
{
parameter = new OpenApiParameter
{
Name = parameterNameMapping == null ? edmParameter.Name : parameterNameMapping[edmParameter.Name],
In = ParameterLocation.Query, // as query option
In = ParameterLocation.Path,
Required = true,

// Create schema in the Content property to indicate that the parameters are serialized as JSON
Expand Down
4 changes: 2 additions & 2 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Edm/ODataOperationSegmentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ public void GetPathItemNameReturnsCorrectActionLiteral(bool unqualifiedCall, boo

[Theory]
[InlineData(true, true, "MyFunction(param={param})")]
[InlineData(true, false, "MyFunction(entity=@entity,param={param})")]
[InlineData(true, false, "MyFunction(entity={entity},param={param})")]
[InlineData(false, true, "NS.MyFunction(param={param})")]
[InlineData(false, false, "NS.MyFunction(entity=@entity,param={param})")]
[InlineData(false, false, "NS.MyFunction(entity={entity},param={param})")]
public void GetPathItemNameReturnsCorrectFunctionLiteral(bool unqualifiedCall, bool isBound, string expected)
{
// Arrange & Act
Expand Down
2 changes: 1 addition & 1 deletion test/Microsoft.OpenAPI.OData.Reader.Tests/Generator/OpenApiParameterGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,7 @@ public void CreateParametersWorks()
string json1 = parameter1.SerializeAsJson(OpenApiSpecVersion.OpenApi3_0);
string expectedPayload1 = $@"{{
""name"": ""ids"",
""in"": ""query"",
""in"": ""path"",
""description"": ""The URL-encoded JSON object"",
""required"": true,
""content"": {{
Expand Down