debshots/doc
2021-02-25 00:14:17 +01:00
..
css Ignoring automatically creating documentation 2021-02-07 16:53:41 +01:00
DebImporter Ignoring automatically creating documentation 2021-02-07 16:53:41 +01:00
Users Ignoring automatically creating documentation 2021-02-07 16:53:41 +01:00
README.authentication.md URL fixed 2018-08-10 12:41:46 +02:00
README.DeveloperNotes.md Paperclip cruft removed 2021-02-25 00:14:17 +01:00
README.Development.md Rails update. Fancybox update. Migrations from Paperclip. 2020-10-19 18:49:47 +02:00
README.Installation.md Rails update. Fancybox update. Migrations from Paperclip. 2020-10-19 18:49:47 +02:00
README.URLs.md Documentation revamped 2018-08-08 14:14:40 +02:00

Supported URL paths (aka routes)

/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

/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

/about

  • Return an informational HTML page

/packages

  • Return a list of packages with pagination

/packages/with_screenshots

  • Return a list of packages with pagination
  • Select only those packages that have screenshots.

/packages/without_screenshots

  • Return a list of packages with pagination
  • Select only those packages that do not have screenshots.

/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

/json/packages-without-screenshots

  • 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 large (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