PINT 3.0: SD-2059: Remove nullable from optional reason field

[HenrikHL]

SD-2059: Remove nullable: true from optional reason field. If there is no value the reason property must be omitted

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶 SD-2059 - Partially compliant Compliant requirements: Remove nullable: true from optional reason field. Update the description to clarify omission instead of null. Update example to a descriptive non-null value. Non-compliant requirements: Remove nullable: true from all other optional properties in the PINT API (if any beyond reason are present). Requires further human verification: Verify there are no remaining nullable: true occurrences on optional properties across the entire PINT v3 spec. Confirm downstream consumers and validators accept omitted reason and updated description without breaking changes. Validate external references/links in description (e.g., #/EnvelopeTransferFinishedResponse) resolve correctly in the rendered docs.

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Consistency Ensure nullable: true has been removed consistently for all optional fields in this schema section and elsewhere to avoid mixed guidance in the API. example: eyJhbGciOiJSUzI1NiIsImtpZCI6IlVhRVdLNmt2ZkRITzNZT2NwUGl2M1RCT2JQTzk2SFZhR2U0czFhUUxBZU0ifQ.eyJlYmxQbGF0Zm9ybSI6IkJPTEUiLCJ0cmFuc3BvcnREb2N1bWVudENoZWNrc3VtIjoiNTgzYzI5YWIzZTQ3ZjJkODA4OTk5OTMyMDBkM2ZiYWRiOWY4YTM2N2YzYTM5ZjcxNTkzNWM0NmQ3YTI4MzAwNiIsInRyYW5zYWN0aW9ucyI6W3siYWN0aW9uIjoiVFJOUyIsImFjdG9yIjp7InBhcnR5TmFtZSI6IklLRUEgRGVubWFyayIsImVibFBsYXRmb3JtIjoiQk9MRSIsImlkZW50aWZ5aW5nQ29kZXMiOlt7ImNvZGVMaXN0UHJvdmlkZXIiOiJHTEVJRiIsInBhcnR5Q29kZSI6IjIxMzgwMEhYNklaTTFRTkJBSjMzIiwiY29kZUxpc3ROYW1lIjoiTEVJIn1dfSwicmVjaXBpZW50Ijp7InBhcnR5TmFtZSI6IkhlbnJpayBMYXJzZW4iLCJlYmxQbGF0Zm9ybSI6IldBVkUiLCJ0YXhMZWdhbFJlZmVyZW5jZXMiOlt7InR5cGUiOiJDVlIiLCJjb3VudHJ5Q29kZSI6IkRLIiwidmFsdWUiOiIzMzk5MTI4MiJ9XX0sInRpbWVzdGFtcCI6MTcxMzM0MjY3OTUzMX1dfQ.c4SJ9-61fE6RmeIuZ3EI-TSM0M6qXuOudtr3YhpDjqVMaYk_RYpaWYvw75ssTbjgGFKTBKCy5lpmOfb8Fq--Qu2k0MWbH6qdX5jTYwl0DX946RQg-hnmVTg9np3bmqVeKqKURyV-UUdG-KK_XCGzPZ-lZkeUlpMcIthQFs0pCODR9GPytv7ZXLPZFOmHM9fn3FD2yRqVhQzcs7HdcxMjCx6hkBW8Z-jW4qteVy2_E9uqjkKwlu_cQLoY83Z0mcjn0PZNQvKF10x7q1_Jjf_Su19UigTUu3pFMrzo4iPS_jcrFoIb3TSZNSzbgAwtujSBFOufPDyEmxlx1sH0ZowMvA reason: type: string description: | Free text comment for clarifying the result or suggesting follow up actions. Should be omitted when [`responseCode`](#/EnvelopeTransferFinishedResponse) is `RECE`, where there is no additional information to be given. maxLength: 255 example: 'The reason is...' missingAdditionalDocumentChecksums: Broken Reference The description includes a $ref-style link to #/EnvelopeTransferFinishedResponse; verify this anchor exists and renders correctly in the documentation tooling. description: | Free text comment for clarifying the result or suggesting follow up actions. Should be omitted when [`responseCode`](#/EnvelopeTransferFinishedResponse) is `RECE`, where there is no additional information to be given. maxLength: 255 example: 'The reason is...'

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Prevent empty-string payloads Since nullable was removed, ensure empty strings are not used to simulate omission. Add minLength: 1 and clarify in the description that the field must be a non-empty string when present. pint/v3/EBL_PINT_v3.0.0.yaml [843-848] reason: type: string + minLength: 1 + maxLength: 255 description: | - Free text comment for clarifying the result or suggesting follow up actions. Should be omitted when [`responseCode`](#/EnvelopeTransferFinishedResponse) is `RECE`, where there is no additional information to be given. - maxLength: 255 + Free text comment for clarifying the result or suggesting follow up actions. When present, this must be a non-empty string. Should be omitted when [`responseCode`](#/EnvelopeTransferFinishedResponse) is `RECE`, where there is no additional information to be given. example: 'The reason is...' Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that removing nullable can lead to ambiguous empty strings and proposes adding minLength: 1 to enforce a non-empty value, which improves the API's robustness.	Medium
Update