Changes between Version 12 and Version 13 of RestfulAPI


Ignore:
Timestamp:
02/15/08 19:52:00 (6 years ago)
Author:
johnbywater
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • RestfulAPI

    v12 v13  
    8686== Data Formats == 
    8787 
     88'''''Todo: Decide how to identify objects (name, database ID, UUID), then fixup these data formats. Currently assumed to use the value of the object name attribute as the object's resource identifier.''''' 
     89 
     90==== Database ID Format ==== 
     91 
     92{{{ 
     93    An integer. 
     94}}} 
     95 
     96==== UUID Format ==== 
     97 
     98{{{ 
     99    ? 
     100}}} 
     101 
     102 
     103==== Name ID Format ==== 
     104 
     105{{{ 
     106    An string. 
     107}}} 
     108 
     109 
    88110==== License List Format ==== 
    89111 
    … …  
    92114    "licence-list": [ 
    93115        { 
    94             "id": 1, 
    95             'name": "BSD" 
     116            "id": "BSD" 
    96117 
    97118        },{ 
    98             "id": 2, 
    99             "name": "MIT" 
     119            "id": "MIT" 
    100120        } 
    101121    ] 
    … …  
    108128{ 
    109129    "licence": { 
    110         "id": 1, 
    111130        "name": "BSD" 
    112131    } 
    … …  
    120139    "package-list": [ 
    121140        { 
    122             "id": 1, 
    123             "name": "dataset-1" 
     141            "id": "dataset-1" 
    124142 
    125143        },{ 
    126             "id": 2, 
    127             "name": "dataset-2" 
     144            "id": "dataset-2" 
    128145        } 
    129146    ] 
    … …  
    136153{ 
    137154    "package": { 
    138         "id": 1, 
    139         "name": "string", 
    140         "title": "string", 
    141         "url": "string", 
    142         "download_url": "string", 
     155        "name": "dataset-1", 
     156        "title": "My Title", 
     157        "url": "http://mylocation", 
     158        "download_url": "http://mydownloadlocation", 
    143159        "licences": [5,7], 
    144160        "tags": "this that other", 
    145         "notes": "some notes" 
     161        "notes": "Some notes." 
    146162    } 
    147163} 
    … …  
    154170    "tag-list": [ 
    155171        { 
    156             "id": 1, 
    157             "name": "this" 
     172            "id": "this" 
    158173 
    159174        },{ 
    160             "id": 2, 
    161             "name": "that" 
     175            "id": "that" 
    162176        } 
    163177    ] 
    … …  
    170184{ 
    171185    "tag": { 
    172         "id": 1, 
    173186        "name": "this" 
    174187    }