Skip to content

Commit b625851

Browse files
CopilotAndyButland
andcommitted
Simplify endpoint descriptions - remove redundant phrases and fix compound words
Co-authored-by: AndyButland <[email protected]>
1 parent f0547a9 commit b625851

File tree

63 files changed

+72
-72
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+72
-72
lines changed

src/Umbraco.Cms.Api.Management/Controllers/DataType/CreateDataTypeController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public CreateDataTypeController(IDataTypeService dataTypeService, IDataTypePrese
3434
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
3535
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3636
[EndpointSummary("Creates a new data type.")]
37-
[EndpointDescription("Creates a new data type with the configuration specified in the request model.")]
37+
[EndpointDescription("Creates a new data type from the request.")]
3838
public async Task<IActionResult> Create(CancellationToken cancellationToken, CreateDataTypeRequestModel createDataTypeRequestModel)
3939
{
4040
var attempt = await _dataTypePresentationFactory.CreateAsync(createDataTypeRequestModel);

src/Umbraco.Cms.Api.Management/Controllers/DataType/Folder/UpdateDataTypeFolderController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public UpdateDataTypeFolderController(
2323
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
2424
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
2525
[EndpointSummary("Updates a datatype folder.")]
26-
[EndpointDescription("Updates a datatype folder identified by the provided Id with the details from the request model.")]
26+
[EndpointDescription("Updates a datatype folder identified by the provided Id from the request.")]
2727
public async Task<IActionResult> Update(
2828
CancellationToken cancellationToken,
2929
Guid id,

src/Umbraco.Cms.Api.Management/Controllers/DataType/UpdateDataTypeController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ public UpdateDataTypeController(IDataTypeService dataTypeService, IBackOfficeSec
3434
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
3535
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3636
[EndpointSummary("Updates a datatype.")]
37-
[EndpointDescription("Updates a datatype identified by the provided Id with the details from the request model.")]
37+
[EndpointDescription("Updates a datatype identified by the provided Id from the request.")]
3838
public async Task<IActionResult> Update(CancellationToken cancellationToken, Guid id, UpdateDataTypeRequestModel updateDataTypeViewModel)
3939
{
4040
IDataType? current = await _dataTypeService.GetAsync(id);

src/Umbraco.Cms.Api.Management/Controllers/Dictionary/CreateDictionaryController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public CreateDictionaryController(
4242
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
4343
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status409Conflict)]
4444
[EndpointSummary("Creates a new dictionary.")]
45-
[EndpointDescription("Creates a new dictionary with the configuration specified in the request model.")]
45+
[EndpointDescription("Creates a new dictionary from the request.")]
4646
public async Task<IActionResult> Create(
4747
CancellationToken cancellationToken,
4848
CreateDictionaryItemRequestModel createDictionaryItemRequestModel)

src/Umbraco.Cms.Api.Management/Controllers/Dictionary/UpdateDictionaryController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public UpdateDictionaryController(
4242
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
4343
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
4444
[EndpointSummary("Updates a dictionary.")]
45-
[EndpointDescription("Updates a dictionary identified by the provided Id with the details from the request model.")]
45+
[EndpointDescription("Updates a dictionary identified by the provided Id from the request.")]
4646
public async Task<IActionResult> Update(
4747
CancellationToken cancellationToken,
4848
Guid id,

src/Umbraco.Cms.Api.Management/Controllers/Document/CreateDocumentController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public CreateDocumentController(
3737
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
3838
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3939
[EndpointSummary("Creates a new document.")]
40-
[EndpointDescription("Creates a new document with the configuration specified in the request model.")]
40+
[EndpointDescription("Creates a new document from the request.")]
4141
public async Task<IActionResult> Create(
4242
CancellationToken cancellationToken,
4343
CreateDocumentRequestModel requestModel)

src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDocumentController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public UpdateDocumentController(
3737
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
3838
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3939
[EndpointSummary("Updates a document.")]
40-
[EndpointDescription("Updates a document identified by the provided Id with the details from the request model.")]
40+
[EndpointDescription("Updates a document identified by the provided Id from the request.")]
4141
public async Task<IActionResult> Update(
4242
CancellationToken cancellationToken,
4343
Guid id,

src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateDomainsController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public UpdateDomainsController(IDomainService domainService, IUmbracoMapper umbr
3333
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
3434
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status409Conflict)]
3535
[EndpointSummary("Updates a document.")]
36-
[EndpointDescription("Updates a document identified by the provided Id with the details from the request model.")]
36+
[EndpointDescription("Updates a document identified by the provided Id from the request.")]
3737
public async Task<IActionResult> Update(
3838
CancellationToken cancellationToken,
3939
Guid id,

src/Umbraco.Cms.Api.Management/Controllers/Document/UpdateNotificationsController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public UpdateNotificationsController(IContentEditingService contentEditingServic
2727
[ProducesResponseType(StatusCodes.Status200OK)]
2828
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
2929
[EndpointSummary("Updates a document.")]
30-
[EndpointDescription("Updates a document identified by the provided Id with the details from the request model.")]
30+
[EndpointDescription("Updates a document identified by the provided Id from the request.")]
3131
public async Task<IActionResult> UpdateNotifications(CancellationToken cancellationToken, Guid id, UpdateDocumentNotificationsRequestModel updateModel)
3232
{
3333
IContent? content = await _contentEditingService.GetAsync(id);

src/Umbraco.Cms.Api.Management/Controllers/Document/UpdatePublicAccessDocumentController.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public UpdatePublicAccessDocumentController(
3838
[ProducesResponseType(StatusCodes.Status200OK)]
3939
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
4040
[EndpointSummary("Updates a document.")]
41-
[EndpointDescription("Updates a document identified by the provided Id with the details from the request model.")]
41+
[EndpointDescription("Updates a document identified by the provided Id from the request.")]
4242
public async Task<IActionResult> Update(CancellationToken cancellationToken, Guid id, PublicAccessRequestModel requestModel)
4343
{
4444
AuthorizationResult authorizationResult = await _authorizationService.AuthorizeResourceAsync(

0 commit comments

Comments
 (0)