Openbravo Issue Tracking System - Modules
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0049360ModulesOpenbravo Business APIpublic2022-05-19 16:192023-11-07 11:49
Reportercaristu 
Assigned Tovmromanos 
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
Summary0049360: Fill description fields in the Entity Mapping window for the standard Openbravo Business API entities
DescriptionAfter fixing issue 0049110 now it is possible to add descriptions for both the entity mappings and the property mappings. This information also appears automatically in the swagger documentation. It would be nice to fill these fields for the standard mappings.
Steps To Reproduce.
Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
related to feature request 0049110 closed caristu Add description fields in the Entity Mapping window 
depends on defect 0052565 closed vmromanos API documentation fields 
related to defect 0053906 closed vmromanos Add documentation for Java Property Mapping Handlers - OMNI 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2022-05-19 16:19caristuNew Issue
2022-05-19 16:19caristuAssigned To => Triage Omni OMS
2022-05-19 16:19caristuIssue generated from0049110
2022-05-19 16:19caristuRelationship addedrelated to 0049110
2022-05-19 16:19caristuSummaryAdd description fields in the Entity Mapping window => Fill description fields in the Entity Mapping window for the standard Openbravo Business API entities
2022-05-19 16:27caristuDescription Updatedbug_revision_view_page.php?rev_id=24122#r24122
2023-04-13 10:49victor_perezAssigned ToTriage Omni OMS => victor_perez
2023-04-13 16:23hgbotNote Added: 0148442
2023-10-26 11:47hgbotNote Added: 0156319
2023-10-26 11:47vmromanosStatusnew => scheduled
2023-10-26 11:47vmromanosAssigned Tovictor_perez => vmromanos
2023-10-26 11:50vmromanosRelationship addeddepends on 0052565
2023-10-26 12:03hgbotNote Added: 0156320
2023-11-07 11:49hgbotNote Added: 0156826
2023-11-07 11:49hgbotResolutionopen => fixed
2023-11-07 11:49hgbotStatusscheduled => closed
2023-11-07 11:49hgbotNote Added: 0156827
2023-11-09 19:05vmromanosRelationship addedrelated to 0053906

Notes
(0148442)
hgbot   
2023-04-13 16:23   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/138 [^]
(0156319)
hgbot   
2023-10-26 11:47   
Merge request closed: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/138 [^]
(0156320)
hgbot   
2023-10-26 12:03   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/201 [^]
(0156826)
hgbot   
2023-11-07 11:49   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/201 [^]
(0156827)
hgbot   
2023-11-07 11:49   
Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.api [^]
Changeset: 692d45ac55e34230bd0f2a0b4bae309dd665a752
Author: Víctor Martínez Romanos <victor.martinez@openbravo.com>
Date: 07-11-2023 11:45:20
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/commit/692d45ac55e34230bd0f2a0b4bae309dd665a752 [^]

Fixed ISSUE-49360: Improved Openbravo API documentation (OMNI)

Added documentation for the following entities:

- Inventory
- Stock
- Stock Transaction
- Attribute Set Instance
- Goods Movements
- Storage Bin
- Organization
- Return Reasons
- Product
- Product Category
- Product Translation
- Product Substitute
- Alternative UOM
- Promotions (including missing Postman example)
- ShipmentInOut (improved existing doc)
- Characteristics

Besides it adds the following minor improvements / bug fixes discovered while documenting the API:

- Added missing purchase property in ProductAUM (import and export)
- Product.attributeSet (import): The attributeSet property when importing a product didn't work properly. It was defined as DirectPropertyMapping to the attributeSet OB property path. When trying to import a product with attributeSet it failed because it couldn't cast the string to an attributeSet object. The fix uses the attributeSet's name as the OB property path.
- ShipmentInOut line's alternativeUOM: The property alternativeUOM is necessary to properly understand the existing operativeQuantity property (which is expressed in the alternativeUOM).
- Removed 8080 port from the Postman base_url

---
M examples/Openbravo API.postman_collection.json
M src-db/database/sourcedata/API_EXPORT_FILTER.xml
M src-db/database/sourcedata/API_EXPORT_FILTER_PARAM.xml
M src-db/database/sourcedata/OBEI_ENTITY_MAPPING.xml
M src-db/database/sourcedata/OBEI_PROP_MAP_INSTANCE.xml
---