Gist Fox API is a pastes service similar to GitHub’s Gist.
Currently the Gist Fox API does not provide authenticated access.
Where applicable this API uses the HAL+JSON media-type to represent resources states and affordances.
Requests with a message-body are using plain JSON to set or update resource states.
The common HTTP Response Status Codes are used.
Gist Fox API entry point.
This resource does not have any attributes. Instead it offers the initial API affordances in the form of the HTTP Link header and HAL links.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/>;rel="self",<http:/api.gistfox.com/gists>;rel="gists" |
application/hal+json
{
"_links": {
"self": { "href": "/" },
"gists": { "href": "/gists?{since}", "templated": true }
}
}
Gist-related resources of Gist Fox API.
A single Gist object. The Gist resource is the central resource in the Gist Fox API. It represents one paste - a single text note.
The Gist resource has the following attributes:
id
created_at
description
content
The states id and created_at are assigned by the Gist Fox API at the moment of creation.
HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/gists/42>;rel="self", <http:/api.gistfox.com/gists/42/star>;rel="star" |
application/hal+json
{
"_links": {
"self": { "href": "/gists/42" },
"star": { "href": "/gists/42/star" }
},
"id": "42",
"created_at": "2014-04-14T02:15:15Z",
"description": "Description of Gist",
"content": "String contents"
}
To update a Gist send a JSON with updated value for one or more of the Gist resource attributes. All attributes values (states) from the previous version of this Gist are carried over by default if not included in the hash.
Headers | |
---|---|
Content-Type | application/json |
application/json
{
"content": "Updated file contents"
}
HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/gists/42>;rel="self", <http:/api.gistfox.com/gists/42/star>;rel="star" |
application/hal+json
{
"_links": {
"self": { "href": "/gists/42" },
"star": { "href": "/gists/42/star" }
},
"id": "42",
"created_at": "2014-04-14T02:15:15Z",
"description": "Description of Gist",
"content": "String contents"
}
Collection of all Gists.
The Gist Collection resource has the following attribute:
In addition it embeds Gist Resources in the Gist Fox API.
Parameters | |||
---|---|---|---|
since |
string |
Timestamp in ISO 8601 format: |
HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/gists>;rel="self" |
application/hal+json
{
"_links": {
"self": { "href": "/gists" }
},
"_embedded": {
"gists": [
{
"_links" : {
"self": { "href": "/gists/42" }
},
"id": "42",
"created_at": "2014-04-14T02:15:15Z",
"description": "Description of Gist"
}
]
},
"total": 1
}
To create a new Gist simply provide a JSON hash of the description and content attributes for the new Gist.
Headers | |
---|---|
Content-Type | application/json |
application/json
{
"description": "Description of Gist",
"content": "String content"
}
HAL+JSON representation of Gist Resource. In addition to representing its state in the JSON form it offers affordances in the form of the HTTP Link header and HAL links.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/gists/42>;rel="self", <http:/api.gistfox.com/gists/42/star>;rel="star" |
application/hal+json
{
"_links": {
"self": { "href": "/gists/42" },
"star": { "href": "/gists/42/star" }
},
"id": "42",
"created_at": "2014-04-14T02:15:15Z",
"description": "Description of Gist",
"content": "String contents"
}
Star resource represents a Gist starred status.
The Star resource has the following attribute:
HAL+JSON representation of Star Resource.
Headers | |
---|---|
Content-Type | application/hal+json |
Link | <http:/api.gistfox.com/gists/42/star>;rel="self" |
application/hal+json
{
"_links": {
"self": { "href": "/gists/42/star" }
},
"starred": true
}