[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#581710: [PATCH] Update API documentation for /mr/file/<hash>/info



Package: snapshot.debian.org
Tags: patch

Hi,

the documentation for /mr/file/<hash>/info does not match what the
server returns: the key "archive_name" is used instead of "archive" and
there is a "run" field instead of "first-seen" and "last-seen".

Please consider applying the attached patch.

The other two patches fix the use of quotes in the API documentation and
a spelling error in the README.  Please consider them as well.

Regards,
Ansgar
>From 8efb424e47268c6d87128d00757d40d2a71cacb4 Mon Sep 17 00:00:00 2001
From: Ansgar Burchardt <ansgar@43-1.org>
Date: Sat, 15 May 2010 15:25:59 +0900
Subject: [PATCH 1/3] Update API documentation for /mr/file/<hash>/info

Signed-off-by: Ansgar Burchardt <ansgar@43-1.org>
---
 API |   15 ++++++---------
 1 files changed, 6 insertions(+), 9 deletions(-)

diff --git a/API b/API
index a1cdda7..bf2b647 100644
--- a/API
+++ b/API
@@ -149,24 +149,21 @@ http status codes: 200 500 404 304
 {   '_comment': "yadayadayda",
     'hash': "bae0f2e5bbedf1fcbdc88061f3f5b1f916824522",
     'result':
-        [   {   'archive': 'debian-security',
+        [   {   'archive_name': 'debian-security',
                 'name': 'xulrunner_1.9.0.12.orig.tar.gz',
                 'path': '/pool/updates/main/x/xulrunner',
                 'size': 43962222,
-                'first-seen': 2009-07-23 10:10:51,
-                'last-seen': 2009-08-30 12:13:40 },
-            {   'archive': 'debian',
+                'run': '20090723T101051Z' },
+            {   'archive_name': 'debian',
                 'name': 'iceweasel_3.0.12.orig.tar.gz',
                 'path': '/pool/main/i/iceweasel',
                 'size': 43962222,
-                'first-seen': 2009-08-01 19:23:39,
-                'last-seen': 2009-09-24 10:43:13 },
-            {   'archive': 'debian',
+                'run': '20090801T192339Z' },
+            {   'archive_name': 'debian',
                 'name': 'xulrunner_1.9.0.12.orig.tar.gz',
                 'path': '/pool/main/x/xulrunner',
                 'size': 43962222,
-                'first-seen': 2009-08-01 19:23:39
-                'last-seen': 2009-08-30 04:26:06 },
+                'run': '20090801T192339Z' },
        ]
 }
 
-- 
1.7.1

>From c899a05c26e1d2311cd62584407a2d17b82908f8 Mon Sep 17 00:00:00 2001
From: Ansgar Burchardt <ansgar@43-1.org>
Date: Sat, 15 May 2010 15:28:15 +0900
Subject: [PATCH 2/3] Fix use of quotes in API documentation

Signed-off-by: Ansgar Burchardt <ansgar@43-1.org>
---
 API |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/API b/API
index bf2b647..ac168ea 100644
--- a/API
+++ b/API
@@ -53,9 +53,9 @@ summary: list all binary packages associated with this source package at that ve
     'package': "tor",
     'version': "0.2.1.22-1",
     'result':
-        [   { 'name": 'tor'      , 'version': '0.2.1.22-1' },
-            { 'name": 'tor-dbg'  , 'version': '0.2.1.22-1' },
-            { 'name": 'tor-geoip', 'version': '0.2.1.22-1' },
+        [   { 'name': 'tor'      , 'version': '0.2.1.22-1' },
+            { 'name': 'tor-dbg'  , 'version': '0.2.1.22-1' },
+            { 'name': 'tor-geoip', 'version': '0.2.1.22-1' },
             ...
         ]
 }
-- 
1.7.1

>From 25d8f90af2630d213e6593e9190b4e45e34b6893 Mon Sep 17 00:00:00 2001
From: Ansgar Burchardt <ansgar@43-1.org>
Date: Sat, 15 May 2010 15:29:25 +0900
Subject: [PATCH 3/3] Fix spelling error in README

Signed-off-by: Ansgar Burchardt <ansgar@43-1.org>
---
 README |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/README b/README
index 5037391..e0314af 100644
--- a/README
+++ b/README
@@ -133,7 +133,7 @@ Missing wanted features:
 Depends: ruby, libdbd-pg-ruby1.8 libbz2-ruby1.8 libbz2-ruby1.8, python-yaml, python-psycopg2, fuse-utils python-fuse, uuid-runtime
 Web-Depends: python-pylons (that is {python-pylons,python-routes,python-nose,python-paste,python-pastedeploy,python-pastescript,python-webob,python-weberror,python-beaker,python-mako,python-formencode,python-webhelpers,python-decorator,python-simplejson}/lenny-backports )
 Web-Recommends: libapache2-mod-wsgi apache2
-Apache config:  requored modules: expires headers
+Apache config: required modules: expires headers
 
 
 
-- 
1.7.1


Reply to: