Skip to content

Add RAML support for People and Beers proxy APIs #81

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)

Tasks:

  • Add api/platformapps.raml and api/beers.raml describing the request/response for the above endpoints.
  • Add a lint+validation job to CI (.github/workflows/nodejs.yml or a new job/file) with raml-cop or amf-cli.
  • Document how to generate HTML docs using raml2html, place in docs/api/ if no such folder, else create it.
  • Mention new RAML specs/docs in root README.md.

Reference: src/actions/beerActions.js

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