node-github
Advanced tools
Comparing version 0.0.1 to 0.0.2
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin events | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,6 +24,9 @@ "use strict"; | ||
* events#get(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -60,8 +65,11 @@ this.get = function(msg, block, callback) { | ||
* events#getFromRepo(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (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]+$ `. | ||
**/ | ||
@@ -100,8 +108,11 @@ this.getFromRepo = function(msg, block, callback) { | ||
* events#getFromRepoIssues(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (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]+$ `. | ||
**/ | ||
@@ -140,8 +151,11 @@ this.getFromRepoIssues = function(msg, block, callback) { | ||
* events#getFromRepoNetwork(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (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]+$ `. | ||
**/ | ||
@@ -180,7 +194,10 @@ this.getFromRepoNetwork = function(msg, block, callback) { | ||
* events#getFromOrg(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (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]+$ `. | ||
**/ | ||
@@ -219,7 +236,10 @@ this.getFromOrg = function(msg, block, callback) { | ||
* events#getReceived(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -258,7 +278,10 @@ this.getReceived = function(msg, block, callback) { | ||
* events#getReceivedPublic(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -297,7 +320,10 @@ this.getReceivedPublic = function(msg, block, callback) { | ||
* events#getFromUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -336,7 +362,10 @@ this.getFromUser = function(msg, block, callback) { | ||
* events#getFromUserPublic(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -375,8 +404,11 @@ this.getFromUserPublic = function(msg, block, callback) { | ||
* events#getFromUserOrg(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param org (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - org (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]+$ `. | ||
**/ | ||
@@ -383,0 +415,0 @@ this.getFromUserOrg = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin gists | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,6 +24,9 @@ "use strict"; | ||
* gists#getAll(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -60,7 +65,10 @@ this.getAll = function(msg, block, callback) { | ||
* gists#getFromUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -99,7 +107,10 @@ this.getFromUser = function(msg, block, callback) { | ||
* gists#create(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param description (String): Optional. | ||
* - Param public (Boolean): Required. | ||
* - Param 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' | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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' | ||
**/ | ||
@@ -138,7 +149,10 @@ this.create = function(msg, block, callback) { | ||
* gists#edit(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param description (String): Optional. | ||
* - Param 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' | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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' | ||
**/ | ||
@@ -177,4 +191,8 @@ this.edit = function(msg, block, callback) { | ||
* gists#public(msg, callback) -> null | ||
* | ||
* No params. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* No params, simply pass an empty Object literal `{}` | ||
**/ | ||
@@ -213,4 +231,8 @@ this.public = function(msg, block, callback) { | ||
* gists#starred(msg, callback) -> null | ||
* | ||
* No params. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* No params, simply pass an empty Object literal `{}` | ||
**/ | ||
@@ -249,5 +271,8 @@ this.starred = function(msg, block, callback) { | ||
* gists#get(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -286,5 +311,8 @@ this.get = function(msg, block, callback) { | ||
* gists#star(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -323,5 +351,8 @@ this.star = function(msg, block, callback) { | ||
* gists#deleteStar(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -360,5 +391,8 @@ this.deleteStar = function(msg, block, callback) { | ||
* gists#checkStar(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -397,5 +431,8 @@ this.checkStar = function(msg, block, callback) { | ||
* gists#fork(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -434,5 +471,8 @@ this.fork = function(msg, block, callback) { | ||
* gists#delete(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -439,0 +479,0 @@ this.delete = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin gitdata | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,9 +24,12 @@ "use strict"; | ||
* gitdata#getBlob(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param sha (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - sha (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]+$ `. | ||
**/ | ||
@@ -63,8 +68,11 @@ this.getBlob = function(msg, block, callback) { | ||
* gitdata#createBlob(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param content (String): Required. | ||
* - Param encoding (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - content (String): Required. | ||
* - encoding (String): Required. | ||
**/ | ||
@@ -103,7 +111,10 @@ this.createBlob = function(msg, block, callback) { | ||
* gitdata#getCommit(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param sha (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - sha (String): Required. | ||
**/ | ||
@@ -142,11 +153,14 @@ this.getCommit = function(msg, block, callback) { | ||
* gitdata#createCommit(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param message (String): Required. String of the commit message | ||
* - Param tree (String): Required. String of the SHA of the tree object this commit points to | ||
* - Param 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. | ||
* - Param author (Json): Optional. | ||
* - Param committer (Json): Optional. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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. | ||
* - author (Json): Optional. | ||
* - committer (Json): Optional. | ||
**/ | ||
@@ -185,7 +199,10 @@ this.createCommit = function(msg, block, callback) { | ||
* gitdata#getReference(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param ref (String): Required. String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - ref (String): Required. String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected. | ||
**/ | ||
@@ -224,8 +241,11 @@ this.getReference = function(msg, block, callback) { | ||
* gitdata#getAllReferences(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (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]+$ `. | ||
**/ | ||
@@ -264,8 +284,11 @@ this.getAllReferences = function(msg, block, callback) { | ||
* gitdata#createReference(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param refs (String): Required. String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected. | ||
* - Param sha (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - refs (String): Required. String of the name of the fully qualified reference (ie: refs/heads/master). If it doesn’t start with ‘refs’ and have at least two slashes, it will be rejected. | ||
* - sha (String): Required. | ||
**/ | ||
@@ -304,8 +327,11 @@ this.createReference = function(msg, block, callback) { | ||
* gitdata#updateReference(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param sha (String): Required. | ||
* - Param force (Boolean): Required. 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. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - sha (String): Required. | ||
* - force (Boolean): Required. 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. | ||
**/ | ||
@@ -344,7 +370,10 @@ this.updateReference = function(msg, block, callback) { | ||
* gitdata#getTag(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param sha (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - sha (String): Required. | ||
**/ | ||
@@ -383,13 +412,16 @@ this.getTag = function(msg, block, callback) { | ||
* gitdata#createTag(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param tag (String): Required. String of the tag | ||
* - Param message (String): Required. String of the tag message | ||
* - Param object (String): Required. String of the SHA of the git object this is tagging | ||
* - Param 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. | ||
* - Param tagger.name (String): Required. String of the name of the author of the tag | ||
* - Param tagger.email (String): Required. String of the email of the author of the tag | ||
* - Param tagger.date (String): Required. Timestamp of when this object was tagged | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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.name (String): Required. String of the name of the author of the tag | ||
* - tagger.email (String): Required. String of the email of the author of the tag | ||
* - tagger.date (String): Required. Timestamp of when this object was tagged | ||
**/ | ||
@@ -428,8 +460,11 @@ this.createTag = function(msg, block, callback) { | ||
* gitdata#getTree(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param sha (String): Required. | ||
* - Param recursive (Boolean): Optional. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - sha (String): Required. | ||
* - recursive (Boolean): Optional. | ||
**/ | ||
@@ -468,7 +503,10 @@ this.getTree = function(msg, block, callback) { | ||
* gitdata#createTree(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param tree (Json): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - tree (Json): Required. | ||
**/ | ||
@@ -475,0 +513,0 @@ this.createTree = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
/** | ||
* Copyright 2012 Ajax.org Services B.V. | ||
* class Github | ||
* | ||
* A Node.JS module, which provides an object oriented wrapper for the GitHub v3 API. | ||
* | ||
* Copyright 2012 Ajax.org Services B.V. | ||
* | ||
* This product includes software developed by | ||
* Ajax.org Services B.V. (http://www.ajax.org/). | ||
* This product includes software developed by | ||
* Ajax.org Services B.V. (http://www.ajax.org/). | ||
* | ||
* Author: Mike de Boer <mike@ajax.org> | ||
*/ | ||
* Author: Mike de Boer <mike@ajax.org> | ||
**/ | ||
@@ -10,0 +14,0 @@ "use strict"; |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin issues | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,12 +24,15 @@ "use strict"; | ||
* issues#getAll(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param filter (String): Optional. Validation rule: ^(assigned|created|mentioned||subscribed)$. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high | ||
* - Param sort (String): Optional. Validation rule: ^(created|updated|comments)$. | ||
* - Param direction (String): Optional. Validation rule: ^(asc|desc)$. | ||
* - Param since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - filter (String): Optional. Validation rule: ` ^(assigned|created|mentioned||subscribed)$ `. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high | ||
* - sort (String): Optional. Validation rule: ` ^(created|updated|comments)$ `. | ||
* - direction (String): Optional. Validation rule: ` ^(asc|desc)$ `. | ||
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ | ||
* - 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]+$ `. | ||
**/ | ||
@@ -66,16 +71,19 @@ this.getAll = function(msg, block, callback) { | ||
* issues#repoIssues(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param milestone (String): Required. Validation rule: ^([0-9]+|none|\*)$. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param assignee (String): Required. String User login, `none` for Issues with no assigned User. `*` for Issues with any assigned User. | ||
* - Param mentioned (String): Optional. String User login. | ||
* - Param labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high | ||
* - Param sort (String): Optional. Validation rule: ^(created|updated|comments)$. | ||
* - Param direction (String): Optional. Validation rule: ^(asc|desc)$. | ||
* - Param since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - milestone (String): Required. Validation rule: ` ^([0-9]+|none|\*)$ `. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - assignee (String): Required. String User login, `none` for Issues with no assigned User. `*` for Issues with any assigned User. | ||
* - mentioned (String): Optional. String User login. | ||
* - labels (String): Optional. String list of comma separated Label names. Example: bug,ui,@high | ||
* - sort (String): Optional. Validation rule: ` ^(created|updated|comments)$ `. | ||
* - direction (String): Optional. Validation rule: ` ^(asc|desc)$ `. | ||
* - since (Date): Optional. Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ | ||
* - 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]+$ `. | ||
**/ | ||
@@ -114,7 +122,10 @@ this.repoIssues = function(msg, block, callback) { | ||
* issues#getRepoIssue(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -153,11 +164,14 @@ this.getRepoIssue = function(msg, block, callback) { | ||
* issues#create(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param title (String): Required. | ||
* - Param body (String): Optional. | ||
* - Param assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to. | ||
* - Param milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ^[0-9]+$. | ||
* - Param labels (Json): Required. Optional array of strings - Labels to associate with this issue. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - title (String): Required. | ||
* - body (String): Optional. | ||
* - assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to. | ||
* - milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ` ^[0-9]+$ `. | ||
* - labels (Json): Required. Optional array of strings - Labels to associate with this issue. | ||
**/ | ||
@@ -196,12 +210,15 @@ this.create = function(msg, block, callback) { | ||
* issues#edit(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param title (String): Required. | ||
* - Param body (String): Optional. | ||
* - Param assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to. | ||
* - Param milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ^[0-9]+$. | ||
* - Param labels (Json): Required. Optional array of strings - Labels to associate with this issue. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - title (String): Required. | ||
* - body (String): Optional. | ||
* - assignee (String): Optional. Optional string - Login for the user that this issue should be assigned to. | ||
* - milestone (Number): Optional. Optional number - Milestone to associate this issue with. Validation rule: ` ^[0-9]+$ `. | ||
* - labels (Json): Required. Optional array of strings - Labels to associate with this issue. | ||
**/ | ||
@@ -240,9 +257,12 @@ this.edit = function(msg, block, callback) { | ||
* issues#getComments(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -281,7 +301,10 @@ this.getComments = function(msg, block, callback) { | ||
* issues#getComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -320,8 +343,11 @@ this.getComment = function(msg, block, callback) { | ||
* issues#createComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param body (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - body (String): Required. | ||
**/ | ||
@@ -360,8 +386,11 @@ this.createComment = function(msg, block, callback) { | ||
* issues#editComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param body (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - body (String): Required. | ||
**/ | ||
@@ -400,7 +429,10 @@ this.editComment = function(msg, block, callback) { | ||
* issues#deleteComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -439,9 +471,12 @@ this.deleteComment = function(msg, block, callback) { | ||
* issues#getEvents(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -480,8 +515,11 @@ this.getEvents = function(msg, block, callback) { | ||
* issues#getRepoEvents(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (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]+$ `. | ||
**/ | ||
@@ -520,7 +558,10 @@ this.getRepoEvents = function(msg, block, callback) { | ||
* issues#getEvent(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -559,6 +600,9 @@ this.getEvent = function(msg, block, callback) { | ||
* issues#getLabels(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
**/ | ||
@@ -597,7 +641,10 @@ this.getLabels = function(msg, block, callback) { | ||
* issues#getLabel(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param name (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - name (String): Required. | ||
**/ | ||
@@ -636,8 +683,11 @@ this.getLabel = function(msg, block, callback) { | ||
* issues#createLabel(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param name (String): Required. | ||
* - Param color (String): Required. Required string - 6 character hex code, without a leading #. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - name (String): Required. | ||
* - color (String): Required. Required string - 6 character hex code, without a leading #. | ||
**/ | ||
@@ -676,8 +726,11 @@ this.createLabel = function(msg, block, callback) { | ||
* issues#updateLabel(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param name (String): Required. | ||
* - Param color (String): Required. Required string - 6 character hex code, without a leading #. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - name (String): Required. | ||
* - color (String): Required. Required string - 6 character hex code, without a leading #. | ||
**/ | ||
@@ -716,10 +769,13 @@ this.updateLabel = function(msg, block, callback) { | ||
* issues#getAllMilestones(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param sort (String): Optional. due_date, completeness, default: due_date Validation rule: ^(due_date|completeness)$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - sort (String): Optional. due_date, completeness, default: due_date Validation rule: ` ^(due_date|completeness)$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -758,7 +814,10 @@ this.getAllMilestones = function(msg, block, callback) { | ||
* issues#getMilestone(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -797,10 +856,13 @@ this.getMilestone = function(msg, block, callback) { | ||
* issues#createMilestone(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param title (String): Required. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param description (String): Optional. | ||
* - Param due_on (Date): Optional. Optional string - ISO 8601 time. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - title (String): Required. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - description (String): Optional. | ||
* - due_on (Date): Optional. Optional string - ISO 8601 time. | ||
**/ | ||
@@ -839,11 +901,14 @@ this.createMilestone = function(msg, block, callback) { | ||
* issues#updateMilestone(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param title (String): Required. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param description (String): Optional. | ||
* - Param due_on (Date): Optional. Optional string - ISO 8601 time. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - title (String): Required. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - description (String): Optional. | ||
* - due_on (Date): Optional. Optional string - ISO 8601 time. | ||
**/ | ||
@@ -882,7 +947,10 @@ this.updateMilestone = function(msg, block, callback) { | ||
* issues#deleteMilestone(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -889,0 +957,0 @@ this.deleteMilestone = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin orgs | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,7 +24,10 @@ "use strict"; | ||
* orgs#getFromUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -61,7 +66,10 @@ this.getFromUser = function(msg, block, callback) { | ||
* orgs#get(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (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]+$ `. | ||
**/ | ||
@@ -100,10 +108,13 @@ this.get = function(msg, block, callback) { | ||
* orgs#update(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param billing_email (String): Optional. Optional string - Billing email address. This address is not publicized. | ||
* - Param company (String): Optional. | ||
* - Param email (String): Optional. Optional string - Publicly visible email address. | ||
* - Param location (String): Optional. | ||
* - Param name (String): Optional. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - billing_email (String): Optional. Optional string - Billing email address. This address is not publicized. | ||
* - company (String): Optional. | ||
* - email (String): Optional. Optional string - Publicly visible email address. | ||
* - location (String): Optional. | ||
* - name (String): Optional. | ||
**/ | ||
@@ -142,7 +153,10 @@ this.update = function(msg, block, callback) { | ||
* orgs#getMembers(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (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]+$ `. | ||
**/ | ||
@@ -181,6 +195,9 @@ this.getMembers = function(msg, block, callback) { | ||
* orgs#getMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - user (String): Required. | ||
**/ | ||
@@ -219,6 +236,9 @@ this.getMember = function(msg, block, callback) { | ||
* orgs#removeMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - user (String): Required. | ||
**/ | ||
@@ -257,5 +277,8 @@ this.removeMember = function(msg, block, callback) { | ||
* orgs#getPublicMembers(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
**/ | ||
@@ -294,6 +317,9 @@ this.getPublicMembers = function(msg, block, callback) { | ||
* orgs#getPublicMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - user (String): Required. | ||
**/ | ||
@@ -332,6 +358,9 @@ this.getPublicMember = function(msg, block, callback) { | ||
* orgs#publicizeMembership(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - user (String): Required. | ||
**/ | ||
@@ -370,6 +399,9 @@ this.publicizeMembership = function(msg, block, callback) { | ||
* orgs#concealMembership(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - user (String): Required. | ||
**/ | ||
@@ -408,5 +440,8 @@ this.concealMembership = function(msg, block, callback) { | ||
* orgs#getTeams(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
**/ | ||
@@ -445,5 +480,8 @@ this.getTeams = function(msg, block, callback) { | ||
* orgs#getTeam(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -482,8 +520,11 @@ this.getTeam = function(msg, block, callback) { | ||
* orgs#createTeam(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param org (String): Required. | ||
* - Param name (String): Required. | ||
* - Param repo_names (Array): Optional. Optional array of strings | ||
* - Param permission (String): Optional. `pull` - team members can pull, but not push or administer this repositories (Default), `push` - team members can pull and push, but not administer this repositores, `admin` - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - org (String): Required. | ||
* - name (String): Required. | ||
* - repo_names (Array): Optional. Optional array of strings | ||
* - permission (String): Optional. `pull` - team members can pull, but not push or administer this repositories (Default), `push` - team members can pull and push, but not administer this repositores, `admin` - team members can pull, push and administer these repositories. Validation rule: ` ^(pull|push|admin)$ `. | ||
**/ | ||
@@ -522,7 +563,10 @@ this.createTeam = function(msg, block, callback) { | ||
* orgs#updateTeam(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param name (String): Required. | ||
* - Param permission (String): Optional. `pull` - team members can pull, but not push or administer this repositories (Default), `push` - team members can pull and push, but not administer this repositores, `admin` - team members can pull, push and administer these repositories. Validation rule: ^(pull|push|admin)$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - name (String): Required. | ||
* - permission (String): Optional. `pull` - team members can pull, but not push or administer this repositories (Default), `push` - team members can pull and push, but not administer this repositores, `admin` - team members can pull, push and administer these repositories. Validation rule: ` ^(pull|push|admin)$ `. | ||
**/ | ||
@@ -561,5 +605,8 @@ this.updateTeam = function(msg, block, callback) { | ||
* orgs#deleteTeam(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -598,7 +645,10 @@ this.deleteTeam = function(msg, block, callback) { | ||
* orgs#getTeamMembers(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -637,6 +687,9 @@ this.getTeamMembers = function(msg, block, callback) { | ||
* orgs#getTeamMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
**/ | ||
@@ -675,6 +728,9 @@ this.getTeamMember = function(msg, block, callback) { | ||
* orgs#addTeamMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
**/ | ||
@@ -713,6 +769,9 @@ this.addTeamMember = function(msg, block, callback) { | ||
* orgs#deleteTeamMember(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
**/ | ||
@@ -751,7 +810,10 @@ this.deleteTeamMember = function(msg, block, callback) { | ||
* orgs#getTeamRepos(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -790,7 +852,10 @@ this.getTeamRepos = function(msg, block, callback) { | ||
* orgs#getTeamRepo(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
**/ | ||
@@ -829,7 +894,10 @@ this.getTeamRepo = function(msg, block, callback) { | ||
* orgs#addTeamRepo(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
**/ | ||
@@ -868,7 +936,10 @@ this.addTeamRepo = function(msg, block, callback) { | ||
* orgs#deleteTeamRepo(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
**/ | ||
@@ -875,0 +946,0 @@ this.deleteTeamRepo = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin pullRequests | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,9 +24,12 @@ "use strict"; | ||
* pullRequests#getAll(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -63,7 +68,10 @@ this.getAll = function(msg, block, callback) { | ||
* pullRequests#get(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -102,10 +110,13 @@ this.get = function(msg, block, callback) { | ||
* pullRequests#create(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param title (String): Required. | ||
* - Param body (String): Optional. | ||
* - Param base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. | ||
* - Param head (String): Required. Required string - The branch (or git ref) where your changes are implemented. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - title (String): Required. | ||
* - body (String): Optional. | ||
* - base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. | ||
* - head (String): Required. Required string - The branch (or git ref) where your changes are implemented. | ||
**/ | ||
@@ -144,9 +155,12 @@ this.create = function(msg, block, callback) { | ||
* pullRequests#createFromIssue(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param issue (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. | ||
* - Param head (String): Required. Required string - The branch (or git ref) where your changes are implemented. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - issue (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - base (String): Required. Required string - The branch (or git ref) you want your changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repo that requests a merge to a base of another repo. | ||
* - head (String): Required. Required string - The branch (or git ref) where your changes are implemented. | ||
**/ | ||
@@ -185,10 +199,13 @@ this.createFromIssue = function(msg, block, callback) { | ||
* pullRequests#update(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param state (String): Optional. Validation rule: ^(open|closed)$. | ||
* - Param title (String): Required. | ||
* - Param body (String): Optional. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - state (String): Optional. Validation rule: ` ^(open|closed)$ `. | ||
* - title (String): Required. | ||
* - body (String): Optional. | ||
**/ | ||
@@ -227,9 +244,12 @@ this.update = function(msg, block, callback) { | ||
* pullRequests#getCommits(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -268,9 +288,12 @@ this.getCommits = function(msg, block, callback) { | ||
* pullRequests#getFiles(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -309,9 +332,12 @@ this.getFiles = function(msg, block, callback) { | ||
* pullRequests#getMerged(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -350,8 +376,11 @@ this.getMerged = function(msg, block, callback) { | ||
* pullRequests#merge(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param commit_message (String): Optional. Optional string - The message that will be used for the merge commit | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - commit_message (String): Optional. Optional string - The message that will be used for the merge commit | ||
**/ | ||
@@ -390,9 +419,12 @@ this.merge = function(msg, block, callback) { | ||
* pullRequests#getComments(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - 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]+$ `. | ||
**/ | ||
@@ -431,7 +463,10 @@ this.getComments = function(msg, block, callback) { | ||
* pullRequests#getComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -470,11 +505,14 @@ this.getComment = function(msg, block, callback) { | ||
* pullRequests#createComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param body (String): Required. | ||
* - Param commit_id (String): Required. Required string - Sha of the commit to comment on. | ||
* - Param path (String): Required. Required string - Relative path of the file to comment on. | ||
* - Param position (Number): Required. Required number - Column index in the diff to comment on. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - body (String): Required. | ||
* - commit_id (String): Required. Required string - Sha of the commit to comment on. | ||
* - path (String): Required. Required string - Relative path of the file to comment on. | ||
* - position (Number): Required. Required number - Column index in the diff to comment on. | ||
**/ | ||
@@ -513,9 +551,12 @@ this.createComment = function(msg, block, callback) { | ||
* pullRequests#createCommentReply(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param body (String): Required. | ||
* - Param in_reply_to (Number): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - body (String): Required. | ||
* - in_reply_to (Number): Required. | ||
**/ | ||
@@ -554,8 +595,11 @@ this.createCommentReply = function(msg, block, callback) { | ||
* pullRequests#updateComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param body (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - body (String): Required. | ||
**/ | ||
@@ -594,7 +638,10 @@ this.updateComment = function(msg, block, callback) { | ||
* pullRequests#deleteComment(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param repo (String): Required. | ||
* - Param number (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
* - repo (String): Required. | ||
* - number (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -601,0 +648,0 @@ this.deleteComment = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -137,3 +137,3 @@ * | ||
"test: undefined /repos/:user/:repo (get)": function(next) { | ||
"test: GET /repos/:user/:repo (get)": function(next) { | ||
var self = this; | ||
@@ -310,3 +310,3 @@ this.client.authenticate({ | ||
"test: /repos/:user/:repo/collaborators/:collabuser (getCollaborator)": function(next) { | ||
"test: GET /repos/:user/:repo/collaborators/:collabuser (getCollaborator)": function(next) { | ||
var self = this; | ||
@@ -394,3 +394,3 @@ this.client.authenticate({ | ||
"test: /repos/:user/:repo/commits/:sha (getCommit)": function(next) { | ||
"test: GET /repos/:user/:repo/commits/:sha (getCommit)": function(next) { | ||
var self = this; | ||
@@ -436,3 +436,3 @@ this.client.authenticate({ | ||
"test: /repos/:user/:repo/commits/:sha/comments (getCommitComments)": function(next) { | ||
"test: GET /repos/:user/:repo/commits/:sha/comments (getCommitComments)": function(next) { | ||
var self = this; | ||
@@ -731,3 +731,3 @@ this.client.authenticate({ | ||
"test: /repos/:user/:repo/keys/:id (updateKey)": function(next) { | ||
"test: PUT /repos/:user/:repo/keys/:id (updateKey)": function(next) { | ||
var self = this; | ||
@@ -834,3 +834,3 @@ this.client.authenticate({ | ||
"test: /user/watched/:user/:repo (getWatching)": function(next) { | ||
"test: GET /user/watched/:user/:repo (getWatching)": function(next) { | ||
var self = this; | ||
@@ -837,0 +837,0 @@ this.client.authenticate({ |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin user | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -22,5 +24,8 @@ "use strict"; | ||
* user#getFrom(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
**/ | ||
@@ -59,4 +64,8 @@ this.getFrom = function(msg, block, callback) { | ||
* user#get(msg, callback) -> null | ||
* | ||
* No params. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* No params, simply pass an empty Object literal `{}` | ||
**/ | ||
@@ -95,11 +104,14 @@ this.get = function(msg, block, callback) { | ||
* user#update(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param name (String): Optional. | ||
* - Param email (String): Optional. | ||
* - Param blog (String): Optional. | ||
* - Param company (String): Optional. | ||
* - Param location (String): Optional. | ||
* - Param hireable (Boolean): Optional. | ||
* - Param bio (String): Optional. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - name (String): Optional. | ||
* - email (String): Optional. | ||
* - blog (String): Optional. | ||
* - company (String): Optional. | ||
* - location (String): Optional. | ||
* - hireable (Boolean): Optional. | ||
* - bio (String): Optional. | ||
**/ | ||
@@ -138,6 +150,9 @@ this.update = function(msg, block, callback) { | ||
* user#getEmails(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -176,4 +191,8 @@ this.getEmails = function(msg, block, callback) { | ||
* user#addEmails(msg, callback) -> null | ||
* | ||
* No params. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* No params, simply pass an empty Object literal `{}` | ||
**/ | ||
@@ -212,4 +231,8 @@ this.addEmails = function(msg, block, callback) { | ||
* user#deleteEmails(msg, callback) -> null | ||
* | ||
* No params. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* No params, simply pass an empty Object literal `{}` | ||
**/ | ||
@@ -248,7 +271,10 @@ this.deleteEmails = function(msg, block, callback) { | ||
* user#getFollowers(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -287,7 +313,10 @@ this.getFollowers = function(msg, block, callback) { | ||
* user#getFollowingFromUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -326,6 +355,9 @@ this.getFollowingFromUser = function(msg, block, callback) { | ||
* user#getFollowing(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -364,7 +396,10 @@ this.getFollowing = function(msg, block, callback) { | ||
* user#getFollowUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -403,5 +438,8 @@ this.getFollowUser = function(msg, block, callback) { | ||
* user#followUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
**/ | ||
@@ -440,5 +478,8 @@ this.followUser = function(msg, block, callback) { | ||
* user#unFollowUser(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param user (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - user (String): Required. | ||
**/ | ||
@@ -477,6 +518,9 @@ this.unFollowUser = function(msg, block, callback) { | ||
* user#getKeys(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param page (Number): Optional. Page number of the results to fetch. Validation rule: ^[0-9]+$. | ||
* - Param per_page (Number): Optional. A custom page size up to 100. Default is 30. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - 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]+$ `. | ||
**/ | ||
@@ -515,5 +559,8 @@ this.getKeys = function(msg, block, callback) { | ||
* user#getKey(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -552,6 +599,9 @@ this.getKey = function(msg, block, callback) { | ||
* user#createKey(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param title (String): Required. | ||
* - Param key (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - title (String): Required. | ||
* - key (String): Required. | ||
**/ | ||
@@ -590,7 +640,10 @@ this.createKey = function(msg, block, callback) { | ||
* user#updateKey(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - Param title (String): Required. | ||
* - Param key (String): Required. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
* - title (String): Required. | ||
* - key (String): Required. | ||
**/ | ||
@@ -629,5 +682,8 @@ this.updateKey = function(msg, block, callback) { | ||
* user#deleteKey(msg, callback) -> null | ||
* | ||
* Params on the `msg` object: | ||
* - Param id (Number): Required. Validation rule: ^[0-9]+$. | ||
* - msg (Object): Object that contains the parameters and their values to be sent to the server. | ||
* - callback (Function): function to call when the request is finished with an error as first argument and result data as second argument. | ||
* | ||
* ##### Params on the `msg` object: | ||
* | ||
* - id (Number): Required. Validation rule: ` ^[0-9]+$ `. | ||
**/ | ||
@@ -634,0 +690,0 @@ this.deleteKey = function(msg, block, callback) { |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
@@ -44,8 +44,11 @@ /** | ||
indent + " * " + section + "#" + funcName + "(msg, callback) -> null", | ||
indent + " *", | ||
(params.length | ||
? indent + " * Params on the `msg` object:" | ||
: indent + " * No params." | ||
) | ||
indent + " * - msg (Object): Object that contains the parameters and their values to be sent to the server.", | ||
indent + " * - callback (Function): function to call when the request is finished " + | ||
"with an error as first argument and result data as second argument.", | ||
indent + " * ", | ||
indent + " * ##### Params on the `msg` object:", | ||
indent + " * " | ||
]; | ||
if (!params.length) | ||
comment.push(indent + " * No params, simply pass an empty Object literal `{}`"); | ||
var paramName, def, line; | ||
@@ -57,4 +60,4 @@ for (var i = 0, l = params.length; i < l; ++i) { | ||
if (!defines.params[paramName]) { | ||
Util.log("Invalid variable parameter name substitution; param '" + paramName | ||
+ "' not found in defines block", "fatal"); | ||
Util.log("Invalid variable parameter name substitution; param '" + | ||
paramName + "' not found in defines block", "fatal"); | ||
process.exit(1); | ||
@@ -68,3 +71,3 @@ } | ||
line = indent + " * - Param " + paramName + " (" + (def.type || "mixed") + "): " + | ||
line = indent + " * - " + paramName + " (" + (def.type || "mixed") + "): " + | ||
(def.required ? "Required. " : "Optional. "); | ||
@@ -74,3 +77,3 @@ if (def.description) | ||
if (def.validation) | ||
line += "Validation rule: " + def.validation + "."; | ||
line += "Validation rule: ` " + def.validation + " `."; | ||
@@ -122,2 +125,7 @@ comment.push(line); | ||
var section = Util.toCamelCase(parts[1].toLowerCase()); | ||
if (!block.method) { | ||
throw new Error("No HTTP method specified for " + messageType + | ||
"in section " + section); | ||
} | ||
parts.splice(0, 2); | ||
@@ -168,3 +176,6 @@ var funcName = Util.toCamelCase(parts.join("-")); | ||
Fs.writeFileSync(dir + "/index.js", | ||
IndexTpl.replace("<%scripts%>", "\"" + sectionNames.join("\", \"") + "\""), | ||
IndexTpl | ||
.replace("<%name%>", defines.constants.name) | ||
.replace("<%description%>", defines.constants.description) | ||
.replace("<%scripts%>", "\"" + sectionNames.join("\", \"") + "\""), | ||
"utf8"); | ||
@@ -171,0 +182,0 @@ |
{ | ||
"name" : "node-github", | ||
"version" : "0.0.1", | ||
"version" : "0.0.2", | ||
"description" : "Wrapper for the GitHub API", | ||
@@ -5,0 +5,0 @@ "author": "Mike de Boer <mike@c9.io>", |
@@ -19,2 +19,9 @@ # JavaScript GitHub API for Node.JS | ||
## Documentation | ||
You can find the docs for the API of this client at [http://c9.github.com/node-github3/](http://c9.github.com/node-github3/) | ||
Additionally, the [official Github documentation](http://developer.github.com/) | ||
is a very useful resource. | ||
## Example | ||
@@ -104,4 +111,3 @@ | ||
* generate API documentation | ||
* Documentation | ||
* generate Client documentation | ||
@@ -108,0 +114,0 @@ ## LICENSE |
/** | ||
* Copyright 2012 Ajax.org Services B.V. | ||
* class <%name%> | ||
* | ||
* <%description%> | ||
* | ||
* Copyright 2012 Ajax.org Services B.V. | ||
* | ||
* This product includes software developed by | ||
* Ajax.org Services B.V. (http://www.ajax.org/). | ||
* This product includes software developed by | ||
* Ajax.org Services B.V. (http://www.ajax.org/). | ||
* | ||
* Author: Mike de Boer <mike@ajax.org> | ||
*/ | ||
* Author: Mike de Boer <mike@ajax.org> | ||
**/ | ||
@@ -10,0 +14,0 @@ "use strict"; |
@@ -1,9 +0,11 @@ | ||
/** | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
/** | ||
* mixin <%sectionName%> | ||
* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
* | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* This product includes software developed by | ||
* Cloud9 IDE, Inc (http://c9.io). | ||
* | ||
* Author: Mike de Boer <mike@c9.io> | ||
*/ | ||
* Author: Mike de Boer <mike@c9.io> | ||
**/ | ||
@@ -10,0 +12,0 @@ "use strict"; |
@@ -1,2 +0,2 @@ | ||
/** | ||
/* | ||
* Copyright 2012 Cloud9 IDE, Inc. | ||
@@ -3,0 +3,0 @@ * |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
468440
12742
115