Merge pull request #991 from scieloorg/beta

Incorporação de códigos estáveis

Author: gustavofonseca

.gitignore

@@ -6,3 +6,4 @@ settings_local.include
 *.coverage
 _build/
 bundle.min*
+.DS_Store

docs/dev/api.rst

@@ -9,7 +9,7 @@ access, but for future releases more methods will be added.
 If you have any problems or requests please contact
 `support <http://groups.google.com/group/scielo-discuss/>`_.
 
-**Current version:** API v1
+**Current version:** API v2 (continue providing support for v1)
 
 
 .. note::
@@ -41,7 +41,9 @@ Available endpoints
   users-api
   changes-api
   pressreleases-api
-  attempts-api
+  checkin-api
+  notices-api
+  checkins_articles-api
 
 
 .. note::

docs/dev/changes-api.rst

@@ -61,9 +61,15 @@ resource_uri
 List all events
 ---------------
 
-Request::
+Request:
 
-  GET /api/v1/changes
+  **API version 1**
+
+  *GET /api/v1/changes*
+
+  **API version 2**
+
+  *GET /api/v1/changes*
 
 Parameters:
 
@@ -83,3 +89,34 @@ Optional Parameters:
   **since**
 
     *Int* of the ``seq`` number used as a starting point to the query.
+
+
+Response version 1 and version 2::
+
+  {
+    "meta": {
+      "limit": 200,
+      "next": null,
+      "offset": 0,
+      "previous": null,
+      "total_count": 28
+    },
+    "objects": [
+      {
+        "changed_at": "2014-04-23T15:23:01.909588",
+        "collection_uri": "/api/v2/collections/1/",
+        "event_type": "added",
+        "object_uri": "/api/v2/journals/319/",
+        "resource_uri": "/api/v2/changes/1/",
+        "seq": 1
+      },
+      {
+        "changed_at": "2014-04-23T15:29:23.524776",
+        "collection_uri": "/api/v2/collections/1/",
+        "event_type": "added",
+        "object_uri": "/api/v2/journals/320/",
+        "resource_uri": "/api/v2/changes/2/",
+        "seq": 2
+      },
+    ]
+  }

docs/dev/checkin-api.rst

@@ -0,0 +1,106 @@
+Notices API
+===============
+
+List all notices
+--------------------
+
+Request:
+
+  **API version 1**
+
+  *GET /api/v1/notices*
+
+  **API version 2**
+
+  *GET /api/v2/notices*
+
+Parameters:
+
+  **--**
+
+Optional Parameters:
+
+  **callback**
+
+    *String* of the callback identifier to be returned when using JSONP.
+
+  **format**
+
+    *String* of the desired output format. The options are **xml, json,
+    yml**.
+
+Allowed Method:
+
+  GET, PUT, POST
+
+Response:
+
+  **API version 1 and version 2**::
+
+    {
+      "meta": {
+        "limit": 200,
+        "next": null,
+        "offset": 0,
+        "previous": null,
+        "total_count": 6
+      },
+      "objects": [
+        {
+          "checkin": "/api/v2/checkins/5/",
+          "checkpoint": "checkin",
+          "created_at": "2014-08-11T13:36:41.147189",
+          "id": 72,
+          "message": "bla",
+          "resource_uri": "/api/v2/notices/72/",
+          "stage": "Checkin",
+          "status": "SERV_END"
+        },
+      ]
+    }
+
+
+Get a single notice
+------------------------------
+
+Request:
+
+  **API version 1**
+
+  *GET /api/v1/notices/:id/*
+
+  **API version 2**
+
+  *GET /api/v2/notices/:id/*
+
+
+Parameters:
+
+  **--**
+
+Optional Parameters:
+
+  **callback**
+
+    *String* of the callback identifier to be returned when using JSONP.
+
+  **format**
+
+    *String* of the desired output format. The options are **xml, json,
+    yml**.
+
+
+Response:
+
+  **API version 1 and version 2**::
+
+    {
+      checkin: "/api/v2/checkins/5/",
+      checkpoint: "checkin",
+      created_at: "2014-08-11T13:36:41.147189",
+      id: 72,
+      message: "bla",
+      resource_uri: "/api/v2/notices/72/",
+      stage: "Checkin",
+      status: "SERV_END"
+    }