benjaminlukeclark / monsternames-api Goto Github PK

Is your feature request related to a problem? Please describe.
At the moment there's no data sanitisation on the API backend. New records are create via:

peewee.mode.create()

And looking at the (docs)[http://docs.peewee-orm.com/en/latest/peewee/api.html#Model.create] I'm not sure this does automatic sanitisation.

Doing this on the backend will ensure that this cannot be bypassed in the provided frontend, and will ensure sanitisation if the API is interacted with programatically.

Describe the solution you'd like
A single new method on the endpoint class that sanitises a string for input into the database.

Describe alternatives you've considered
Coding this in the provided frontend. However, this would not cover all possible use cases.

Additional context
This is currently not a major issue as only 2 individuals have API keys to input to the database, with one of them being myself.

Is your feature request related to a problem? Please describe.
NA

Describe the solution you'd like
Amend the "Home" page to have a dynamically generated table instead of just displaying the raw json. Table should be similar to the below:

On each click a record is added to the table. Ensure that there's a new "Clear table" button to stop this getting too cluttered.

If an error is encountered then all the headers should be changed and coloured red. On a click after an error then this should change back to normal if the query was successful.

Also amend the Add Names page to have similar functionality, where results are displayed in an easy to read table rather than the current jaw JSON. Potentially have this amend to the table as well, and a new clear results button.

Describe alternatives you've considered
NA

Additional context
NA

Is your feature request related to a problem? Please describe.
NA

Describe the solution you'd like
A new endpoint within the API that provides the following functionality:

• A list of all monster types that are available
• A list of all GET endpoints
• A list of all POST endpoints

Describe alternatives you've considered
NA

Additional context
Clear documentation is already on the website. However, having this in programmatic form would prove useful for individuals attempting to build upon this API.

Is your feature request related to a problem? Please describe.
NA

Describe the solution you'd like
Add a rudimentary stats gathering to the API to gather:

• Times that each endpoint has been queried in a day

Add items to the frontend:

• Leaderboard of contributions to the API
• Overview of endpoint usage, maybe with ability to filter by day/month/year etc
• Place all of this on a separate stats page
• Maybe try to emulate or use Grafana (https://github.com/grafana/grafana) for the visualisation aspect
• MAYBE use IP to filter this down to country, so X visits to Y endpoint from Z countries with A cumulative

Describe alternatives you've considered
Publishing stats separately as a Grafana dashboard, but that defeats the object of having everything on one web page.

Additional context
Contributions data may already be gathered via simple MySQL commands. This will require more tables in the database to pull off, so deployment will need another SQL configure run.

Is your feature request related to a problem? Please describe.
Conventions for new names are stated clearly in the first release but no-where else. This needs to be on the website in relevent sections (contribution guide and add names) to ensure consistency if more contributors are added.

Describe the solution you'd like
On addNames page:

• Two columns before submit button but after lastName input
• Columns to be descriptions of first and last name schemas
• Same on home page below dropdown

Describe alternatives you've considered
Placing info in the readme or linking back to the original release... but of these are not particularly user friendly. It may also be useful to add this as an extra endpoint for querying programmatically.

Additional context
This isn't so much an issue right now, where it's just myself and one other person contributing, but is certainly required to ensure this scales.

Is your feature request related to a problem? Please describe.
NA

Describe the solution you'd like
A place in the readme and website that links known Projects that utilise the API.

Describe alternatives you've considered
NA

Additional context
Known Projects already:

• https://monster.mnuh.org/