nextcloud / nextcloud/openapi-extractor
Consider moving to OpenAPI 3.1.x
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 11
- Forks
- 4
- Avg merge
- 10h 18m
- Merged PRs (30d)
- 8
Description
In the latest version we can make use of the const keyword for single value enums and it should also be possible to solve https://github.com/nextcloud/openapi-extractor/blob/63bbc5403c8f745ac555a53eea2309b42aa24ff8/src/OpenApiType.php#L77.
https://www.npmjs.com/package/openapi-typescript already has 3.1 support, so it should be fine for all uses in the Nextcloud frontend itself.
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 reading src/OpenApiType.php around line 77 and compare the current OpenAPI version with the 3.1 support noted for openapi-typescript. Trace the extractor's generated specifications and frontend uses, then verify that moving to OpenAPI 3.1.x resolves the single-value enum and referenced type issue without breaking those uses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, php
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100