Fitness Function Kata

Fitness Function Kata

Doc Sync With API

PenultimateWidgets publishes an API for external vendors to check on order status, availability, and other B2B perqs. However, the external partners rely on the documentation of the API, which sometimes becomes outdated when developers add new functionality. The PenultimateWidgets architects want to ensure that documentation is always up to date, especially method signatures and data formats.

  • Categories: atomic, triggered
  • Requirements:
    • Documentation must match current code.
  • Additional Context:
    • Documentation is generated from code, so method signatures should be up to date. However, developers must make sure that descriptions for each method parameter has proper documentation.
    • Ensure that the version posted on the public website matches the current released version.