Openbravo Issue Tracking System - Retail Modules
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0057471Retail ModulesRetail APIpublic2024-12-17 10:582024-12-17 11:36
Reporteradrianromero 
Assigned Toeugen_hamuraru 
PrioritynormalSeveritymajorReproducibilityhave not tried
StatusresolvedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionFixed 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 PackNo
Summary0057471: Swagger documentation for the Client API
DescriptionClient API documentation using Open API documentation (Swagger):

Openbravo Services Client API - Common Architecture
Openbravo Services Client API - Payments
Openbravo Services Client API - Product Activation
Openbravo Services Client API - External Orders (NORMAL & REST)
Steps To ReproduceN/A
Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2024-12-17 10:58adrianromeroNew Issue
2024-12-17 10:58adrianromeroAssigned To => eugen_hamuraru
2024-12-17 10:58adrianromeroTriggers an Emergency Pack => No
2024-12-17 11:32hgbotResolutionopen => fixed
2024-12-17 11:32hgbotStatusnew => resolved
2024-12-17 11:32hgbotNote Added: 0173374
2024-12-17 11:33hgbotNote Added: 0173377
2024-12-17 11:34hgbotNote Added: 0173379
2024-12-17 11:34hgbotNote Added: 0173380
2024-12-17 11:36hgbotNote Added: 0173383
2024-12-17 11:36hgbotNote Added: 0173384

Notes
(0173374)
hgbot   
2024-12-17 11:32   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.orders [^]
Changeset: a4922159a36488408d117106bb83decb48e0bb20
Author: Eugen Hamuraru <eugen.hamuraru@openbravo.com>
Date: 17-12-2024 10:32:19
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.orders/-/commit/a4922159a36488408d117106bb83decb48e0bb20 [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
A api/org.openbravo.events.orders-Client API - External orders.yml
A api/org.openbravo.events.orders-Client API REST - External orders.yml
A api/sections/loadOrderResponse-example.yml
A api/sections/loadOrderResponse-schema.yml
A api/sections/loginResponse-schema.yml
A api/sections/searchOrderResponse-example.yml
A api/sections/searchOrderResponse-schema.yml
---
(0173377)
hgbot   
2024-12-17 11:33   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.productactivation [^]
Changeset: 13809f47632abb58b95faa598f0f53d44d7bd8fa
Author: Eugen Hamuraru <eugen.hamuraru@openbravo.com>
Date: 17-12-2024 10:33:22
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.productactivation/-/commit/13809f47632abb58b95faa598f0f53d44d7bd8fa [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
A api/org.openbravo.events.productactivation-Client API - Product activation.yml
A web/org.openbravo.events.productactivation/api-doc/img/canceled-add-product.png
A web/org.openbravo.events.productactivation/api-doc/img/confirm-receipt-canceled-response.png
A web/org.openbravo.events.productactivation/api-doc/img/confirm-receipt-error-response.png
A web/org.openbravo.events.productactivation/api-doc/img/confirm-receipt-success-response.png
A web/org.openbravo.events.productactivation/api-doc/img/failure-add-product.png
A web/org.openbravo.events.productactivation/api-doc/img/product-status-response-1.png
A web/org.openbravo.events.productactivation/api-doc/img/product-status-response-2.png
A web/org.openbravo.events.productactivation/api-doc/img/success-add-product.png
---
(0173379)
hgbot   
2024-12-17 11:34   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.client [^]
Changeset: 271f2e10513d25487de8e80b0da4db38a65aa5d9
Author: Asier Lostalé <a.lostale@orisha.com>
Date: 17-12-2024 10:34:32
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.client/-/commit/271f2e10513d25487de8e80b0da4db38a65aa5d9 [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
A api/org.openbravo.events.client-Client API - Common Messages.yml
A api/sections/commonClientAPIProperties-example.yml
A api/sections/commonClientAPIProperties-schema.yml
A api/sections/commonClientAPIResponse-schema.yml
A web/org.openbravo.events.client/api-doc/img/approval-example.png
A web/org.openbravo.events.client/api-doc/img/bidirectional-transaction.png
A web/org.openbravo.events.client/api-doc/img/common-messages.svg
A web/org.openbravo.events.client/api-doc/img/display-actions-example.png
A web/org.openbravo.events.client/api-doc/img/display-text-example.png
A web/org.openbravo.events.client/api-doc/img/key-example.png
A web/org.openbravo.events.client/api-doc/img/menu-example.png
A web/org.openbravo.events.client/api-doc/img/page-example.png
A web/org.openbravo.events.client/api-doc/img/receipt-example.png
A web/org.openbravo.events.client/api-doc/img/safepay-example.png
A web/org.openbravo.events.client/api-doc/img/string-date-input-example.png
A web/org.openbravo.events.client/api-doc/img/string-input-boxes-example.png
A web/org.openbravo.events.client/api-doc/img/string-options-example.png
A web/org.openbravo.events.client/api-doc/img/string-row-cols-example.png
A web/org.openbravo.events.client/api-doc/img/string-row-cols-spans-example.png
A web/org.openbravo.events.client/api-doc/img/string-text-bool-example.png
---
(0173380)
hgbot   
2024-12-17 11:34   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.payment [^]
Changeset: 59e681178564b9270cea44b337971d44eb45c183
Author: Asier Lostalé <a.lostale@orisha.com>
Date: 17-12-2024 10:34:48
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.events.payment/-/commit/59e681178564b9270cea44b337971d44eb45c183 [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
A api/org.openbravo.events.payment-Client API - Payments.yml
A web/org.openbravo.events.payment/api-doc/img/digital-coupon-ui.png
A web/org.openbravo.events.payment/api-doc/img/payment-login-example.png
---
(0173383)
hgbot   
2024-12-17 11:36   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.api [^]
Changeset: 3933cb2f22fec065238d4f0a0c2ba8d15217e403
Author: Asier Lostalé <a.lostale@orisha.com>
Date: 17-12-2024 10:36:25
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/commit/3933cb2f22fec065238d4f0a0c2ba8d15217e403 [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
M api/org.openbravo.api-Reprintable Report.yml
M api/org.openbravo.api-Status Service.yml
M src/org/openbravo/api/openapi/CategoryOpenAPIGenerator.java
---
(0173384)
hgbot   
2024-12-17 11:36   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi [^]
Changeset: fbbe066aecd35d636983c9830417aa6245ba2841
Author: Asier Lostalé <a.lostale@orisha.com>
Date: 17-12-2024 10:36:49
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi/-/commit/fbbe066aecd35d636983c9830417aa6245ba2841 [^]

Fixes ISSUE-57471: Swagger documentation for the Client API

---
A src/org/openbravo/service/openapi/provider/PushAPIProcessor.java
A src/org/openbravo/service/openapi/template/APITemplateSection.java
A src/org/openbravo/service/openapi/template/BackendAPIParams.java
A src/org/openbravo/service/openapi/template/ClientAPIParams.java
A src/org/openbravo/service/openapi/template/CommonAPIParams.java
M src/org/openbravo/service/openapi/provider/OpenAPIProcessor.java
M src/org/openbravo/service/openapi/provider/StaticOpenAPIProcessor.java
M web/org.openbravo.service.openapi/dist/swagger-ui-bundle.js
M web/org.openbravo.service.openapi/dist/swagger-ui-bundle.js.map
M web/org.openbravo.service.openapi/dist/swagger-ui-standalone-preset.js
M web/org.openbravo.service.openapi/dist/swagger-ui-standalone-preset.js.map
M web/org.openbravo.service.openapi/dist/swagger-ui.css
M web/org.openbravo.service.openapi/dist/swagger-ui.css.map
M web/org.openbravo.service.openapi/dist/swagger-ui.js
M web/org.openbravo.service.openapi/dist/swagger-ui.js.map
---