Add final endpoint descriptions - 434 of 441 endpoints now documented

Co-authored-by: AndyButland <[email protected]>

Author: Copilot

src/Umbraco.Cms.Api.Management/Controllers/Document/RecycleBin/ReferencedByDocumentRecycleBinController.cs

@@ -32,6 +32,8 @@ public ReferencedByDocumentRecycleBinController(
     [HttpGet("referenced-by")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<IReferenceResponseModel>), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets items referencing a document in the recycle bin.")]
+    [EndpointDescription("Gets a paginated collection of items that reference the document in the recycle bin.")]
     public async Task<ActionResult<PagedViewModel<IReferenceResponseModel>>> ReferencedBy(
         CancellationToken cancellationToken,
         int skip = 0,

src/Umbraco.Cms.Api.Management/Controllers/Document/RecycleBin/RootDocumentRecycleBinController.cs

@@ -19,6 +19,8 @@ public RootDocumentRecycleBinController(IEntityService entityService, IDocumentP
     [HttpGet("root")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<DocumentRecycleBinItemResponseModel>), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets documents at the root of the recycle bin.")]
+    [EndpointDescription("Gets a paginated collection of documents at the root level of the recycle bin.")]
     public async Task<ActionResult<PagedViewModel<DocumentRecycleBinItemResponseModel>>> Root(
         CancellationToken cancellationToken,
         int skip = 0,

src/Umbraco.Cms.Api.Management/Controllers/Document/RecycleBin/SiblingsDocumentRecycleBinController.cs

@@ -19,6 +19,8 @@ public SiblingsDocumentRecycleBinController(IEntityService entityService, IDocum
     [HttpGet("siblings")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(SubsetViewModel<DocumentRecycleBinItemResponseModel>), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets sibling documents in the recycle bin.")]
+    [EndpointDescription("Gets a collection of sibling documents in the recycle bin at the same level as the provided Id.")]
     public async Task<ActionResult<SubsetViewModel<DocumentRecycleBinItemResponseModel>>> Siblings(CancellationToken cancellationToken, Guid target, int before, int after, Guid? dataTypeId = null)
         => await GetSiblings(target, before, after);
 }

src/Umbraco.Cms.Api.Management/Controllers/Document/References/ReferencedDescendantsDocumentController.cs

@@ -32,6 +32,8 @@ public ReferencedDescendantsDocumentController(ITrackedReferencesService tracked
     [HttpGet("{id:guid}/referenced-descendants")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(PagedViewModel<ReferenceByIdModel>), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets document descendants that are referenced.")]
+    [EndpointDescription("Gets a paginated collection of descendant documents that are referenced by other content.")]
     public async Task<ActionResult<PagedViewModel<ReferenceByIdModel>>> ReferencedDescendants(
         CancellationToken cancellationToken,
         Guid id,

src/Umbraco.Cms.Api.Management/Controllers/DynamicRoot/GetDynamicRootController.cs

@@ -28,6 +28,8 @@ public GetRootsController(IDynamicRootService dynamicRootService, IUmbracoMapper
     [HttpPost("query")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(DynamicRootResponseModel), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets dynamic roots.")]
+    [EndpointDescription("Gets a collection of dynamic root items based on the provided query configuration.")]
     public async Task<IActionResult> GetRoots(CancellationToken cancellationToken, DynamicRootRequestModel model)
     {
         _backOfficeVariationContextAccessor.VariationContext = new BackOfficeVariationContext(model.Context.Culture, model.Context.Segment);

src/Umbraco.Cms.Api.Management/Controllers/DynamicRoot/GetQueryStepsController.cs

@@ -21,6 +21,8 @@ public GetQueryStepsController(DynamicRootQueryStepCollection dynamicRootQuerySt
     [HttpGet($"steps")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(IEnumerable<string>), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets dynamic root query steps.")]
+    [EndpointDescription("Gets a collection of available query steps for configuring dynamic root queries.")]
     public Task<IActionResult> GetQuerySteps(CancellationToken cancellationToken)
     {
         IEnumerable<string> querySteps = _dynamicRootQueryStepCollection.Select(x => x.SupportedDirectionAlias);

src/Umbraco.Cms.Api.Management/Controllers/HealthCheck/ExecuteActionHealthCheckController.cs

@@ -38,6 +38,8 @@ public ExecuteActionHealthCheckController(
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
     [ProducesResponseType(typeof(HealthCheckResultResponseModel), StatusCodes.Status200OK)]
+    [EndpointSummary("Executes a health check action.")]
+    [EndpointDescription("Executes a specific action to fix or address a health check issue.")]
     public async Task<ActionResult<HealthCheckResultResponseModel>> ExecuteAction(
         CancellationToken cancellationToken,
         HealthCheckActionRequestModel action)

src/Umbraco.Cms.Api.Management/Controllers/Install/ValidateDatabaseInstallController.cs

@@ -28,6 +28,8 @@ public ValidateDatabaseInstallController(
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
     [ProducesResponseType(StatusCodes.Status200OK)]
+    [EndpointSummary("Validates database connection.")]
+    [EndpointDescription("Validates the database connection settings provided during installation.")]
     public async Task<IActionResult> ValidateDatabase(
         CancellationToken cancellationToken,
         DatabaseInstallRequestModel viewModel)

src/Umbraco.Cms.Api.Management/Controllers/Language/Item/DefaultLanguageEntityController.cs

@@ -24,6 +24,8 @@ public DefaultLanguageEntityController(ILanguageService languageService, IUmbrac
     [HttpGet("default")]
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(LanguageItemResponseModel), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets the default language.")]
+    [EndpointDescription("Gets the default language configured for the Umbraco installation.")]
     public async Task<IActionResult> Default(CancellationToken cancellationToken)
     {
         ILanguage? language = await _languageService.GetDefaultLanguageAsync();

src/Umbraco.Cms.Api.Management/Controllers/LogViewer/SavedSearch/ByNameSavedSearchLogViewerController.cs

@@ -29,6 +29,8 @@ public ByNameSavedSearchLogViewerController(ILogViewerService logViewerService,
     [MapToApiVersion("1.0")]
     [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
     [ProducesResponseType(typeof(SavedLogSearchResponseModel), StatusCodes.Status200OK)]
+    [EndpointSummary("Gets a saved log search by name.")]
+    [EndpointDescription("Gets a saved log search identified by the provided name.")]
     public async Task<IActionResult> ByName(
         CancellationToken cancellationToken,
         string name)