Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Gists API

View, modify your gists.

This API exposes 20 operations across 11 paths, and defines 11 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

20 operations 11 paths 11 schemas 3 DELETE11 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Gists API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 20

Across 11 paths, the API surfaces 20 operations — 3 DELETE, 11 GET, 2 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Gists 20

View, modify your gists.

GET
/gists
APIs.io Engineering Platform List gists for the authenticated user
gists/list 3 params → 200304403
POST
/gists
APIs.io Engineering Platform Create a gist
gists/create body → 201422304404403
GET
/gists/public
APIs.io Engineering Platform List public gists
gists/list-public 3 params → 200422304403
GET
/gists/starred
APIs.io Engineering Platform List starred gists
gists/list-starred 3 params → 200401304403
GET
/gists/{gist_id}
APIs.io Engineering Platform Get a gist
gists/get 1 param → 200403404304
PATCH
/gists/{gist_id}
APIs.io Engineering Platform Update a gist
gists/update 1 param body → 200422404
DELETE
/gists/{gist_id}
APIs.io Engineering Platform Delete a gist
gists/delete 1 param → 204404304403
GET
/gists/{gist_id}/comments
APIs.io Engineering Platform List gist comments
gists/list-comments 3 params → 200304404403
POST
/gists/{gist_id}/comments
APIs.io Engineering Platform Create a gist comment
gists/create-comment 1 param body → 201304404403
GET
/gists/{gist_id}/comments/{comment_id}
APIs.io Engineering Platform Get a gist comment
gists/get-comment 2 params → 200304404403
PATCH
/gists/{gist_id}/comments/{comment_id}
APIs.io Engineering Platform Update a gist comment
gists/update-comment 2 params body → 200404
DELETE
/gists/{gist_id}/comments/{comment_id}
APIs.io Engineering Platform Delete a gist comment
gists/delete-comment 2 params → 204304404403
GET
/gists/{gist_id}/commits
APIs.io Engineering Platform List gist commits
gists/list-commits 3 params → 200404304403
GET
/gists/{gist_id}/forks
APIs.io Engineering Platform List gist forks
gists/list-forks 3 params → 200404304403
POST
/gists/{gist_id}/forks
APIs.io Engineering Platform Fork a gist
gists/fork 1 param → 201404422304403
GET
/gists/{gist_id}/star
APIs.io Engineering Platform Check if a gist is starred
gists/check-is-starred 1 param → 204404304403
PUT
/gists/{gist_id}/star
APIs.io Engineering Platform Star a gist
gists/star 1 param → 204404304403
DELETE
/gists/{gist_id}/star
APIs.io Engineering Platform Unstar a gist
gists/unstar 1 param → 204304404403
GET
/gists/{gist_id}/{sha}
APIs.io Engineering Platform Get a gist revision
gists/get-revision 2 params → 200422404403
GET
/users/{username}/gists
APIs.io Engineering Platform List gists for a user
gists/list-for-user 4 params → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are public-user (40 properties), nullable-simple-user (21 properties), simple-user (21 properties), gist-simple (21 properties). Each schema is shown below with its type and property counts.

nullable-simple-user
object
A GitHub user.
21 properties 18 required
gist-history
object
Gist History
5 properties
gist-commit
object
Gist Commit
5 properties 5 required
public-user
object
Public User
40 properties 31 required
basic-error
object
Basic Error
4 properties
validation-error
object
Validation Error
3 properties 2 required
simple-user
object
A GitHub user.
21 properties 18 required
gist-simple
object
Gist Simple
21 properties
gist-comment
object
A comment made to a gist.
8 properties 8 required
author-association
string
How the author is associated with the repository.
base-gist
object
Base Gist
20 properties 16 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-gists-api-openapi.yml Raw ↑