-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove overview headers from documentation
Remove headers from documentation files indicating what each resource is. This data can be pulled from the online Trello API documentation.
- Loading branch information
1 parent
83f8559
commit cf3c083
Showing
13 changed files
with
0 additions
and
195 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +0,0 @@ | ||
/** | ||
* @api {path} /cards card | ||
* @apiVersion 1.0.0 | ||
* @apiName card | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A Card is the most basic unit of information in Trello. Cards have a name, | ||
* description, labels, members, and a set of historical actions that have | ||
* been taken on the card, including any comments. | ||
* <h3>Child Methods</h3> | ||
* <ul> | ||
* <li> | ||
* <h4>Actions</h4> | ||
* Actions are the audit log/record of everything that has been | ||
* done to a card throughout its history, including any comments that | ||
* have been made. | ||
* </li> | ||
* <br> | ||
* <li> | ||
* <h4>Labels</h4> | ||
* Labels can be as simple as colors attached to a Card, or Labels can | ||
* have names. | ||
* </li> | ||
* </ul> | ||
*/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +0,0 @@ | ||
/** | ||
* @api {path} /checklists checklist | ||
* @apiVersion 1.0.0 | ||
* @apiName checklist | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A checklist is a way of keeping track of subtasks within a card. You can | ||
* add multiple checklists to a single card. | ||
*/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +0,0 @@ | ||
/** | ||
* @api {path} /labels label | ||
* @apiVersion 1.0.0 | ||
* @apiName label | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A label is a way of categorizing a card by type, represented by a color | ||
* and term or, for colorless labels, a term only. There are 10 label colors | ||
* to choose from in Trello, and a colorless label option. You can choose | ||
* to add label names if you wish. A single card can have multiple labels. | ||
* Colored labels will display on the front and back of a card, and colorless | ||
* labels (represented by the light gray color) will display on the back of | ||
* the card. Label names will only show on the back of the card. | ||
*/ | ||
|
||
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +0,0 @@ | ||
/** | ||
* @api {path} /lists list | ||
* @apiVersion 1.0.0 | ||
* @apiName list | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A List is a collection of Cards. In the standard Trello interface, Lists | ||
* are stacked horizontally and are ordered on a board. | ||
*/ | ||
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +0,0 @@ | ||
/** | ||
* @api {path} /members member | ||
* @apiVersion 1.0.0 | ||
* @apiName member | ||
* @apiGroup overview | ||
* @apiDescription | ||
* Members represent people that are on the team associated with a board. | ||
* They have a permission level ("Admin" or "Normal"), that controls the | ||
* changes they are able to make to a board. | ||
*/ | ||
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +0,0 @@ | ||
/** | ||
* @api {path} /organizations organization | ||
* @apiVersion 1.0.0 | ||
* @apiName organization | ||
* @apiGroup overview | ||
* @apiDescription | ||
* RESTful endpoints that point to <code>organizations</code> refer to the | ||
* Trello concept of Teams. | ||
* <br><br> | ||
* Trello offers the option to create teams, and to set your boards so that | ||
* they belong to those teams. Just like boards, teams can have members | ||
* (including team admins and normal team members). There are no limits to | ||
* the number of members you can have in a team, or the number of teams you | ||
* can belong to in a single account. | ||
*/ | ||
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +0,0 @@ | ||
/** | ||
* @api {path} /tokens token | ||
* @apiVersion 1.0.0 | ||
* @apiName token | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A Token is used primarily for dealing with webhooks. A Token is required | ||
* to utilize the API. | ||
*/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +0,0 @@ | ||
/** | ||
* @api {path} /webhooks webhook | ||
* @apiVersion 1.0.0 | ||
* @apiName webhook | ||
* @apiGroup overview | ||
* @apiDescription | ||
* A developer could theoretically parse a user's Boards, Lists, and Cards in | ||
* order to get all of the information, but this would mean loading a lot of | ||
* data that doesn't change very often, using more bandwidth, CPU, and RAM | ||
* for both you and for our servers. To mitigate this we have built a system | ||
* that allows your application to hook into updates on various members such | ||
* as Boards, Lists, and Cards. Whenever a member with a Webhook is changed, | ||
* we make an HTTP request to the endpoint of your choosing. | ||
*/ | ||