docs(V2): document optional fields for unit split endpoint#1574
Merged
Conversation
rc release
Cascading deletes
The v2/unit/split example used incorrect v1 field names (unitOwner, countryJurisdictionOfOwner) and was missing supported optional fields. Add field reference tables and fix the example to use the correct v2 field names: unitCurrentOwner, unitStatusReason, unitStatusDate.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
v2/unit/splitdocumentation example (unitOwner→unitCurrentOwner, removed non-existentcountryJurisdictionOfOwner)unitCount) and optional (unitBlockStart,unitBlockEnd,unitCurrentOwner,unitStatus,unitStatusReason,unitStatusDate) fields per split recorduuidto the response example to match actual controller behaviorTest plan
UnitV2.split()implementation insrc/models/v2/unit-v2.model.jsNote
Low Risk
Low risk: documentation-only changes that correct field names and examples, with no runtime or data-handling impact.
Overview
Improves the
POST /v2/unit/splitdocumentation by explaining split behavior (inherit/override semantics and ID assignment) and adding required/optional per-record field tables.Fixes the request example to use
unitCurrentOwner(and removes non-existent fields) and updates the response example to include the returneduuid.Reviewed by Cursor Bugbot for commit 27c46fd. Bugbot is set up for automated code reviews on this repo. Configure here.