cloudfoundry / cloudfoundry/cloud_controller_ng
V3 Capi documentation does not list return structure
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 207
- Forks
- 373
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 56
Description
Issue
V3 Capi documentation does not list return structure. It only lists query parameters and permitted roles. It does not say what to expect from the API (aka service contract).
Context
Old V2 Capi documentation (e.g. https://apidocs.cloudfoundry.org/15.3.0/services/list_all_services.html) lists actual response body, and expected members. That helps to design a consuming class (a dotnet class in my case). But V3 documentation (e.g. http://v3-apidocs.cloudfoundry.org/version/release-candidate/#list-droplets-for-an-app) just shows who can consume the API in terms of permitted roles and query parameters. This is equivalent to consumer side of service contract.
Without the provider side of service contract its hard to program the consumer. Can Pivotal/CloudFoundry add return data structure details?
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 the linked V3 API documentation examples, such as “List droplets for an app,” and compare them with the older V2 service documentation linked in the issue. Document each relevant endpoint’s response body and expected members so consumers can understand the service contract.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100