[FOLIO-3055] Investigate how common aspects of OpenAPI can be shared across projects Created: 04/Mar/21 Updated: 31/Jan/24 Resolved: 31/Jan/24 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Story | Priority: | P3 |
| Reporter: | Dima Tkachenko | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | back-end, epam-spitfire, oas, spike | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Sprint: | |
| Development Team: | Spitfire |
| Description |
|
Adopting OpenAPI as a standard to define REST API of backend modules rises a question of how common parts of API (like schemas, traits, parameters etc) can be shared across different modules in Folio. In case of RAML there is a dedicated git repository to hold common parts: https://github.com/folio-org/raml There is a need to have something similar for OpenAPI The goal of investigation is to analyze whether it's possible to share common assets for OpenAPI or not. If it's possible, provide some suggestions/patterns of how to do it. If not - describe the issues. All outcomes of the investigation should be document in the decision log.
|
| Comments |
| Comment by Jakub Skoczen [ 10/Mar/21 ] |
|
Dima Tkachenko Thanks for creating this – could you also create a Decision Log entry and link the ticket there? Thanks! |