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

View Issue Details[ Jump to Notes ] [ Issue History ] [ Print ]
ID
0056659
TypeCategorySeverityReproducibilityDate SubmittedLast Update
defect[Retail Modules] Retail APIminoralways2024-10-04 17:372024-11-15 08:05
ReporterkchoperenaView Statuspublic 
Assigned Tofofarril 
PriorityurgentResolutionfixedFixed in Version
StatusclosedFix in branchFixed in SCM revision
ProjectionnoneETAnoneTarget Version
OSAnyDatabaseAnyJava version
OS VersionDatabase versionAnt version
Product VersionSCM revision 
Review Assigned To
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary

0056659: Manually documented fields on the swagger that are not explicitly defining if they are nullable are appearing as mandatory

DescriptionThere are properties that needs to be documented manually on the Swagger. In this cases, if the property is not specifying if it is nullable or not, the swagger is showing them as mandatory
Here is the list of entities/fields affected:
EXPORT INVOICELINE:
    - originalInvoiceDocumentNumber
    - originalInvoiceLineId
IMPORT CONTACTINFO:
    - name
IMPORT USERROLES:
    - organization
IMPORT USER:
    - password
EXPORT SHIPMENT:
    - deliveryLocation
    - completelyInvoiced
IMPORT PRODUCT CATEGORY:
    - parentCategory
IMPORT PRICE LIST:
    - organization

IMPORT GOODS MOVEMENT:
    - client
    - date
    - name

EXPORT ORDER LINE:
    - originalSalesOrderDocumentNumber
    - originalOrderLineId
    - returnedQuantity

EXPORT SHIPMENTINOUTLINE:
    - orderLine
        - id
        - lineNo
        - orderDocumentNo
        - grossUnitPrice
        - netUnitPrice
        - currency

IMPORT PRODUCT:
    - assortments

Also there are some fields that doesn't have the nullable defined but appears as mandatory when they are:

IMPORT PRODUCT PRICE EXCEPTION
    - organization
IMPORT INVENTORY LINE:
    - bin
    - product
Steps To ReproduceCheck on the swagger any mentioned field definition
Proposed SolutionMake by default the nullable to false and include a explicit nullable set for the:
IMPORT PRODUCT PRICE EXCEPTION
    - organization
IMPORT INVENTORY LINE:
    - bin

Example:
@Override
  public List<PropertyDocumentation<?>> getPropertyDocumentation() {
    return List.of(new StringPropertyDocumentation("organization")
        .description("The organization for the imported price exception, identified by searchKey").nullable(false));
  }
TagsNo tags attached.
Attached Filespng file icon Screenshot from 2024-10-04 17-36-52.png [^] (74,464 bytes) 2024-10-04 17:37

- Relationships [ Relation Graph ] [ Dependency Graph ]
related to defect 0056478 closedRajesh_18 API PRODUCT - assortment 

-  Notes
(0171829)
hgbot (developer)
2024-11-12 17:21

 Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/381 [^]
(0172013)
hgbot (developer)
2024-11-15 08:05

 Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/381 [^]
(0172014)
hgbot (developer)
2024-11-15 08:05

 Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.api [^]
Changeset: afc18e285f64fc76139abbfcdd98c894d0750c65
Author: Francisco Javier Deler O'Farril <francisco.ofarril@doceleguas.com>
Date: 15-11-2024 07:05:28
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/commit/afc18e285f64fc76139abbfcdd98c894d0750c65 [^]

Fixes ISSUE-56659: Manually documented fields on the swagger that are not explicitly defining if they are nullable are appearing as mandatory

---
M src/org/openbravo/api/mappings/goodsmovement/ImportGoodsMvmtJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/invoiceline/ExportInvoiceLineJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/orderline/ExportOrderLineJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/pricelist/PriceListJavaPropertyMapping.java
M src/org/openbravo/api/mappings/pricelist/ProductPriceExceptionJavaPropertyMapping.java
M src/org/openbravo/api/mappings/productcategory/ImportProductCategoryJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/shipmentinout/ShipmentInOutJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/user/ImportContactInfoJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/user/ImportUserJavaPropertyMappingHandler.java
M src/org/openbravo/api/mappings/user/ImportUserRolesJavaPropertyMappingHandler.java
---

- Issue History
Date Modified Username Field Change
2024-10-04 17:37 kchoperena New Issue
2024-10-04 17:37 kchoperena Assigned To => Triage Platform Conn
2024-10-04 17:37 kchoperena File Added: Screenshot from 2024-10-04 17-36-52.png
2024-10-04 17:37 kchoperena Triggers an Emergency Pack => No
2024-10-07 10:20 kchoperena Relationship added related to 0056478
2024-10-07 10:47 adrianromero Assigned To Triage Platform Conn => Retail
2024-10-18 12:10 jorgewederago Assigned To Retail => jorgewederago
2024-10-18 13:22 jorgewederago Assigned To jorgewederago => alainperez
2024-10-18 13:22 jorgewederago Status new => acknowledged
2024-10-18 14:06 alainperez Status acknowledged => scheduled
2024-11-05 14:59 jorgewederago Assigned To alainperez => fofarril
2024-11-12 14:27 marvintm Severity major => minor
2024-11-12 17:21 hgbot Note Added: 0171829
2024-11-15 08:05 hgbot Note Added: 0172013
2024-11-15 08:05 hgbot Resolution open => fixed
2024-11-15 08:05 hgbot Status scheduled => closed
2024-11-15 08:05 hgbot Note Added: 0172014

Copyright © 2000 - 2009 MantisBT Group
Powered by Mantis Bugtracker