You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 1, 2017. It is now read-only.
Copy file name to clipboardExpand all lines: content/changes/2014-04-22-gist-api-now-truncating-large-files.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,12 @@ created_at: 2014-04-22
5
5
author_name:leongersing
6
6
---
7
7
8
-
In order to provide the most robust, fast and accurate API for Gist we recently decided to make a few small changes to the*files*payload.
8
+
In order to provide the most robust, fast and accurate API for Gist we recently decided to make a few small changes to the*files*attribute.
9
9
10
-
###Truncating file contentsless than 1MB
11
-
Sometimes we need to put some large data into a gist. However, we don't always need to see the full content of that large gist when we're fetching the metadata for gists via the API.This change imposes a sensible (according to our data) limit on the amount of raw file data that is returned in gist fetches via the API.If you're relying on reading the full content of individual files from a gist then you mayneedto update your flow to perform a followup request forthe**raw_url** resource in order to download the entirecontents ofthefile. Which begs the question:*How do I know if thefile's contents have been truncated?*
10
+
###Truncating file contentslarger than 1MB
11
+
This change imposes a sensible (according to our data) limit on the amount of raw file data that is returned in gist fetches via the API.This means faster response times while eliminating browser timeouts when fetching gists that contains large files. When youneed thefullcontents ofyour gist'sfile, simply make a request to the url specified in theraw_url attribute.
12
12
13
-
###New files.truncated property
14
-
On the packets that have been truncated you will notice a new key in the files segment of the payload.
13
+
###"truncated" attribute
15
14
16
15
{
17
16
files: {
@@ -26,9 +25,7 @@ On the packets that have been truncated you will notice a new key in the files s
26
25
}
27
26
}
28
27
29
-
In this small example payload, you'll notice the new*truncated* key has been added and the*content* key's value is empty. This would be a case for making a follow up request to the raw_url, if you are looking to get all of the data that would have normally showed up in the content field.
30
-
31
-
>Please note that in some cases you may have data in the content field but it has also been truncated. In this case, simply make a follow up request to the raw_url in order recieve the full contents of the file.
28
+
In this small example payload, you'll notice the new**truncated** attribute has been added to each file's payload. It is a boolean attribute indicating if the content attribute's value has been truncated for this request.
32
29
33
30
If you have any questions, please[get in touch][contact].