[management] Code generation: update services and models#1877
[management] Code generation: update services and models#1877AdyenAutomationBot wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the deprecation documentation across several model files, including AndroidApp, Nexo, and UpdatePaymentMethodInfo, by transitioning from end-of-line comments to block comments and refining Javadoc tags. The review feedback recommends using standard Javadoc format instead of block comments for field deprecations to ensure better IDE support, maintaining consistency by using {@code ...} instead of backticks for code references, and addressing line length violations for improved readability.
| /* deprecated since Management API v3: Use `errors` instead. */ | ||
| @Deprecated private String errorCode; |
There was a problem hiding this comment.
Using a regular block comment (/* ... */) for deprecation is less effective than Javadoc (/** ... */), which is recognized by IDEs and documentation tools. Additionally, placing the annotation on the same line as the field can reduce visibility. It is recommended to use a multi-line Javadoc format and place the annotation on its own line.
| /* deprecated since Management API v3: Use `errors` instead. */ | |
| @Deprecated private String errorCode; | |
| /** @deprecated since Management API v3: Use {@code errors} instead. */ | |
| @Deprecated | |
| private String errorCode; |
| * **error** or **invalid**. | ||
| * @return the current {@code AndroidApp} instance, allowing for method chaining | ||
| * @deprecated since Management API v3 Use `errors` instead. | ||
| * @deprecated since Management API v3 Use `errors` instead. |
There was a problem hiding this comment.
The Javadoc uses backticks (`errors`) for code references, which is non-standard for Javadoc and inconsistent with the use of {@code ...} on the preceding line (line 206). It is recommended to use {@code errors} and add a period after the version for better clarity and standard compliance.
| * @deprecated since Management API v3 Use `errors` instead. | |
| * @deprecated Since Management API v3. Use {@code errors} instead. |
| /* deprecated since Management API v3: Use `storeId` instead. Only one store per payment method is allowed. */ | ||
| @Deprecated private List<String> storeIds; |
There was a problem hiding this comment.
This line is excessively long (114 characters), exceeding common line length limits such as the 100-character limit in Google Java Style. Furthermore, using a regular block comment for deprecation is less effective than Javadoc (/** ... */). Reverting to a multi-line Javadoc format improves readability and ensures the deprecation reason is visible in IDEs.
| /* deprecated since Management API v3: Use `storeId` instead. Only one store per payment method is allowed. */ | |
| @Deprecated private List<String> storeIds; | |
| /** | |
| * @deprecated since Management API v3: Use {@code storeId} instead. | |
| * Only one store per payment method is allowed. | |
| */ | |
| @Deprecated | |
| private List<String> storeIds; |
| * @deprecated since Management API v3 Use `storeId` instead. Only one store per payment method is | ||
| * allowed. |
There was a problem hiding this comment.
The Javadoc uses backticks (`storeId`) for code references, which is inconsistent with the use of {@code ...} on line 1144. Standard Javadoc uses {@code ...} for code snippets. Additionally, adding a period after the version improves sentence structure.
| * @deprecated since Management API v3 Use `storeId` instead. Only one store per payment method is | |
| * allowed. | |
| * @deprecated Since Management API v3. Use {@code storeId} instead. | |
| * Only one store per payment method is allowed. |
1cebd64 to
207e2ca
Compare
207e2ca to
8cc1bf2
Compare
This PR contains the automated changes for the
managementservice.The commit history of this PR reflects the
adyen-openapicommits that have been applied.