Openbravo Issue Tracking System - Retail Modules |
| View Issue Details |
|
| ID | Project | Category | View Status | Date Submitted | Last Update |
| 0048285 | Retail Modules | Retail API | public | 2021-12-20 11:54 | 2022-02-11 09:16 |
|
| Reporter | caristu | |
| Assigned To | Triage Platform Conn | |
| Priority | high | Severity | minor | Reproducibility | have not tried |
| Status | closed | Resolution | open | |
| Platform | | OS | 5 | OS Version | |
| Product Version | | |
| Target Version | | Fixed in Version | | |
| Merge Request Status | |
| Review Assigned To | caristu |
| OBNetwork customer | |
| Support ticket | |
| Regression level | |
| Regression date | |
| Regression introduced in release | |
| Regression introduced by commit | |
| Triggers an Emergency Pack | No |
|
| Summary | 0048285: Documentation of custom properties is wrongly exported |
| Description | Current Status about the Retail API (Open API/Swagger)documentation: currently it is possible to export the documentation of a Retail API entity mapping (endpoint) to the module that it belongs. This possible after fixing 0047887.
The documentation is exported in a .json file that we are currently persisting in each module repository. This is problematic specially in those cases where an entity mapping has custom property mappings defined as part of another module. In that case the .json file containing the documentation has information of other modules which is not correct. |
| Steps To Reproduce | . |
| Proposed Solution | - Do not persist the .json file in the repository. Generated code should not be persisted.
- TBD: add a dependency for the Retail API module with the Open API (Swagger) module
- Update the docs to explain the tasks that should be executed to properly deploy the doc because the .json file should be generated as it will not be longer included as part of the module |
| Additional Information | |
| Tags | No tags attached. |
| Relationships | | related to | feature request | 0047887 | | closed | caristu | Support exporting Retail API documentation to external modules | | related to | feature request | 0048366 | | closed | caristu | Split Retail API Infrastructure into a new module |
|
| Attached Files | |
|
| Issue History |
| Date Modified | Username | Field | Change |
| 2021-12-20 11:54 | caristu | New Issue | |
| 2021-12-20 11:54 | caristu | Assigned To | => Retail |
| 2021-12-20 11:54 | caristu | Triggers an Emergency Pack | => No |
| 2021-12-20 11:54 | caristu | Relationship added | related to 0047887 |
| 2022-01-11 12:31 | alostale | Assigned To | Retail => Triage Platform Conn |
| 2022-01-18 13:40 | caristu | Status | new => acknowledged |
| 2022-01-25 16:52 | caristu | Relationship added | related to 0048366 |
| 2022-02-11 09:16 | caristu | Status | acknowledged => scheduled |
| 2022-02-11 09:16 | caristu | Review Assigned To | => caristu |
| 2022-02-11 09:16 | caristu | Note Added: 0134915 | |
| 2022-02-11 09:16 | caristu | Status | scheduled => closed |