cloudfoundry / cloudfoundry/cloud_controller_ng

Replace V3 docs with OpenAPI docs

Open
#5,093 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
207
Forks
373
Avg merge
2d 12h
Merged PRs (30d)
56

Description

We have an experimental OpenAPI spec/documenation here: https://cloudfoundry.github.io/cf-openapi/#description/more-resources

I'd be nice to replace our existing V3 documentation with these docs.

It'd be nice to somehow validate the accuracy of the OpenAPI docs, as well as merge in the docs to the core CCNG codebase so that new features do not need to be spread apart separate codebases.

There are also missing pieces of the current documentation that are not in the OpenAPI docs (like Valid Role Types)

Things to do before replacing the current docs

non-exhaustive list:

  • Host openapidocs at something like openapi-docs.cloudfoundry.org
  • Validate correctness of spec in some way.
  • Add missing areas:
  • Move OpenAPI docs to CCNG codebase

We might need to go section-by-section to compare what else is missing from the OpenAPI docs

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the experimental OpenAPI documentation at cloudfoundry.github.io/cf-openapi with the existing V3 documentation at v3-apidocs.cloudfoundry.org. Review the listed gaps, including Valid Role Types, Concepts, and the Upgrade Guide, and determine how correctness, hosting, and moving the docs into the CCNG codebase would be handled. Done means the replacement scope and validation approach are agreed and the missing documentation is covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, ruby
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.