Routes from debshots 1.x documented

README.rdoc

@@ -1,28 +1,111 @@
 == README
 
-This README would normally document whatever steps are necessary to get the
+= Installing debshots
-application up and running.
 
-Things you may want to cover:
+TODO
 
-* Ruby version
+= Supported URL paths (aka routes)
 
-* System dependencies
+/screenshots/:package_inital/:package/:(id)_:size.png
+* package = name of the package
+* id = numerical ID of the screenshot
+* size = "large" or "small"
+* Returns a PNG image of a screenshot
+* Should be served as a static asset
 
-* Configuration
+/image/:(id)_:size.png
+* id = numerical ID of the screenshot
+* size = "large" or "small"
+* Returns a PNG image of a screenshot
+* Usually used for unapproved images that should just be shown to the uploader
 
-* Database creation
+/about
+* Return an informational HTML page
 
-* Database initialization
+/packages
+* Return a list of packages with pagination
 
-* How to run the test suite
+/packages/with_screenshots
+* Return a list of packages with pagination
+* Select only those packages that have screenshots.
 
-* Services (job queues, cache servers, search engines, etc.)
+/packages/without_screenshots
+* Return a list of packages with pagination
+* Select only those packages that do not have screenshots.
 
-* Deployment instructions
+/packages/games_without_screenshots (deprecated)
+* Return a list of packages with pagination
+* Select only those packages that belong to Debian's "games" section
 
-* ...
+/json/packages
+* Return a JSON data structure of all packages
 
+/json/screenshots
+* Return a JSON data structure containing packages and screenshots
 
-Please feel free to use a different markup language if you do not plan to run
+/json/packages-without-screenshots
-<tt>rake doc:app</tt>.
+* Return a JSON data structure of those packages that do not have any screenshots
+
+/packages/moderate
+* Return a HTML page showing packages that need moderation
+* Must only be available to logged in moderators
+
+/upload
+* Return a HTML page containing an upload form for new screenshots
+
+/guidelines (deprecated)
+* Return a HTML page showing general guidelines for creating screenshots
+* Should just redirect to the /upload page
+
+/upload/:package
+* ??
+
+/uploadfile
+* ??
+
+/login
+* Show a login form
+
+/logout
+* Logout the user by invalidating the cookie session.
+
+/package/:package
+* Show details of a certain package
+
+/json/package/:package
+* Return a JSON data structure containing details of a certain package
+
+/thumbnail/:package
+/thumbnail-404/:package (deprecated)
+* Return a small (160x120 pixel) PNG screenshot file of a package
+* If the package does not have any screenshots then return a 404 code
+
+/thumbnail-with-version/:package/:version
+* Return a small (160x120 pixel) PNG screenshot file of a package
+* If the package does not have any screenshots then return a 404 code
+* Prefer screenshots of a certain version
+
+/screenshot/:package
+/screenshot-404/:package (deprecated)
+* Return a small (320x240 pixel) PNG screenshot file of a package
+* If the package does not have any screenshots then return a 404 code
+
+/screenshot-with-version/:package/:version
+* Return a large (320x240 pixel) PNG screenshot file of a package
+* If the package does not have any screenshots then return a 404 code
+* Prefer screenshots of a certain version
+
+/delete_screenshot/:screenshot
+* Users: request deletion of a screenshot
+* Moderators: delete a screenshot
+
+/approve_screenshot/:screenshot
+* Users: 403
+* Moderators: approve a screenshot
+
+/keep_screenshot/:screenshot
+* Users: 403
+* Moderators: re-approve a screenshot that was requested for deletion
+
+/rss
+* Return an RSS feed of new uploads of screenshots