Skip to content

Commit f0547a9

Browse files
CopilotAndyButland
andcommitted
Add endpoint descriptions to final 7 Management API endpoints
Co-authored-by: AndyButland <[email protected]>
1 parent 37dbdfc commit f0547a9

File tree

7 files changed

+14
-0
lines changed

7 files changed

+14
-0
lines changed

src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/Group/ByNameHealthCheckGroupController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ public ByNameHealthCheckGroupController(
3131
[MapToApiVersion("1.0")]
3232
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3333
[ProducesResponseType(typeof(HealthCheckGroupPresentationModel), StatusCodes.Status200OK)]
34+
[EndpointSummary("Gets a health check group by name.")]
35+
[EndpointDescription("Gets a health check group and all its associated health checks identified by the provided group name.")]
3436
public Task<IActionResult> ByName(
3537
CancellationToken cancellationToken,
3638
string name)

src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/Group/CheckHealthCheckGroupController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ public CheckHealthCheckGroupController(IHealthCheckGroupPresentationFactory heal
2525
[MapToApiVersion("1.0")]
2626
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
2727
[ProducesResponseType(typeof(HealthCheckGroupWithResultResponseModel), StatusCodes.Status200OK)]
28+
[EndpointSummary("Executes all health checks in a group.")]
29+
[EndpointDescription("Runs all health checks in the group identified by the provided name and returns the results.")]
2830
public async Task<IActionResult> ByNameWithResult(
2931
CancellationToken cancellationToken,
3032
string name)

src/Umbraco.Cms.Api.Management/Controllers/Member/References/ReferencedDescendantsMemberController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ public ReferencedDescendantsMemberController(ITrackedReferencesService trackedRe
3232
[HttpGet("{id:guid}/referenced-descendants")]
3333
[MapToApiVersion("1.0")]
3434
[ProducesResponseType(typeof(PagedViewModel<ReferenceByIdModel>), StatusCodes.Status200OK)]
35+
[EndpointSummary("Gets a paginated collection of referenced descendant members.")]
36+
[EndpointDescription("Gets a paginated collection of descendant members that are referenced in relations for the member identified by the provided Id.")]
3537
public async Task<ActionResult<PagedViewModel<ReferenceByIdModel>>> ReferencedDescendants(
3638
CancellationToken cancellationToken,
3739
Guid id,

src/Umbraco.Cms.Api.Management/Controllers/PartialView/Snippet/ByIdController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ public ByIdController(IPartialViewService partialViewService, IUmbracoMapper umb
2424
[MapToApiVersion("1.0")]
2525
[ProducesResponseType(typeof(PartialViewSnippetResponseModel), StatusCodes.Status200OK)]
2626
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
27+
[EndpointSummary("Gets a partial view snippet.")]
28+
[EndpointDescription("Gets a partial view snippet identified by the provided Id.")]
2729
public async Task<IActionResult> GetById(
2830
CancellationToken cancellationToken,
2931
string id)

src/Umbraco.Cms.Api.Management/Controllers/PartialView/Snippet/GetAllController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ public GetAllController(IPartialViewService partialViewService, IUmbracoMapper u
2525
[HttpGet("snippet")]
2626
[MapToApiVersion("1.0")]
2727
[ProducesResponseType(typeof(PagedViewModel<PartialViewSnippetItemResponseModel>), StatusCodes.Status200OK)]
28+
[EndpointSummary("Gets a paginated collection of partial view snippets.")]
29+
[EndpointDescription("Gets a paginated collection of partial view snippets with support for skip and take pagination.")]
2830
public async Task<IActionResult> GetAll(CancellationToken cancellationToken, int skip = 0, int take = 100)
2931
{
3032
PagedModel<PartialViewSnippetSlim> snippets = await _partialViewService.GetSnippetsAsync(skip, take);

src/Umbraco.Cms.Api.Management/Controllers/Template/Query/ExecuteTemplateQueryController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ public ExecuteTemplateQueryController(
4646
[HttpPost("execute")]
4747
[MapToApiVersion("1.0")]
4848
[ProducesResponseType(typeof(TemplateQueryResultResponseModel), StatusCodes.Status200OK)]
49+
[EndpointSummary("Executes a template query.")]
50+
[EndpointDescription("Executes a template query with the provided parameters and returns the matching content results with execution metrics.")]
4951
public Task<ActionResult<TemplateQueryResultResponseModel>> Execute(
5052
CancellationToken cancellationToken,
5153
TemplateQueryExecuteModel query)

src/Umbraco.Cms.Api.Management/Controllers/Template/Query/SettingsTemplateQueryController.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ public SettingsTemplateQueryController(IContentTypeService contentTypeService)
1717
[HttpGet("settings")]
1818
[MapToApiVersion("1.0")]
1919
[ProducesResponseType(typeof(TemplateQuerySettingsResponseModel), StatusCodes.Status200OK)]
20+
[EndpointSummary("Gets template query settings.")]
21+
[EndpointDescription("Gets the available configuration settings for template queries including document type aliases, properties, and operators.")]
2022
public Task<ActionResult<TemplateQuerySettingsResponseModel>> Settings(CancellationToken cancellationToken)
2123
{
2224
var contentTypeAliases = _contentTypeService

0 commit comments

Comments
 (0)