Correção na documentação dos endpoints da API

scieloorg · Sep 29, 2014 · 79472e2 · 79472e2
1 parent a797c41
commit 79472e2
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 44 deletions.
diff --git a/docs/dev/checkin-api.rst b/docs/dev/checkin-api.rst
@@ -1,18 +1,18 @@
-Notices API
+Checkins API
 ===============
 
-List all notices
+List all checkins
 --------------------
 
 Request:
 
   **API version 1**
 
-  *GET /api/v1/notices*
+  *GET /api/v1/checkins*
 
   **API version 2**
 
-  *GET /api/v2/notices*
+  *GET /api/v2/checkins*
 
 Parameters:
 
@@ -60,18 +60,18 @@ Response:
     }
 
 
-Get a single notice
+Get a single checkin
 ------------------------------
 
 Request:
 
   **API version 1**
 
-  *GET /api/v1/notices/:id/*
+  *GET /api/v1/checkins/:id/*
 
   **API version 2**
 
-  *GET /api/v2/notices/:id/*
+  *GET /api/v2/checkins/:id/*
 
 
 Parameters:

diff --git a/docs/dev/notices-api.rst b/docs/dev/notices-api.rst
@@ -8,11 +8,11 @@ Request:
 
   **API version 1**
 
-  *GET /api/v1/collections*
+  *GET /api/v1/notices*
 
   **API version 2**
 
-  *GET /api/v2/collections*
+  *GET /api/v2/notices*
 
 Parameters:
 
@@ -48,23 +48,14 @@ Response:
       },
       "objects": [
         {
-          "acronym": "scl",
-          "address": "Rua Machado Bitencourt",
-          "address_complement": "",
-          "address_number": "430",
-          "city": "São Paulo",
-          "country": "Brasil",
-          "email": "",
-          "fax": "",
-          "id": "1",
-          "logo": null,
-          "name": "Brasil",
-          "name_slug": "brasil",
-          "phone": "",
-          "resource_uri": "/api/v1/collections/1/",
-          "state": "São Paulo",
-          "url": "http://www.scielo.br",
-          "zip_code": null
+        checkin: "/api/v1/checkins/1/",
+        checkpoint: "validation",
+        created_at: "2014-07-30T15:09:50.720126",
+        id: 34,
+        message: "",
+        resource_uri: "/api/v2/notices/34/",
+        stage: "",
+        status: "SERV_END"
         }
       ]
     }
@@ -75,7 +66,7 @@ Get a single notices
 
 Request::
 
-  GET /api/v1/collections/:id/
+  GET /api/v1/notices/:id/
 
 Parameters:
 
@@ -98,21 +89,12 @@ Response:
   **API version 1, version 2**::
 
     {
-      "acronym": "scl",
-      "address": "Rua Machado Bitencourt",
-      "address_complement": "",
-      "address_number": "430",
-      "city": "São Paulo",
-      "country": "Brasil",
-      "email": "",
-      "fax": "",
-      "id": "1",
-      "logo": null,
-      "name": "Brasil",
-      "name_slug": "brasil",
-      "phone": "",
-      "resource_uri": "/api/v1/collections/1/",
-      "state": "São Paulo",
-      "url": "http://www.scielo.br",
-      "zip_code": null
+      checkin: "/api/v2/checkins/2/",
+      checkpoint: "validation",
+      created_at: "2014-07-30T15:09:50.720126",
+      id: 34,
+      message: "",
+      resource_uri: "/api/v2/notices/34/",
+      stage: "",
+      status: "SERV_END"
     }