nextcloud / nextcloud/documentation
Use openapi-extractor from server to build OpenAPI docs
Open
Nobody has claimed this yet.
1. to develop
manual: developer
technical debt
- Dominant language
- JavaScript
- Stars
- 628
- Forks
- 2.5k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 135
Description
It should instead use the one that is in the composer.lock of server to always have the correct one.
Originally posted by @provokateurin in https://github.com/nextcloud/documentation/issues/11314#issuecomment-1827812899
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
Locate the documentation build step that currently selects openapi-extractor and compare it with the server's composer.lock. Verify that generated OpenAPI documentation uses the server-pinned version and that the documentation build still completes successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, build-system, documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100