-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Management API: Add endpoints, service and repository methods for retrieving the allowed parents for content types #21586
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
63ad4e6
Document Types returns a list of allowed parent keys
NillasKA 88b3678
Media types included
NillasKA 1b4e7e0
Minor fixes to namespace etc.
NillasKA dcc58bd
Tests
NillasKA a3da64a
Fixing breaking change
NillasKA 321eae7
Correcting requested changes
NillasKA 681bb3b
Corrected requested changes
NillasKA c33db4e
Merge branch 'main' into v17/feature/allowed-parents-endpoint
AndyButland 05f34a2
Removed unnecessary usings, aligned naming between service, repositor…
AndyButland File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
52 changes: 52 additions & 0 deletions
52
...braco.Cms.Api.Management/Controllers/DocumentType/AllowedParentsDocumentTypeController.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| using Asp.Versioning; | ||
| using Microsoft.AspNetCore.Http; | ||
| using Microsoft.AspNetCore.Mvc; | ||
| using Umbraco.Cms.Api.Management.ViewModels.DocumentType; | ||
| using Umbraco.Cms.Core; | ||
| using Umbraco.Cms.Core.Models; | ||
| using Umbraco.Cms.Core.Services; | ||
| using Umbraco.Cms.Core.Services.OperationStatus; | ||
| using Umbraco.Extensions; | ||
|
|
||
| namespace Umbraco.Cms.Api.Management.Controllers.DocumentType; | ||
|
|
||
| [ApiVersion("1.0")] | ||
| public class AllowedParentsDocumentTypeController : DocumentTypeControllerBase | ||
| { | ||
| private readonly IContentTypeService _contentTypeService; | ||
|
|
||
| public AllowedParentsDocumentTypeController(IContentTypeService contentTypeService) | ||
| { | ||
| _contentTypeService = contentTypeService; | ||
| } | ||
|
|
||
| [HttpGet("{id:guid}/allowed-parents")] | ||
| [MapToApiVersion("1.0")] | ||
| [ProducesResponseType(typeof(DocumentTypeAllowedParentsResponseModel), StatusCodes.Status200OK)] | ||
| [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] | ||
| public async Task<IActionResult> AllowedParentsByKey( | ||
| CancellationToken cancellationToken, | ||
| Guid id) | ||
| { | ||
| Attempt<IEnumerable<Guid>?, ContentTypeOperationStatus> attempt = await _contentTypeService.GetAllowedParentsAsync(id, UmbracoObjectTypes.DocumentType); | ||
| if (attempt.Success is false) | ||
| { | ||
| return OperationStatusResult(attempt.Status); | ||
| } | ||
|
|
||
| if (attempt.Result == null || !attempt.Result.Any()) | ||
| { | ||
| return Ok(new DocumentTypeAllowedParentsResponseModel | ||
| { | ||
| AllowedParentsKeys = [], | ||
| }); | ||
| } | ||
|
|
||
| var model = new DocumentTypeAllowedParentsResponseModel | ||
| { | ||
| AllowedParentsKeys = attempt.Result, | ||
| }; | ||
|
|
||
| return Ok(model); | ||
| } | ||
| } | ||
52 changes: 52 additions & 0 deletions
52
src/Umbraco.Cms.Api.Management/Controllers/MediaType/AllowedParentsMediaTypeController.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| using Asp.Versioning; | ||
| using Microsoft.AspNetCore.Http; | ||
| using Microsoft.AspNetCore.Mvc; | ||
| using Umbraco.Cms.Api.Management.ViewModels.MediaType; | ||
| using Umbraco.Cms.Core; | ||
| using Umbraco.Cms.Core.Models; | ||
| using Umbraco.Cms.Core.Services; | ||
| using Umbraco.Cms.Core.Services.OperationStatus; | ||
| using Umbraco.Extensions; | ||
|
|
||
| namespace Umbraco.Cms.Api.Management.Controllers.MediaType; | ||
|
|
||
| [ApiVersion("1.0")] | ||
| public class AllowedParentsMediaTypeController : MediaTypeControllerBase | ||
| { | ||
| private readonly IMediaTypeService _mediaTypeService; | ||
|
|
||
| public AllowedParentsMediaTypeController(IMediaTypeService mediaTypeService) | ||
| { | ||
| _mediaTypeService = mediaTypeService; | ||
| } | ||
|
|
||
| [HttpGet("{id:guid}/allowed-parents")] | ||
| [MapToApiVersion("1.0")] | ||
| [ProducesResponseType(typeof(MediaTypeAllowedParentsResponseModel), StatusCodes.Status200OK)] | ||
| [ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)] | ||
| public async Task<IActionResult> AllowedParentsByKey( | ||
| CancellationToken cancellationToken, | ||
| Guid id) | ||
| { | ||
| Attempt<IEnumerable<Guid>?, ContentTypeOperationStatus> attempt = await _mediaTypeService.GetAllowedParentsAsync(id, UmbracoObjectTypes.MediaType); | ||
| if (attempt.Success is false) | ||
| { | ||
| return OperationStatusResult(attempt.Status); | ||
| } | ||
|
|
||
| if (attempt.Result == null || !attempt.Result.Any()) | ||
| { | ||
| return Ok(new MediaTypeAllowedParentsResponseModel | ||
| { | ||
| AllowedParentsKeys = [], | ||
| }); | ||
| } | ||
|
|
||
| var model = new MediaTypeAllowedParentsResponseModel | ||
| { | ||
| AllowedParentsKeys = attempt.Result, | ||
| }; | ||
|
|
||
| return Ok(model); | ||
| } | ||
| } |
6 changes: 6 additions & 0 deletions
6
...aco.Cms.Api.Management/ViewModels/DocumentType/DocumentTypeAllowedParentsResponseModel.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| namespace Umbraco.Cms.Api.Management.ViewModels.DocumentType; | ||
|
|
||
| public class DocumentTypeAllowedParentsResponseModel | ||
| { | ||
| public required IEnumerable<Guid> AllowedParentsKeys { get; set; } | ||
NillasKA marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
6 changes: 6 additions & 0 deletions
6
src/Umbraco.Cms.Api.Management/ViewModels/MediaType/MediaTypeAllowedParentsResponseModel.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| namespace Umbraco.Cms.Api.Management.ViewModels.MediaType; | ||
|
|
||
| public class MediaTypeAllowedParentsResponseModel | ||
| { | ||
| public required IEnumerable<Guid> AllowedParentsKeys { get; set; } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.