From e983c14d934f2f8ca0bdf0830f37c669cacd74c2 Mon Sep 17 00:00:00 2001 From: Tyler Stark Date: Sat, 4 Apr 2015 11:40:25 -0700 Subject: [PATCH] Updating Documentation Updating documentation to more accurately describe the descriptions field. This PR: * changed `descriptions/1/` to `descriptions/2` * Updated the response to match what `descriptions/2` provides Please see https://github.com/phalt/pokeapi/issues/29 for more details --- templates/pages/docs.html | 37 +++++++++++++++++-------------------- 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/templates/pages/docs.html b/templates/pages/docs.html index 93248bcc..25616e66 100755 --- a/templates/pages/docs.html +++ b/templates/pages/docs.html @@ -434,30 +434,27 @@

GET description/

GET description/ID/

Example request

-
GET http://pokeapi.co/api/v1/description/1/
+
GET http://pokeapi.co/api/v1/description/2/

Result:

 {
-  "created": "2013-11-02T12:19:03.576753",
-  "description": "A strange seed was planted on its back at birth. The plant sprouts and grows with this Pokémon.",
-  "games": [
-    {
-      "name": "Pokemon Blue",
-      "resource_uri": "/api/v1/game/2/"
+    created: '2013-12-24T17:14:38.281429',
+    description: 'A strange seed was planted on its back at birth. The plant sprouts and grows with this POKMON.',
+    games: [{
+        name: 'red(JPN)',
+        resource_uri: '/api/v1/game/1/'
+    }, {
+        name: 'green(JPN)',
+        resource_uri: '/api/v1/game/2/'
+    }],
+    id: 2,
+    modified: '2014-01-18T14:29:53.118541',
+    name: 'Bulbasaur_gen_1',
+    pokemon: {
+        name: 'bulbasaur',
+        resource_uri: '/api/v1/pokemon/1/'
     },
-    {
-      "name": "Pokemon Red",
-      "resource_uri": "/api/v1/game/1/"
-    }
-  ],
-  "id": 1,
-  "modified": "2013-11-02T12:19:24.334212",
-  "name": "Bulbasaur_red_blue",
-  "pokemon": {
-    "name": "bulbasaur",
-    "resource_uri": "/api/v1/pokemon/1/"
-  },
-  "resource_uri": "/api/v1/description/1/"
+    resource_uri: '/api/v1/description/2/'
 }
             

Fields: