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

Openbravo Issue Tracking System - Retail Modules

View Issue Details

Project

Category

View Status

Date Submitted

Last Update

0056659

Retail Modules

Retail API

public

2024-10-04 17:37

2024-11-15 08:05

Reporter

kchoperena

Assigned To

fofarril

Priority

urgent

Severity

minor

Reproducibility

always

Status

closed

Resolution

fixed

Platform

OS Version

Product Version

Target Version

Fixed in Version

Merge Request Status

Review Assigned To

OBNetwork customer

Support ticket

Regression level

Regression date

Regression introduced in release

Regression introduced by commit

Triggers an Emergency Pack

Summary

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

Description

There 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 Reproduce

Check on the swagger any mentioned field definition

Proposed Solution

Make 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));
  }

Additional Information

Tags

No tags attached.

Relationships

related to

defect

0056478

closed

Rajesh_18

API PRODUCT - assortment

Attached Files