Openbravo Issue Tracking System - Retail Modules
View Issue Details
IDProjectCategoryView StatusDate SubmittedLast Update
0056613Retail ModulesWeb POSpublic2024-10-02 09:342024-10-21 12:09
Reporteradrianromero 
Assigned Toadrianromero 
PrioritynormalSeveritymajorReproducibilityhave not tried
StatusclosedResolutionfixed 
PlatformOS5OS Version
Product Version 
Target VersionFixed in Version 
Merge Request Statusapproved
Review Assigned To
OBNetwork customerOBPS
Support ticket
Regression level
Regression date
Regression introduced in release
Regression introduced by commit
Triggers an Emergency PackNo
Summary0056613: Swagger spec definition fixes in org.openbravo.api
DescriptionThere are several Swagger (OpenAPI) spec fixes that needs to be reviewed:

* Authentication schemes in manual files org.openbravo.api-Reprintable Report.yml and org.openbravo.api-Status Service.yml. Properly define the spec of the two different authentication schemes: Basic authentication and Bearer (oauth2) authentication

* Authentication schemes in generated files. Review the authentication schemes description for oauth2. What to define? oauth2 or bearerToken

* Fix warnings for unreferenced entities "ProductAUM (Import)" and "TaxRate (Import)"

* Define and document tool to validate swagger 3.1.0 version files
for example: https://github.com/Redocly/redocly-cli [^] or https://github.com/stoplightio/spectral [^]

In case of redocly:
-> % npm install @redocly/openapi-cli
-> % node_modules/@redocly/openapi-cli/bin/cli.js lint --max-problems 10000 ~/business-api-master-data.json

* Define strategy for fixing swagger validation issues in other API modules owned by other teams

Steps To ReproduceRun swagger validation 3.1.0 version for generated and manual spec files
Proposed Solution
Additional Information
TagsNo tags attached.
Relationships
related to defect 0056844 closed ander_flores More Swagger spec definition fixes in org.openbravo.api 
Attached Files
Issue History
Date ModifiedUsernameFieldChange
2024-10-02 09:34adrianromeroNew Issue
2024-10-02 09:34adrianromeroAssigned To => Triage Platform Conn
2024-10-02 09:34adrianromeroOBNetwork customer => OBPS
2024-10-02 09:34adrianromeroTriggers an Emergency Pack => No
2024-10-02 11:54adrianromeroStatusnew => acknowledged
2024-10-02 12:00martinsdanIssue Monitored: martinsdan
2024-10-10 09:17adrianromeroDescription Updatedbug_revision_view_page.php?rev_id=28569#r28569
2024-10-10 09:30adrianromeroDescription Updatedbug_revision_view_page.php?rev_id=28570#r28570
2024-10-10 09:33adrianromeroDescription Updatedbug_revision_view_page.php?rev_id=28571#r28571
2024-10-14 12:44adrianromeroStatusacknowledged => scheduled
2024-10-14 12:44adrianromeroAssigned ToTriage Platform Conn => adrianromero
2024-10-14 16:51hgbotMerge Request Status => open
2024-10-14 16:51hgbotNote Added: 0170376
2024-10-14 16:55hgbotNote Added: 0170378
2024-10-21 09:52hgbotMerge Request Statusopen => approved
2024-10-21 09:53hgbotResolutionopen => fixed
2024-10-21 09:53hgbotStatusscheduled => closed
2024-10-21 09:53hgbotNote Added: 0170654
2024-10-21 09:53hgbotNote Added: 0170655
2024-10-21 09:53hgbotNote Added: 0170656
2024-10-21 09:53hgbotNote Added: 0170657
2024-10-21 12:09adrianromeroIssue cloned0056844
2024-10-21 12:09adrianromeroRelationship addedrelated to 0056844

Notes
(0170376)
hgbot   
2024-10-14 16:51   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi/-/merge_requests/17 [^]
(0170378)
hgbot   
2024-10-14 16:55   
Merge Request created: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/346 [^]
(0170654)
hgbot   
2024-10-21 09:53   
Directly closing issue as related merge request is already approved.

Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.api [^]
Changeset: b92b655c2b27453ccf32b76fd6ee1ce8a53f0bfe
Author: Adrián Romero Corchado <5269822-adrian.romero@users.noreply.gitlab.com>
Date: 21-10-2024 07:53:02
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/commit/b92b655c2b27453ccf32b76fd6ee1ce8a53f0bfe [^]

Fixes ISSUE-56613: Swagger spec definition fixes in org.openbravo.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
M src/org/openbravo/api/openapi/OpenApiEntityMapping.java
M src/org/openbravo/api/openapi/OpenApiEvent.java
---
(0170655)
hgbot   
2024-10-21 09:53   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.api/-/merge_requests/346 [^]
(0170656)
hgbot   
2024-10-21 09:53   
Repository: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi [^]
Changeset: fd0ac9a9b424be0fb750158412cce8cbce804aab
Author: Adrián Romero Corchado <5269822-adrian.romero@users.noreply.gitlab.com>
Date: 21-10-2024 07:53:35
URL: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi/-/commit/fd0ac9a9b424be0fb750158412cce8cbce804aab [^]

related to ISSUE-56613: Swagger spec definition fixes in org.openbravo.api

  Improves generation of the authentication schemas section with a new template parameter

---
M src/org/openbravo/service/openapi/provider/OpenAPIProcessor.java
---
(0170657)
hgbot   
2024-10-21 09:53   
Merge request merged: https://gitlab.com/openbravo/product/pmods/org.openbravo.service.openapi/-/merge_requests/17 [^]