mrjackdavis / skeleton-scene-api Goto Github PK

According to http://www.restapitutorial.com/lessons/restquicktips.html, APIs should be plural

Because we're using DynamoDB, it's impossible to sort toast. FUUU. So we need to peal away from DynamoDB for the storage of completed toast. I'm thinking MySQL is a solid choice, since it's got a ton of support, and we could use Amazon Aurora in the future.

Moving to MySQL will also help with #16

Generators should be able to register themselves with skeleton-scene.

The interaction could probably use the OAuth 2.0 Client Credentials strategy. So each generator will have it's own key and secret which can be used to authenticate each request.

Implementing OAuth 2.0 would require HTTPS though...

slap /v0-1/ or something on the front of the api url

Skeleton scene might have unexpected behaviour when there are over 100 requests. Since the fractal /scenes/ returns 100 scenes, some might be missed. Especially if more scenes are requested than can be handled.

• /scenes/ should return the most recent 100 scenes
• /scenesToBeProcessed/ should return least recent scene

Having multiple processes per scene is probably too complicated. Yeah it's probably more correct, but it makes it hard to determine the status of a request. And that brings along a ton of other complexity, for example, I've noticed the generators will fail to process requests because they sometimes get stuck processing a single request.

• Have only one status
• Have only one result
• Be fairly flat
  • Avoid using maps where available

Generators should be able to

• Tell the API when they want to begin processing a request
  • Which will create a new processing item
• Mark a processing item as complete or failed
  • If complete, attach the result to the item

The API should provide a hook that allows generator result uploading, so that generators don't need to worry about storage.

Currently, all data is held in memory on the web server.

A database needs to be implemented to persist all information.

Now that a bunch of scenes are all loaded and presented on the /scenes/ page of the web app, it's really slow. I'd say this is mainly due to the weight of the images.

RESTful endpoint for scenes

• users should be able to create scene requests with POST
• users and generators should be able to see scenes with GET

Users should be able to upload files to the app and said file should be referenced in the scene request, so that generators can access the file

This is probably best done by uploading the files to S3 and then referencing that location

/v0-2/health/ endpoint

Generators should

• Be able to upload the result of a generator request

Setup image build process so that the app can be run easily in something like elastic beanstalk =D