Openbravo Issue Tracking System - Modules
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0049291ModulesOpenbravo Business APIpublic2022-05-11 12:132024-01-03 12:17
Reportercaristu 
Assigned ToTriage Platform Conn 
PriorityhighSeverityminorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionFixed in Version 
Merge Request Status
Regression date
Regression introduced by commit
Regression level
Review Assigned To
Support ticket
OBNetwork customer
Regression introduced in release
Summary0049291: Properties mapped with java property mappings are not documented properly
DescriptionProperties mapped with java property mappings are not properly documented in the endpoints documentation

https://openbravo.atlassian.net/browse/RM-7764 [^]
Steps To Reproduce0) Go to https://livebuilds.openbravo.com/retail_modules_pgsql_pi/api [^]

- Import mappings:
1) Choose the Business Partner import service. Currently this entity mapping has a java property mapping for the locations field
2) Go to the Example Value. Note that the locations field example is just [{}] without any information of its inner structure
3) Expand the schema, note that the locations field type is: "Array of key-value pair {}]". This is used even if the property is not array...
- Export mappings:
1) Choose the Product service. Currently this entity mapping has a java property mapping for the characteristicValues field
2) Go to the Example Value. Note that the characteristicValues field example is just {} without any information of its inner structure
3) Expand the schema, note that the characteristicValues field type just is: "{ description:Java computed value }"

Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
related to feature request 0044599 closed Triage Platform Conn Retail Modules Add more context information for the Retail API endpoint fields documentation 
related to defect 0052565 closed vmromanos Modules API documentation fields 
blocks defect 0053906 closed vmromanos Modules Add documentation for Java Property Mapping Handlers - OMNI 
Attached Filespng swagger1.png (50,028) 2022-05-11 12:15
https://issues.openbravo.com/file_download.php?file_id=17011&type=bug
png

png swagger2.png (50,709) 2022-05-11 12:15
https://issues.openbravo.com/file_download.php?file_id=17012&type=bug
png

png swagger3.png (28,996) 2022-05-11 12:16
https://issues.openbravo.com/file_download.php?file_id=17013&type=bug
png
Issue History
Date ModifiedUsernameFieldChange
2022-05-11 12:13caristuNew Issue
2022-05-11 12:13caristuAssigned To => Triage Platform Conn
2022-05-11 12:13caristuTriggers an Emergency Pack => No
2022-05-11 12:13caristuIssue generated from0044614
2022-05-11 12:14caristuProjectRetail Modules => Modules
2022-05-11 12:14caristuCategoryRetail API => Openbravo Business API
2022-05-11 12:15caristuFile Added: swagger1.png
2022-05-11 12:15caristuFile Added: swagger2.png
2022-05-11 12:16caristuFile Added: swagger3.png
2022-05-11 12:16caristuStatusnew => acknowledged
2022-05-11 12:16caristuRelationship addedrelated to 0044599
2023-08-01 04:11PracticsIssue Monitored: Practics
2023-08-08 10:21alostaleTypedefect => feature request
2023-08-10 07:11alostaleDescription Updatedbug_revision_view_page.php?rev_id=26625#r26625
2023-08-24 12:53caristuRelationship addedrelated to 0052565
2023-10-16 10:57hgbotNote Added: 0155873
2023-10-16 10:57hgbotNote Added: 0155874
2023-10-16 11:10hgbotNote Added: 0155875
2023-10-16 11:16hgbotNote Added: 0155876
2023-11-06 10:42hgbotNote Added: 0156750
2023-11-06 10:42hgbotResolutionopen => fixed
2023-11-06 10:42hgbotStatusacknowledged => closed
2023-11-06 10:42hgbotNote Added: 0156751
2023-11-06 10:43hgbotNote Added: 0156752
2023-11-06 10:43hgbotNote Added: 0156753
2023-11-09 19:04vmromanosRelationship addedblocks 0053906
2023-12-29 11:24hgbotNote Added: 0158721
2024-01-03 12:17hgbotNote Added: 0158791

Notes
(0155873)
hgbot   
2023-10-16 10:57   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/198 [^]
(0155874)
hgbot   
2023-10-16 10:57   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/merge_requests/35 [^]
(0155875)
hgbot   
2023-10-16 11:10   
Merge Request created: https://gitlab.com/openbravo/product/openbravo/-/merge_requests/1021 [^]
(0155876)
hgbot   
2023-10-16 11:16   
Merge request closed: https://gitlab.com/openbravo/product/openbravo/-/merge_requests/1021 [^]
(0156750)
hgbot   
2023-11-06 10:42   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/merge_requests/35 [^]
(0156751)
hgbot   
2023-11-06 10:42   
Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration [^]
Changeset: 7b8a64a3207485ba3864780b24a09732abab1ca4
Author: Ander Flores <ander.flores@openbravo.com>
Date: 06-11-2023 10:41:43
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/commit/7b8a64a3207485ba3864780b24a09732abab1ca4 [^]

Fixed FR-49291: support documenting java property mappings

---
A src-test/org/openbravo/service/external/integration/StandaloneTestSuite.java
A src-test/org/openbravo/service/external/integration/mapping/documentation/PropertyDocumentationTest.java
A src/org/openbravo/service/external/integration/mapping/documentation/ArrayPropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/BooleanPropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/DatePropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/DateTimePropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/IntegerPropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/NumberPropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/ObjectPropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/PropertyDocumentation.java
A src/org/openbravo/service/external/integration/mapping/documentation/PropertyDocumentationTransformer.java
A src/org/openbravo/service/external/integration/mapping/documentation/StringPropertyDocumentation.java
M src/org/openbravo/service/external/integration/mapping/JavaPropertyMappingHandler.java
---
(0156752)
hgbot   
2023-11-06 10:43   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.api [^]
Changeset: d7235c5cba073581e723e4d7bb7eb2567246d69e
Author: Ander Flores <ander.flores@openbravo.com>
Date: 06-11-2023 09:43:26
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/commit/d7235c5cba073581e723e4d7bb7eb2567246d69e [^]

related to FR-49291: support documenting API java property mappings

---
A src-test/org/openbravo/api/openapi/ApiPropertyDocumentationTransformerTest.java
A src/org/openbravo/api/openapi/ApiPropertyDocumentationTransformer.java
M src-test/org/openbravo/api/StandaloneTestSuite.java
M src/org/openbravo/api/mappings/inventory/ImportInventoryJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/shipmentinout/ShipmentInOutJavaPropertyMappingHandler.java
M src/org/openbravo/api/openapi/OpenApiEntityMapping.java
---
(0156753)
hgbot   
2023-11-06 10:43   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/198 [^]
(0158721)
hgbot   
2023-12-29 11:24   
Repository: https://gitlab.com/openbravo/customers/saboraespana/snapshots [^]
Changeset: f98474406b506ec64bc49a092df94c9c882bc380
Author: Kepa Choperena <kepa.choperena@openbravo.com>
Date: 29-12-2023 11:24:05
URL: https://gitlab.com/openbravo/customers/saboraespana/snapshots/-/commit/f98474406b506ec64bc49a092df94c9c882bc380 [^]

Updated Snapshot_Dev. Included ISSUE-53736 & ISSUE-49291.

https://issues.openbravo.com/view.php?id=53736. [^]
https://issues.openbravo.com/view.php?id=53564 [^]

---
M Snapshot_Dev
---
(0158791)
hgbot   
2024-01-03 12:17   
Repository: https://gitlab.com/openbravo/customers/saboraespana/snapshots [^]
Changeset: 763ec4269bb04deb00d973d20904e253a2c554d3
Author: Kepa Choperena <kepa.choperena@openbravo.com>
Date: 03-01-2024 12:17:35
URL: https://gitlab.com/openbravo/customers/saboraespana/snapshots/-/commit/763ec4269bb04deb00d973d20904e253a2c554d3 [^]

Revert "Updated Snapshot_Dev. Included ISSUE-53736 & ISSUE-49291."

This reverts commit f98474406b506ec64bc49a092df94c9c882bc380.

---
M Snapshot_Dev
---