Skip to content

Change Endpoints to Standard REST Conventions

As a user, I need the endpoints to use proper REST conventions so that can build an application on top of this following standard practices.

Acceptance Criteria:

  • GIVEN a GET request to /api/v1/broadcaster/status

    • WHEN the call is made
      • THEN the request is changed to /api/v1/broadcaster
      • AND the HTTP verb is GET
      • AND the contract and all other functionality remain the same

  • GIVEN a POST request to /api/v1/broadcaster/start

    • WHEN the call is made
      • THEN the request is changed to /api/v1/broadcaster
      • AND the HTTP verb is POST
      • AND the contract and all other functionality remain the same

  • GIVEN a DEL request to /api/v1/broadcaster/stop

    • WHEN the call is made
      • THEN the request is changed to /api/v1/broadcaster
      • AND the HTTP verb is DELETE
      • AND the contract and all other functionality remain the same

Developer Notes: Don't forget to update the README and Postman documentation.