Skip to content

Resolves response schemas of actions/functions that return collection #117

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 3 commits into from
Sep 21, 2021
Merged

Resolves response schemas of actions/functions that return collection #117

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
73fa6ba
Update response schema of action/functions that return a collection
irvinesunday Sep 15, 2021
762ef1d
Update Title to use entity type name for the previous segment
irvinesunday Sep 15, 2021
af780a6
Update test files data appropriately
irvinesunday Sep 15, 2021
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
24 changes: 23 additions & 1 deletion 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 @@ -172,6 +172,28 @@ protected override void SetResponses(OpenApiOperation operation)
}
else
{
OpenApiSchema schema;
if (EdmOperation.ReturnType.TypeKind() == EdmTypeKind.Collection)
{
// Get the entity type of the previous segment
IEdmEntityType entityType = Path.Segments.Reverse().Skip(1).Take(1).FirstOrDefault().EntityType;
schema = new OpenApiSchema
{
Title = $"Collection of {entityType.Name}",
Type = "object",
Properties = new Dictionary<string, OpenApiSchema>
{
{
"value", Context.CreateEdmTypeSchema(EdmOperation.ReturnType)
}
}
};
}
else
{
schema = Context.CreateEdmTypeSchema(EdmOperation.ReturnType);
}

// function should have a return type.
OpenApiResponse response = new OpenApiResponse
{
Expand All @@ -182,7 +204,7 @@ protected override void SetResponses(OpenApiOperation operation)
Constants.ApplicationJsonMediaType,
new OpenApiMediaType
{
Schema = Context.CreateEdmTypeSchema(EdmOperation.ReturnType)
Schema = schema
}
}
}
Expand Down
108 changes: 81 additions & 27 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 @@ -1169,9 +1169,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
}
}
}
}
},
Expand Down Expand Up @@ -1221,9 +1227,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down Expand Up @@ -1636,9 +1648,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Trip",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down Expand Up @@ -2814,9 +2832,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
}
}
}
}
},
Expand Down Expand Up @@ -2874,9 +2898,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down Expand Up @@ -3353,9 +3383,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Trip",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down Expand Up @@ -4563,9 +4599,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip"
}
}
}
}
},
Expand Down Expand Up @@ -4623,9 +4665,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Person",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down Expand Up @@ -5102,9 +5150,15 @@
"200": {
"description": "Success",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
"title": "Collection of Trip",
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person"
}
}
}
}
},
Expand Down
90 changes: 63 additions & 27 deletions test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/TripService.OpenApi.V2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -801,9 +801,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down Expand Up @@ -836,9 +840,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: action
Expand Down Expand Up @@ -1127,9 +1135,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Trip
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down Expand Up @@ -1952,9 +1964,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down Expand Up @@ -1993,9 +2009,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: action
Expand Down Expand Up @@ -2332,9 +2352,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Trip
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down Expand Up @@ -3181,9 +3205,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Trip'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down Expand Up @@ -3222,9 +3250,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Person
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: action
Expand Down Expand Up @@ -3561,9 +3593,13 @@ paths:
'200':
description: Success
schema:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
title: Collection of Trip
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person'
default:
$ref: '#/responses/error'
x-ms-docs-operation-type: function
Expand Down
Loading