Skip to content

Add RAML support for People and Beers proxy APIs #82

Description

@HolimaX

Add RAML 1.0 specs for recognizable API endpoints used in src/actions/beerActions.js:

  • /api/people (proxy)
  • /api/people/{page} (pagination)
  • /api/people/{keyword} (search)
  • /api/people/{voteid} (details)
  • /v2/beers (public API, example)
  • /v2/beers?beer_name={keyword} (search)able REST API endpoints for cluster registration/provisioning and health check (from integration/Java/README.md and app code).
  • Place spec(s) in api/ as provisioning.raml and health.raml.
  • Add GitHub Actions workflow for validating RAML files (raml-cop or amf-cli).
  • Use raml2html to generate HTML docs in docs/api/.
  • Mention in root README where RAML and docs can be found.

Reference: integration/Java/README.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions