Skip to content

#225 Add request body content to API operations #226

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 1 commit into from
Jan 28, 2025
Merged

#225 Add request body content to API operations #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions src/CommunityToolkit.Datasync.Server.Swashbuckle/DatasyncDocumentFilter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ internal void ProcessController(Type entityType, string routePath, OpenApiDocume
case OpType.Create:
// Request Edits
operation.Value.AddConditionalHeader(true);
operation.Value.AddRequestWithContent(context.SchemaRepository.Schemas[entityType.Name]);

// Response Edits
operation.Value.AddResponseWithContent("201", "Created", context.SchemaRepository.Schemas[entityType.Name]);
Expand Down Expand Up @@ -152,6 +153,7 @@ internal void ProcessController(Type entityType, string routePath, OpenApiDocume
case OpType.Replace:
// Request Edits
operation.Value.AddConditionalHeader();
operation.Value.AddRequestWithContent(context.SchemaRepository.Schemas[entityType.Name]);

// Response Edits
operation.Value.AddResponseWithContent("200", "OK", context.SchemaRepository.Schemas[entityType.Name]);
Expand Down
18 changes: 18 additions & 0 deletions src/CommunityToolkit.Datasync.Server.Swashbuckle/DatasyncOperationExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,24 @@ internal static void AddResponseWithContent(this OpenApiOperation operation, str
});
operation.Responses[statusCode] = response;
}
/// <summary>
/// Adds the content type and schema to the request body.
/// </summary>
/// <param name="operation">The <see cref="OpenApiOperation"/> to modify.</param>
/// <param name="schema">The schema of the entity in the request.</param>
internal static void AddRequestWithContent(this OpenApiOperation operation, OpenApiSchema schema)
{
operation.RequestBody = new OpenApiRequestBody
{
Content = new Dictionary<string, OpenApiMediaType>
{
[JsonMediaType] = new OpenApiMediaType()
{
Schema = schema
}
}
};
}

/// <summary>
/// Adds or replaces the 409/412 Conflict/Precondition Failed response.
Expand Down
36 changes: 36 additions & 0 deletions tests/CommunityToolkit.Datasync.Server.Swashbuckle.Test/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,15 @@
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KitchenSink"
}
}
}
},
"responses": {
"201": {
"description": "Created",
Expand Down Expand Up @@ -448,6 +457,15 @@
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/KitchenSink"
}
}
}
},
"responses": {
"200": {
"description": "OK",
Expand Down Expand Up @@ -530,6 +548,15 @@
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoItem"
}
}
}
},
"responses": {
"201": {
"description": "Created",
Expand Down Expand Up @@ -819,6 +846,15 @@
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TodoItem"
}
}
}
},
"responses": {
"200": {
"description": "OK",
Expand Down
Loading