Skip to content

Commit

Permalink
Clean up documentation and leading spaces from code generator
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikedeboer
mikedeboer committed Apr 10, 2014
1 parent ff03357 commit df138d3
Show file tree
Hide file tree
Showing 12 changed files with 225 additions and 224 deletions.
16 changes: 8 additions & 8 deletions api/v3.0.0/authorization.js
View file
Expand Up @@ -108,9 +108,9 @@ var authorization = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - scopes (Array): Optional. Optional array - A list of scopes that this authorization is in.
* - note (String): Optional. Optional string - A note to remind you what the OAuth token is for.
* - note_url (String): Optional. Optional string - A URL to remind you what app the OAuth token is for.
* - scopes (Array): Optional. A list of scopes that this authorization is in.
* - note (String): Optional. A note to remind you what the OAuth token is for.
* - note_url (String): Optional. A URL to remind you what app the OAuth token is for.
**/
this.create = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -151,11 +151,11 @@ var authorization = module.exports = {
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - id (String): Required.
* - scopes (Array): Optional. Optional array - A list of scopes that this authorization is in.
* - add_scopes (Array): Optional. Optional array - A list of scopes to add to this authorization.
* - remove_scopes (Array): Optional. Optional array - A list of scopes to remove from this authorization.
* - note (String): Optional. Optional string - A note to remind you what the OAuth token is for.
* - note_url (String): Optional. Optional string - A URL to remind you what app the OAuth token is for.
* - scopes (Array): Optional. A list of scopes that this authorization is in.
* - add_scopes (Array): Optional. A list of scopes to add to this authorization.
* - remove_scopes (Array): Optional. A list of scopes to remove from this authorization.
* - note (String): Optional. A note to remind you what the OAuth token is for.
* - note_url (String): Optional. A URL to remind you what app the OAuth token is for.
**/
this.update = function(msg, block, callback) {
var self = this;
Expand Down
22 changes: 11 additions & 11 deletions api/v3.0.0/gists.js
View file
Expand Up @@ -29,7 +29,7 @@ var gists = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
* - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
**/
this.getAll = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -72,7 +72,7 @@ var gists = module.exports = {
* - user (String): Required.
* - page (Number): Optional. Page number of the results to fetch. Validation rule: ` ^[0-9]+$ `.
* - per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ` ^[0-9]+$ `.
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
* - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
**/
this.getFromUser = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -114,7 +114,7 @@ var gists = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - description (String): Optional.
* - public (Boolean): Required.
* - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
* - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
**/
this.create = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -156,7 +156,7 @@ var gists = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - id (String): Required.
* - description (String): Optional.
* - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
* - files (Json): Required. Files that make up this gist. The key of which should be a required string filename and the value another required hash with parameters: 'content'
**/
this.edit = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -196,7 +196,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
* - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
**/
this.public = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -236,7 +236,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
* - since (Date): Optional. Timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
**/
this.starred = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -516,7 +516,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
**/
this.getComments = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -556,7 +556,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - id (String): Required.
**/
this.getComment = function(msg, block, callback) {
Expand Down Expand Up @@ -597,7 +597,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - body (String): Required.
**/
this.createComment = function(msg, block, callback) {
Expand Down Expand Up @@ -638,7 +638,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - id (String): Required.
* - body (String): Required.
**/
Expand Down Expand Up @@ -680,7 +680,7 @@ var gists = module.exports = {
* ##### Params on the `msg` object:
*
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - gist_id (String): Required. Id (SHA1 hash) of the gist.
* - id (String): Required.
**/
this.deleteComment = function(msg, block, callback) {
Expand Down
30 changes: 15 additions & 15 deletions api/v3.0.0/gitdata.js
View file
Expand Up @@ -158,9 +158,9 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - message (String): Required. String of the commit message
* - tree (String): Required. String of the SHA of the tree object this commit points to
* - parents (Array): Required. Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
* - message (String): Required. String of the commit message
* - tree (String): Required. String of the SHA of the tree object this commit points to
* - parents (Array): Required. Array of the SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided, for a merge commit, an array of more than one should be provided.
* - author (Json): Optional.
* - committer (Json): Optional.
**/
Expand Down Expand Up @@ -204,7 +204,7 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
**/
this.getReference = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -289,7 +289,7 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - sha (String): Required.
**/
this.createReference = function(msg, block, callback) {
Expand Down Expand Up @@ -332,9 +332,9 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - sha (String): Required.
* - force (Boolean): Optional. Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.
* - force (Boolean): Optional. Boolean indicating whether to force the update or to make sure the update is a fast-forward update. The default is false, so leaving this out or setting it to false will make sure you’re not overwriting work.
**/
this.updateReference = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -376,7 +376,7 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
* - ref (String): Required. String of the name of the fully qualified reference (ie: heads/master). If it doesn’t have at least one slash, it will be rejected.
**/
this.deleteReference = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -460,11 +460,11 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - tag (String): Required. String of the tag
* - message (String): Required. String of the tag message
* - object (String): Required. String of the SHA of the git object this is tagging
* - type (String): Required. String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
* - tagger (Json): Required. JSON object that contains the following keys: `name` - String of the name of the author of the tag, `email` - String of the email of the author of the tag, `date` - Timestamp of when this object was tagged
* - tag (String): Required. String of the tag
* - message (String): Required. String of the tag message
* - object (String): Required. String of the SHA of the git object this is tagging
* - type (String): Required. String of the type of the object we’re tagging. Normally this is a commit but it can also be a tree or a blob.
* - tagger (Json): Required. JSON object that contains the following keys: `name` - String of the name of the author of the tag, `email` - String of the email of the author of the tag, `date` - Timestamp of when this object was tagged
**/
this.createTag = function(msg, block, callback) {
var self = this;
Expand Down Expand Up @@ -549,8 +549,8 @@ var gitdata = module.exports = {
* - headers (Object): Optional. Key/ value pair of request headers to pass along with the HTTP request. Valid headers are: 'If-Modified-Since', 'If-None-Match', 'Cookie', 'User-Agent', 'Accept', 'X-GitHub-OTP'.
* - user (String): Required.
* - repo (String): Required.
* - tree (Json): Required. Array of Hash objects (of path, mode, type and sha) specifying a tree structure
* - base_tree (String): Optional. String of the SHA1 of the tree you want to update with new data
* - tree (Json): Required. Array of Hash objects (of path, mode, type and sha) specifying a tree structure
* - base_tree (String): Optional. String of the SHA1 of the tree you want to update with new data
**/
this.createTree = function(msg, block, callback) {
var self = this;
Expand Down

0 comments on commit df138d3

Please sign in to comment.