Fix to management API models reverting addition of read-only property #19951
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR reverts a read-only property addition to management API models that was causing breaking changes to client-side generated types. The primary goal is to fix the signs property implementation across various response models to prevent generation issues.
Key changes:
- Made the
signsproperty settable instead of read-only across base classes - Updated OpenAPI schema to remove read-only constraint from signs properties
- Modified mapping definitions to exclude signs from auto-mapping
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| types.gen.ts | Generated TypeScript types with signs property now settable across all response models |
| EntityTreeItemResponseModel.cs | Changed signs property from read-only to settable with backing field modification |
| ItemResponseModelBase.cs | Made signs property settable in base item model |
| ContentResponseModelBase.cs | Updated content base model to allow signs property setting |
| OpenApi.json | Removed read-only constraint from signs property in OpenAPI schema |
| ItemTypeMapDefinition.cs | Added signs exclusion comments to mapping definitions |
| DocumentTypeMapDefinition.cs | Added signs exclusion comment to blueprint mapping |
src/Umbraco.Cms.Api.Management/ViewModels/Tree/EntityTreeItemResponseModel.cs
Outdated
Show resolved
Hide resolved
src/Umbraco.Cms.Api.Management/ViewModels/Item/ItemResponseModelBase.cs
Outdated
Show resolved
Hide resolved
src/Umbraco.Cms.Api.Management/ViewModels/Content/ContentResponseModelBase.cs
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This removes a read-only property that was added to the base item, collection and tree models that leads to breaking changes to the client-side generated types.