Skip to content

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

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 16 commits into from
Jul 17, 2024
Merged

Document arrays of GenericParameters with XmlComments and support Overload methods #2982

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
0b67d44
Document arrays of GenericParameters with XmlComments
Jul 14, 2024
d7d5019
Overload methods with the same number of parameters
Jul 14, 2024
f6c5f92
Fix IntegrationTests
Jul 15, 2024
0e8c24c
PR comments on typos and spaces
Jul 15, 2024
d476491
Do not calculate constructedTypeParameters in Linq method
Jul 15, 2024
4dcb99b
UnitTest for MethodInfoExtensions
Jul 15, 2024
3154256
Add more test on MethodInfoExtensions
Jul 15, 2024
1671a31
Fix issue with IEnumerable<T> and List<T>
Jul 15, 2024
110bc57
PR comments on test of GetUnderlyingGenericTypeMethod
Jul 17, 2024
ed1d58c
Assert.NotNull on several parameters
Jul 17, 2024
723f812
PR suggestions
Jul 17, 2024
1ac66a7
TheoryData with more information
Jul 17, 2024
fdc7385
Avoid using Tuples with TheoryData
Jul 17, 2024
d99a648
Fix commented code
Jul 17, 2024
9fc8dbe
expectedReturnType renamed
Jul 17, 2024
cfdd5e9
Apply suggestions from code review
jgarciadelanoceda Jul 17, 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
148 changes: 104 additions & 44 deletions ...ValidSwaggerJson_startupType=GenericControllers.Startup_swaggerRequestUri=v1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,22 +133,13 @@
}
}
},
"/{tennantId}/orders/Delete/{id}": {
"/{tennantId}/orders/DeleteById": {
"delete": {
"tags": [
"Orders"
],
"summary": "Delete by Id",
"parameters": [
{
"name": "Id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tennantId",
"in": "path",
Expand All @@ -158,6 +149,27 @@
}
}
],
"requestBody": {
"description": "deleting Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Order"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Deleted",
Expand Down Expand Up @@ -195,18 +207,6 @@
],
"summary": "Delete by Id List",
"parameters": [
{
"name": "id",
"in": "path",
"description": "deleting Id",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
},
{
"name": "tennantId",
"in": "path",
Expand All @@ -216,6 +216,36 @@
}
}
],
"requestBody": {
"description": "deleting Ids",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Deleted",
Expand Down Expand Up @@ -374,22 +404,13 @@
}
}
},
"/{tennantId}/products/Delete/{id}": {
"/{tennantId}/products/DeleteById": {
"delete": {
"tags": [
"Products"
],
"summary": "Delete by Id",
"parameters": [
{
"name": "Id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "tennantId",
"in": "path",
Expand All @@ -399,6 +420,27 @@
}
}
],
"requestBody": {
"description": "deleting Id",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Product"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Deleted",
Expand Down Expand Up @@ -436,18 +478,6 @@
],
"summary": "Delete by Id List",
"parameters": [
{
"name": "id",
"in": "path",
"description": "deleting Id",
"required": true,
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
{
"name": "tennantId",
"in": "path",
Expand All @@ -457,6 +487,36 @@
}
}
],
"requestBody": {
"description": "deleting Ids",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Deleted",
Expand Down
12 changes: 6 additions & 6 deletions test/WebSites/GenericControllers/Controllers/GenericResourceController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,36 +29,36 @@ public int Create([FromBody, Required] TResource resource, CancellationToken can
/// <returns></returns>
/// <response code="200">Deleted</response>
/// <response code="404">Failed</response>
[HttpDelete($"{nameof(Delete)}/{{{nameof(id)}}}")]
public virtual int Delete([Required, FromRoute] TResource id, CancellationToken cancellationToken)
[HttpDelete($"{nameof(Delete)}ById")]
public virtual int Delete([Required, FromBody] TResource id, CancellationToken cancellationToken)
{
return 1;
}

/// <summary>
/// Delete by Id List
/// </summary>
/// <param name="id">deleting Id</param>
/// <param name="ids">deleting Ids</param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
/// <response code="200">Deleted</response>
/// <response code="404">Failed</response>
[HttpDelete($"{nameof(Delete)}/List")]
public virtual int Delete([Required, FromRoute] List<TResource> id, CancellationToken cancellationToken)
public virtual int Delete([Required, FromBody] List<TResource> ids, CancellationToken cancellationToken)
{
return 1;
}

/// <summary>
/// Delete by Ids
/// </summary>
/// <param name="ids">deleting Ids</param>
/// <param name="resources">deleting Ids</param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
/// <response code="200">Deleted</response>
/// <response code="404">Failed</response>
[HttpDelete("")]
public virtual int Delete([Required, FromBody] TResource[] ids, CancellationToken cancellationToken)
public virtual int Delete([Required, FromBody] TResource[] resources, CancellationToken cancellationToken)
{
return 1;
}
Expand Down