0056550: Missing description in the fields of the ExternalOrderLoader documentation in the swagger

Description

The External Order Loader is an integration that a lot of clients are using or they will as it is quite common to have an integration with an E-commerce system

Have the API properly documented is key to avoid spend time explaining the same details to each client

We should at least include the Description: Explaining what's the purpose of the field and in case the field can receive different values, explaining each of them (i.e.: Product Import > productType)

Relevant fields to improve:
HEADER
- messageId
- posTerminal
- channel
- step
- completeTicket
- grossAmount
- netAmount
- businessPartner
- externalBusinessPartnerReference
- deliveryReceiptOption
- deliveryReceiptDestination

LINES
- grossAmount
- grossListPrice
- baseGrossUnitPrice
- netAmount
- taxAmount
- deliveryMode

  TAX
  - netAmount
  - taxAmount
  - grossAMount
  - amount
  - net
  PROMOTIONS
  - discountRule
  - amount
  - baseUnitPrice
  - discountType
  - displayedTotalAmount
  - obdiscQtyoffer
  - quantity
  - unitDiscount

PAYMENTS
- kind
- rate
- isocode

TAXES
- netAmount
- taxAmount
- grossAMount
- amount
- net

APPROVALS
- approvalType
- userContact

Steps To Reproduce

Open the Swagger documentation in livebuilds for the External Order Loader:

https://livebuilds.openbravo.com/context/retail_modules_pgsql_pi/api?urls.primaryName=orderloader [^]

Tags

No tags attached.

Attached Files

Screenshot from 2024-09-24 12-40-17.png [^] (164,407 bytes) 2024-09-25 15:35

Relationships [ Relation Graph ] [ Dependency Graph ]

Notes
(0170190) hgbot (developer) 2024-10-09 13:27	Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/merge_requests/1705 [^]

(0170942) hgbot (developer) 2024-10-25 09:54	Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/merge_requests/1705 [^]

(0170943) hgbot (developer) 2024-10-25 09:54	Directly closing issue as related merge request is already approved. Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal [^] Changeset: 1f493149f8ae7d3f050cde8f74500f1ffaac0a8c Author: Rajesh Senthilkumar <rajesh@qualiantech.com> Date: 25-10-2024 07:54:06 URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.retail.posterminal/-/commit/1f493149f8ae7d3f050cde8f74500f1ffaac0a8c [^] Fixed ISSUE-56550: Added description to properties present in external orderloader --- M api/org.openbravo.retail.posterminal-orderloader.yml ---

Issue History
Date Modified	Username	Field	Change
2024-09-25 15:35	kchoperena	New Issue
2024-09-25 15:35	kchoperena	Assigned To	=> Triage Platform Conn
2024-09-25 15:35	kchoperena	File Added: Screenshot from 2024-09-24 12-40-17.png
2024-09-25 15:35	kchoperena	Triggers an Emergency Pack	=> No
2024-09-30 15:58	adrianromero	Assigned To	Triage Platform Conn => Retail
2024-10-02 19:08	kchoperena	Description Updated	View Revisions
2024-10-03 07:02	guillermogil	Status	new => acknowledged
2024-10-05 07:06	Rajesh_18	Assigned To	Retail => Rajesh_18
2024-10-05 07:06	Rajesh_18	Status	acknowledged => scheduled
2024-10-09 13:27	hgbot	Note Added: 0170190
2024-10-25 09:54	hgbot	Resolution	open => fixed
2024-10-25 09:54	hgbot	Status	scheduled => closed
2024-10-25 09:54	hgbot	Note Added: 0170942
2024-10-25 09:54	hgbot	Fixed in Version	=> RR25Q1
2024-10-25 09:54	hgbot	Note Added: 0170943