GitHub v3 REST API

Gist Comment

object

A comment made to a gist.

idintegerrequired

Example:1

node_idstringrequired

Example:MDExOkdpc3RDb21tZW50MQ==

urlstring(uri)required

Example:https://api.github.com/gists/a6db0bec360bb87e9418/comments/1

bodystringrequired

The comment text.

<= 65535 characters

Example:Body of the attachment

userobjectrequired

Simple User

Show Child Parameters
created_atstring(date-time)required

Example:2011-04-18T23:23:56Z

updated_atstring(date-time)required

Example:2011-04-18T23:23:56Z

author_associationstringrequired

How the author is associated with the repository.

Allowed values:COLLABORATORCONTRIBUTORFIRST_TIMERFIRST_TIME_CONTRIBUTORMANNEQUINMEMBERNONEOWNER

Example:OWNER

Example

Gist Commit

object

Gist Commit

urlstring(uri)required

Example:https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f

versionstringrequired

Example:57a7f021a713b1c5a6a199b54cc514735d2d462f

userobjectrequired

Simple User

Show Child Parameters
change_statusobjectrequired
Show Child Parameters
committed_atstring(date-time)required

Example:2010-04-14T02:15:15Z

Example

Gitignore Template

object

Gitignore Template

namestringrequired

Example:C

sourcestringrequired

Example:# Object files *.o # Libraries *.lib *.a # Shared objects (inc. Windows DLLs) *.dll *.so *.so.* *.dylib # Executables *.exe *.out *.app

Example

License Simple

object

License Simple

keystringrequired

Example:mit

namestringrequired

Example:MIT License

urlstring(uri)required

Example:https://api.github.com/licenses/mit

spdx_idstringrequired

Example:MIT

node_idstringrequired

Example:MDc6TGljZW5zZW1pdA==

html_urlstring(uri)
Example

License

object

License

keystringrequired

Example:mit

namestringrequired

Example:MIT License

spdx_idstringrequired

Example:MIT

urlstring(uri)required

Example:https://api.github.com/licenses/mit

node_idstringrequired

Example:MDc6TGljZW5zZW1pdA==

html_urlstring(uri)required

Example:http://choosealicense.com/licenses/mit/

descriptionstringrequired

Example:A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.

implementationstringrequired

Example:Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.

permissionsarray[string]required

Example:commercial-use, modifications, distribution, sublicense, private-use

conditionsarray[string]required

Example:include-copyright

limitationsarray[string]required

Example:no-liability

bodystringrequired

Example: The MIT License (MIT) Copyright (c) [year] [fullname] Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

featuredbooleanrequired

Example:true

Example