owncloud / owncloud/libre-graph-api
Swagger yaml is large and hard to manage manually
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 4
- Forks
- 3
- Avg merge
- 23h 14m
- Merged PRs (30d)
- 1
Description
The current swagger yaml file grows every day and its hard to work with.
The following pain points exist:
- too large (editor gets laggy)
- everything is in one file (splitting failed the last time we tried)
- failures can be overlooked because it contains a lot of duplications
the issue is just a placeholder and could grow overtime, we need to find a way how we could fix the above issues.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the current Swagger YAML file and reviewing how the API specification is generated or validated. Investigate the previous failed attempt to split the specification, then define a maintainable approach that addresses file size, duplication, editor performance, and validation failures. Done means the specification is easier to manage without overlooking errors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, yaml
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100