Added documentation of JSON URLs

This commit is contained in:
Christoph Haas 2016-08-12 18:46:23 +02:00
parent e6504f0182
commit 140756c17f

View file

@ -120,8 +120,34 @@
' screenshot was found then a dummy image will be returned along with the
' HTTP code 404.)
' If you would like to get a complete list of packages or screenshots in JSON
' format then contact us and we will give you the URL.
p
' If you would like to get a complete list of packages or screenshots in JSON
' format then use one of these URLs:
ul
li
' http://screenshots.debian.net/json/package/PACKAGENAME
br
' Returns a JSON structure containing the URLs to the thumbnails and
' full-size images of the screenshots available on this site.
li
' http://screenshots.debian.net/json/packages
br
' Returns a JSON structure containing information about all packages
' but not the actual screenshots.
' The returned object is huge so please use it sparingly.
li
' http://screenshots.debian.net/json/screenshots
br
' Returns a JSON structure containing informatoin about all packages
' and one screenshot's URL each. There may be further screenshots that are
' not included.
li
' http://screenshots.debian.net/json/packages-without-screenshots
br
' Returns a JSON structure containing the names of all packages
' that still lack screenshots. If you want to help contributing
' then this data can be useful.
h2 Uploading new screenshots