Anonymous | Login
Project:
RSS
  
News | My View | View Issues | Roadmap | Summary

View Issue Details[ Jump to Notes ] [ Issue History ] [ Print ]
ID
0052565
TypeCategorySeverityReproducibilityDate SubmittedLast Update
defect[Modules] Openbravo Business APIminoralways2023-05-25 12:342023-11-07 08:42
ReportervmromanosView Statuspublic 
Assigned Tovmromanos 
PriorityurgentResolutionfixedFixed in Version
StatusclosedFix in branchFixed in SCM revision
ProjectionnoneETAnoneTarget Version
OSAnyDatabaseAnyJava version
OS VersionDatabase versionAnt version
Product VersionSCM revision 
Regression date
Regression introduced by commit
Regression level
Review Assigned To
Regression introduced in release
Summary

0052565: API documentation fields

DescriptionWe need some changes in the Entity definition to properly document it:

- MUST HAVE: Increase the Entity's description length so it can support very long descriptions. Transform to Text reference so it's not displayed in one line.

- SHOULD HAVE: Increase the property mapping instance's description too

- NICE TO HAVE: Add a description field to the Java Property Mapping handlers and, if possible, split the different properties so each one can be documented separately
Steps To ReproduceTry to add a long description to any of the above entities. You don't have enough space.
TagsNo tags attached.
Attached Files

- Relationships [ Relation Graph ] [ Dependency Graph ]
related to feature request 0049291 closedTriage Platform Conn Modules Properties mapped with java property mappings are not documented properly 
blocks feature request 0049360 closedvmromanos Modules Fill description fields in the Entity Mapping window for the standard Openbravo Business API entities 
blocks feature request 0052115 closedvmromanos Modules Fill description fields in the Entity Mapping window for the Distribution Orders API entities 
blocks feature request 0054036 closedmarvintm Retail Modules Add documentation for Java Property Mapping Handlers - POS 

-  Notes
(0156318)
hgbot (developer)
2023-10-26 11:32

 Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/merge_requests/37 [^]
(0156808)
hgbot (developer)
2023-11-07 08:42

 Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration [^]
Changeset: 91bf4aae598f5b5aedca529a0575b855dcf78743
Author: Víctor Martínez Romanos <victor.martinez@openbravo.com>
Date: 07-11-2023 07:42:34
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/commit/91bf4aae598f5b5aedca529a0575b855dcf78743 [^]

Fixed ISSUE-52565: Increased Entity and Property Mapping desc. length to 4000

This should add enough capacity for properly documenting the API. Therefore
the CLOB usage has been discarded.

Note that 4000 is the maximum allowed size for VARCHAR2.

Text Reference is used now in both Entity Mapping and Property Mapping Instance
description fields.

---
M src-db/database/model/tables/OBEI_ENTITY_MAPPING.xml
M src-db/database/model/tables/OBEI_PROP_MAP_INSTANCE.xml
M src-db/database/sourcedata/AD_COLUMN.xml
M src-db/database/sourcedata/AD_FIELD.xml
---
(0156809)
hgbot (developer)
2023-11-07 08:42

 Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.external.integration/-/merge_requests/37 [^]

- Issue History
Date Modified Username Field Change
2023-05-25 12:34 vmromanos New Issue
2023-05-25 12:34 vmromanos Assigned To => Triage Platform Conn
2023-08-24 12:53 caristu Relationship added related to 0049291
2023-10-26 11:20 vmromanos Status new => scheduled
2023-10-26 11:20 vmromanos Assigned To Triage Platform Conn => vmromanos
2023-10-26 11:32 hgbot Note Added: 0156318
2023-10-26 11:50 vmromanos Relationship added blocks 0049360
2023-10-26 12:11 vmromanos Relationship added blocks 0052115
2023-11-07 08:42 hgbot Resolution open => fixed
2023-11-07 08:42 hgbot Status scheduled => closed
2023-11-07 08:42 hgbot Note Added: 0156808
2023-11-07 08:42 hgbot Note Added: 0156809
2023-11-27 18:21 marvintm Relationship added blocks 0054036

Copyright © 2000 - 2009 MantisBT Group
Powered by Mantis Bugtracker