Skip to content

Generates $expand query parameter for operations whose return type is a collection #485

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
Irvine Sunday (irvinesunday) merged 3 commits into from
Feb 1, 2024
Merged

Generates $expand query parameter for operations whose return type is a collection #485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fde7d4d
Generate expand for operations that return a collection
irvinesunday Feb 1, 2024
9092c01
Update tests
irvinesunday Feb 1, 2024
429ee77
Update release note
irvinesunday Feb 1, 2024
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
3 changes: 2 additions & 1 deletion src/Microsoft.OpenApi.OData.Reader/Microsoft.OpenAPI.OData.Reader.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<TargetFrameworks>netstandard2.0</TargetFrameworks>
<PackageId>Microsoft.OpenApi.OData</PackageId>
<SignAssembly>true</SignAssembly>
<Version>1.6.0-preview.4</Version>
<Version>1.6.0-preview.5</Version>
<Description>This package contains the codes you need to convert OData CSDL to Open API Document of Model.</Description>
<Copyright>© Microsoft Corporation. All rights reserved.</Copyright>
<PackageTags>Microsoft OpenApi OData EDM</PackageTags>
Expand All @@ -25,6 +25,7 @@
- Updates the format of the request body schema of a collection of complex property #423
- Adds a delete operation and a required @id query parameter to collection-valued navigation property paths with $ref #453
- Fixes inconsistency of nullability of schemas of properties that are a collection of structured types #467
- Generates $expand query parameter for operations whose return type is a collection #481
</PackageReleaseNotes>
<AssemblyName>Microsoft.OpenApi.OData.Reader</AssemblyName>
<AssemblyOriginatorKeyFile>..\..\tool\Microsoft.OpenApi.OData.snk</AssemblyOriginatorKeyFile>
Expand Down
6 changes: 6 additions & 0 deletions src/Microsoft.OpenApi.OData.Reader/Operation/EdmOperationOperationHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,12 @@ private void AppendSystemQueryOptions(IEdmFunction function, OpenApiOperation op
{
operation.Parameters.AppendParameter(orderbyParameter);
}

// $expand
if (Context.CreateExpand(function, entityType) is OpenApiParameter expandParameter)
{
operation.Parameters.AppendParameter(expandParameter);
}
}
}
}
Expand Down
144 changes: 144 additions & 0 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7082,6 +7082,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -7630,6 +7645,19 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"PlanItems"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -11102,6 +11130,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -12042,6 +12085,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -15441,6 +15499,19 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"PlanItems"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -16042,6 +16113,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -23441,6 +23527,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -24063,6 +24164,19 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"PlanItems"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -28079,6 +28193,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down Expand Up @@ -29139,6 +29268,21 @@
],
"type": "string"
}
},
{
"in": "query",
"name": "$expand",
"description": "Expand related entities",
"type": "array",
"items": {
"enum": [
"*",
"Friends",
"BestFriend",
"Trips"
],
"type": "string"
}
}
],
"responses": {
Expand Down
Loading