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.

Sign up for GitHub

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

Jump to bottom

Document version endpoints #15946

Merged
merged 15 commits into from Apr 2, 2024
Merged

Document version endpoints #15946

merged 15 commits into from Apr 2, 2024

Conversation

Migaroez
Copy link
Contributor

@Migaroez Migaroez commented Mar 26, 2024 •
edited

Prerequisites

  • I have added steps to test this contribution in the description below

Description

Adds management API endpoints for

  • getting a list of version for a given document
  • get details about a version with a specific id
  • toggle the preventCleanup for a specific version
  • rollback to a specific version

Testing

  • Publish a document
  • Update the document and publish again (repeat a few times)
  • Make sure the relevant get endpoints reflect the changed data
  • Make sure the toggle and rollback endpoints work as expected
  • Nothing else breaks

Breaking changes

  • IContentVersionService methods have been brought into the async age
  • IContentVersionService default constructor has been changed

Sven Geusens added 6 commits February 19, 2024 16:37
Rename/Move/duplicate PaginationService to facilitate conversion clos…
110d639 
…er to the data layer

Duplication is because of internal modifier as we don't want to expose these temporary classes
Move Guid to Int Extensions into core + add unittests
50e75b7
Added Document version endpoints
40449d3 
Updated used services to use async methods
Merge branch 'v14/feature/document-version-endpoints' into v14/featur…
66c1d41 
…e/document-version

# Conflicts:
#	src/Umbraco.Cms.Api.Management/Controllers/Dictionary/Tree/ChildrenDictionaryTreeController.cs
#	src/Umbraco.Cms.Api.Management/Controllers/Dictionary/Tree/RootDictionaryTreeController.cs
#	src/Umbraco.Cms.Api.Management/Controllers/RecycleBin/RecycleBinControllerBase.cs
#	src/Umbraco.Cms.Api.Management/Controllers/RedirectUrlManagement/GetAllRedirectUrlManagementController.cs
#	src/Umbraco.Cms.Api.Management/Controllers/Tree/EntityTreeControllerBase.cs
#	src/Umbraco.Cms.Api.Management/Controllers/Tree/FileSystemTreeControllerBase.cs
#	src/Umbraco.Cms.Api.Management/DependencyInjection/DocumentBuilderExtensions.cs
#	src/Umbraco.Core/Services/Pagination/PaginationConverter.cs
Moved PaginationConverter into core so it can be used by the service …
4ac4218 
…layer
Endpoint structure improvements
1aea287
@Migaroez Migaroez changed the title Ddocument version endpoints Document version endpoints Mar 26, 2024
elit0451
elit0451 requested changes Mar 26, 2024
View reviewed changes
Copy link
Member

@elit0451 elit0451 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a lot of minor things to fix, I haven't been through all files. Can you please double-check with our other controllers/implementations to make sure we don't have to circle back to fix misalignments later 😉

src/Umbraco.Cms.Api.Management/Controllers/Document/Versions/DocumentVersionControllerBase.cs Outdated Show resolved Hide resolved
...mbraco.Cms.Api.Management/Controllers/Document/Versions/GetByKeyDocumentVersionController.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Versions/DocumentVersionControllerBase.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Versions/DocumentVersionControllerBase.cs Outdated Show resolved Hide resolved
elit0451
elit0451 requested changes Mar 27, 2024
View reviewed changes
Copy link
Member

@elit0451 elit0451 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, I still have a few comments before I get to testing 👀

src/Umbraco.Cms.Api.Management/Controllers/Document/Version/GetDocumentVersionsController.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Version/GetDocumentVersionsController.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Version/GetDocumentVersionsController.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Version/DocumentVersionControllerBase.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Controllers/Document/Version/GetDocumentVersionsController.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/Mapping/Document/DocumentVersionMapDefinition.cs Outdated Show resolved Hide resolved
src/Umbraco.Cms.Api.Management/ViewModels/Document/DocumentVersionItemResponseModel.cs Show resolved Hide resolved
src/Umbraco.Core/Services/ContentVersionService.cs Outdated Show resolved Hide resolved
src/Umbraco.Core/Services/IContentVersionService.cs Show resolved Hide resolved
src/Umbraco.Core/Services/IContentVersionService.cs Outdated Show resolved Hide resolved
Sven Geusens and others added 2 commits March 27, 2024 13:15
PR suggestion updates
fa89fca 
- Move endpoints into their own structural section as they are also in a different swagger section
- Naming improvements
- Allign PresentationFactories with similar classes
- Cleanup unused assignments
- Cleanup refactoring comments
- Improve obsoletion remarks
@elit0451
Cleanup
2a95de4
@elit0451 elit0451 added the project/bellissima AKA "the new backoffice" label Mar 27, 2024
elit0451
elit0451 approved these changes Apr 2, 2024
View reviewed changes
Copy link
Member

@elit0451 elit0451 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 💪

@Migaroez Migaroez merged commit 95849c2 into v14/dev Apr 2, 2024
15 of 16 checks passed
@Migaroez Migaroez deleted the v14/feature/document-version branch April 2, 2024 10:12
kjac added a commit that referenced this pull request Apr 2, 2024
@kjac
Fix swagger schema error after #15946
2cf84a3
@kjac kjac mentioned this pull request Apr 2, 2024
Merged
1 task
Migaroez pushed a commit that referenced this pull request Apr 3, 2024
@kjac
Fix swagger schema error after #15946 (#15971)
06cfec2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elit0451 elit0451 elit0451 approved these changes

Assignees
No one assigned
Labels
category/breaking project/bellissima AKA "the new backoffice" release/14.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Migaroez @elit0451 @bergmania