Deployments API is no longer an encoded JSON string

atmos · atmos · commit e140573b5647 · 2014-03-03T18:38:08.000-08:00
diff --git a/content/changes/2014-03-03-deployments-api-updates.md b/content/changes/2014-03-03-deployments-api-updates.md
@@ -0,0 +1,21 @@
+---
+kind: change
+title: New Payload format for Deployments
+created_at: 2014-03-03
+author_name: atmos
+---
+
+As we [iterate on the preview][january-deployment-api-post] for the new Deployment API, we're making sure that it's friendly to work with for the apps built on top of it.
+
+## Deserialize Deployment Payloads
+
+To make the API even easier to use, we'll now return your custom payload as a JSON object along with the rest of the Deployment resource. No need to parse it as JSON again.
+
+## Code you need to update
+
+You should only need to remove the JSON parsing if you're taking advantage of the custom payloads. The formats for creating Deployments remain unchanged.
+
+As always, if you have any questions or feedback, please [get in touch][contact].
+
+[january-deployment-api-post]: /changes/2014-01-09-preview-the-new-deployments-api/
+[contact]: https://github.com/contact?form[subject]=Deployments+API
diff --git a/lib/resources.rb b/lib/resources.rb
@@ -1567,7 +1567,7 @@ def text_html(response, status, head = {})
       "sha" => "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d",
       "url" => "https://api.github.com/repos/octocat/example/deployments/1",
       "creator" => USER,
-      "payload" => JSON.dump({:environment => 'production'}),
+      "payload" => {:environment => 'production'},
       "created_at" => "2012-07-20T01:19:13Z",
       "updated_at" => "2012-07-20T01:19:13Z",
       "description" => "Deploy request from hubot",
@@ -1579,7 +1579,7 @@ def text_html(response, status, head = {})
       "url" => "https://api.github.com/repos/octocat/example/deployments/1/statuses/42",
       "state" => "success",
       "creator" => USER,
-      "payload" => JSON.dump({:environment => 'production'}),
+      "payload" => {:environment => 'production'},
       "target_url" => "https://gist.github.com/628b2736d379f",
       "created_at" => "2012-07-20T01:19:13Z",
       "updated_at" => "2012-07-20T01:19:13Z",
