Add swagger doc

[abdulbasitkay]

My attempt at #59, hope this works

[andrewmarklloyd]

Looking good so far @abdulbasitkay! I started a review and I have a few notes here:

• We've disabled authentication for now, but I think it is a good idea to keep the documentation so nice work.
• I don't think we need the server/docs/parameters.yaml file since none of the endpoints support it. I assume this was a copy over from the other API project?
• I would add docs for the server/routes/event.route.js as well. That route doesn't have quite the same validation yet but after issue 57 it should

[abdulbasitkay]

Thanks for the feedback @andrewmarklloyd,
I didn't get your last point. I've already added some docs to server/routes/event.route.js or were you referring to server/routes/error.route.js that's mentioned in issue #57?

[andrewmarklloyd]

Sorry about that, you're right I meant error.route.js

[andrewmarklloyd]

Let's merge this in and we can add a new issue to add docs for error.route.js

[andrewmarklloyd]

The eventData maps to a specific eventType's required keys. For example the playEpisode eventType eventData has 3 fields: episodeName, minutesPlayed, and minutesRemaining. I would add an example, like:

example: {
    episodeName: "Ethereum Governance with Hudson Jameson",
    minutesPlayed: 1622.53,
    minutesRemaining: 117.62
}

[andrewmarklloyd]

Created a new issue #73