cloudfoundry / cloudfoundry/community
[RFC0044] Documenting the CF API with OpenAPI
Open
Nobody has claimed this yet.
rfc
- Dominant language
- Python
- Stars
- 57
- Forks
- 250
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 11
Description
This is a tracking issue for RFC0044.
Delivered with:
- CF-Deployment version:
- CLI version:
- CF Docs:
- CF API v3 openapi doc: https://v3-apidocs.cloudfoundry.org/openapi (experimental)
Tasks
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 with RFC0044 and review the remaining unchecked tasks, especially cloud_controller_ng issue 5093 and community PR 1607, alongside the experimental CF API v3 OpenAPI document. Done means completing the remaining tracking items and updating the checklist with the relevant CF-Deployment, CLI, CF Docs, and API documentation versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100