Public Repository

Last pushed: a year ago
Short Description
Short description is empty for this repo.
Full Description

Running the service in Docker

This API is dependent on a connection to an EventStore instance containing cricd match events. The host, port, authentication credentials and Eventstore stream name are all configured using the following environment variables: EVENTSTORE_IP, EVENTSTORE_PORT and EVENTSTORE_STREAM_NAME.

docker run -p 4567:4567 ryankscott/cricd-eventservice

Accessing the service

This service exposes a three endpoint at port 4567 by default which responds to GET requests.
These three endpoints are:

  1. /match
    The match endpoint returns any events depending on the following parameters:
    • id - the id of the match which you are interested. This is a required field
    • bowler - the id of the bowler which you are interested in
    • batsman - the id of the batsman which you are interested in

Please note that you can't pass both the bowler and batsman parameters

  1. /bowler
    The bowler endpoint returns any events depending on the following parameters:

    • id - the id of the bowler which you are interested. This is a required field
  2. /batsman
    The batsman endpoint returns any events depending on the following parameters:

    • id - the id of the batsman which you are interested. This is a required field
Docker Pull Command
Owner
ryankscott