OpenAPI File Splitting

[DanielWeidinger]

Story

As a Developer, I want to be able to modularize the API Spec into multiple file to allow for a better overview

Details

Due to the ever-growing main OpenAPI spec file, it would be useful to split it up into its atomic components(paths, schemas and parameters)

All reusable or modularizeable components will get their respective file, which would result in the following folder structure:

• /docs/api

  • parameters

  • paths -> containing all routes

  • All components of the route are folders except the last one, which contains the actual Speficication

    • e.g. projects/{projectId}/{codeRepoId} and projects/{projectId} would result in: projects/ ├─ {projectId}/ │ ├─ {codeRepoId}.yaml ├─ {projectId].yaml

  • schemas

Proposal

• [x] Refactor the current monolithic file into intuitive sub-files with the explained folder structure

Acceptance

• [x] The backend team is satisfied with the new conventions