Skip to content
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.

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

Align various controllers #16137

Merged
merged 9 commits into from
Apr 25, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@
namespace Umbraco.Cms.Api.Management.Controllers.Language.Item;

[ApiVersion("1.0")]
public class ItemsLanguageEntityController : LanguageEntityControllerBase
public class ItemLanguageItemController : LanguageItemControllerBase
{
private readonly ILanguageService _languageService;
private readonly IUmbracoMapper _mapper;

public ItemsLanguageEntityController(ILanguageService languageService, IUmbracoMapper mapper)
public ItemLanguageItemController(ILanguageService languageService, IUmbracoMapper mapper)
{
_languageService = languageService;
_mapper = mapper;
Expand All @@ -23,7 +23,7 @@ public ItemsLanguageEntityController(ILanguageService languageService, IUmbracoM
[HttpGet]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(IEnumerable<LanguageItemResponseModel>), StatusCodes.Status200OK)]
public async Task<ActionResult> Items(
public async Task<IActionResult> Item(
CancellationToken cancellationToken,
[FromQuery(Name = "isoCode")] HashSet<string> isoCodes)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ namespace Umbraco.Cms.Api.Management.Controllers.Language.Item;
[VersionedApiBackOfficeRoute($"{Constants.Web.RoutePath.Item}/{Constants.UdiEntityType.Language}")]
[ApiExplorerSettings(GroupName = nameof(Constants.UdiEntityType.Language))]
[Authorize(Policy = AuthorizationPolicies.TreeAccessLanguages)]
public class LanguageEntityControllerBase : ManagementApiControllerBase
public class LanguageItemControllerBase : ManagementApiControllerBase
{
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ public CreateMemberGroupController(IMemberGroupService memberGroupService, IUmbr

[HttpPost]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(MemberGroupResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status201Created)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
public async Task<IActionResult> Create(CancellationToken cancellationToken, CreateMemberGroupRequestModel model)
{
IMemberGroup? memberGroup = _mapper.Map<IMemberGroup>(model);
Attempt<IMemberGroup?, MemberGroupOperationStatus> result = await _memberGroupService.CreateAsync(memberGroup!);
return result.Success
? Ok(_mapper.Map<MemberGroupResponseModel>(result.Result))
? CreatedAtId<ByKeyMemberGroupController>(controller => nameof(controller.ByKey), result.Result!.Key)
: MemberGroupOperationStatusResult(result.Status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public UpdateMemberGroupController(IUmbracoMapper mapper, IMemberGroupService me

[HttpPut($"{{{nameof(id)}:guid}}")]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(MemberGroupResponseModel), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
public async Task<IActionResult> Update(
Expand All @@ -42,7 +42,7 @@ public async Task<IActionResult> Update(

Attempt<IMemberGroup?, MemberGroupOperationStatus> result = await _memberGroupService.UpdateAsync(updated);
return result.Success
? Ok(_mapper.Map<MemberGroupResponseModel>(result.Result))
? Ok()
: MemberGroupOperationStatusResult(result.Status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public UpdateUserDataController(
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(typeof(UserDataOperationStatus), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(UserDataOperationStatus), StatusCodes.Status404NotFound)]
public async Task<IActionResult> Create(CancellationToken cancellationToken, UpdateUserDataRequestModel model)
public async Task<IActionResult> Update(CancellationToken cancellationToken, UpdateUserDataRequestModel model)
{
Guid currentUserKey = CurrentUserKey(_backOfficeSecurityAccessor);

Expand All @@ -43,7 +43,7 @@ public async Task<IActionResult> Create(CancellationToken cancellationToken, Upd
Attempt<IUserData, UserDataOperationStatus> attempt = await _userDataService.UpdateAsync(userData);

return attempt.Success
? Ok(attempt.Result)
? Ok()
: UserDataOperationStatusResult(attempt.Status);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,23 @@
namespace Umbraco.Cms.Api.Management.Controllers.Webhook.Item;

[ApiVersion("1.0")]
public class ItemsWebhookEntityController : WebhookEntityControllerBase
public class ItemWebhookItemController : WebhookItemControllerBase
{
private readonly IWebhookService _webhookService;
private readonly IUmbracoMapper _mapper;

public ItemsWebhookEntityController(IWebhookService webhookService, IUmbracoMapper mapper)
public ItemWebhookItemController(IWebhookService webhookService, IUmbracoMapper mapper)
{
_webhookService = webhookService;
_mapper = mapper;
}

[HttpGet("item")]
[HttpGet]
[MapToApiVersion("1.0")]
[ProducesResponseType(typeof(IEnumerable<WebhookItemResponseModel>), StatusCodes.Status200OK)]
public async Task<ActionResult> Items(
public async Task<IActionResult> Item(
CancellationToken cancellationToken,
[FromQuery(Name = "ids")] HashSet<Guid> ids)
[FromQuery(Name = "id")] HashSet<Guid> ids)
{
if (ids.Count is 0)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

namespace Umbraco.Cms.Api.Management.Controllers.Webhook.Item;

[VersionedApiBackOfficeRoute($"{Constants.UdiEntityType.Webhook}")]
[VersionedApiBackOfficeRoute($"{Constants.Web.RoutePath.Item}/{Constants.UdiEntityType.Webhook}")]
[ApiExplorerSettings(GroupName = "Webhook")]
[Authorize(Policy = AuthorizationPolicies.TreeAccessWebhooks)]
public class WebhookEntityControllerBase : ManagementApiControllerBase
public class WebhookItemControllerBase : ManagementApiControllerBase
{
}
Loading
Loading