Skip to content

Commit

Permalink
Remove overview headers from documentation
Browse files Browse the repository at this point in the history
Remove headers from documentation files indicating what each resource is.  This data can be pulled from the online Trello API documentation.
  • Loading branch information
mikerourke committed Jul 4, 2017
1 parent 83f8559 commit cf3c083
Show file tree
Hide file tree
Showing 13 changed files with 0 additions and 195 deletions.
25 changes: 0 additions & 25 deletions internals/api-docs/resources/action.js
Original file line number Diff line number Diff line change
@@ -1,28 +1,3 @@
/**
* @api {path} /actions action
* @apiVersion 1.0.0
* @apiName action
* @apiGroup overview
* @apiDescription
* Actions are generated whenever an action occurs in Trello.
* For instance, when a user deletes a card, a <code>deleteCard</code> action
* is generated and includes information about the deleted card, the list the
* card was in, the board the card was on, the user that deleted the card,
* and the <code>idObject</code> of the action. Actions for Trello objects
* can be listed from nested action endpoints - e.g. the resource
* <code>GET board/:boardId/actions</code> lists all of the actions for the
* given board.
* <br><br>
* Note: Due to the number of actions that occur in Trello, nested action
* resources filter out specific action types. For example, changing the
* name of a checklistItem will trigger a webhook on the board and will
* POST an action of type updateCheckItem with the old and new name of the
* checklistItem. However, no nested actions resource will return action
* types of updateCheckItem: /cards/idCard/actions/,
* /boards/idBoard/actions/. However you can get that specific action
* instance via GET /actions/idAction/.
*/

/**
* @api {get} /actions/:actionId getAction
* @apiVersion 1.0.0
Expand Down
15 changes: 0 additions & 15 deletions internals/api-docs/resources/batch.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
/**
* @api {path} /batch batch
* @apiVersion 1.0.0
* @apiName batch
* @apiGroup overview
* @apiDescription
* The batch endpoint allows you to make multiple <code>GET</code> requests
* to the Trello API in a single request. By batching <code>GET</code>
* requests together, you can reduce the volume of calls you are making to
* the API and more easily stay within your API rate limit.
* <br><br>
* The batch endpoint can not be called recursively; requests containing the
* batch url will be ignored.
*/

/**
* @api {get} /batch makeRequests
* @apiVersion 1.0.0
Expand Down
17 changes: 0 additions & 17 deletions internals/api-docs/resources/board.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,3 @@
/**
* @api {path} /boards board
* @apiVersion 1.0.0
* @apiName board
* @apiGroup overview
* @apiDescription
* Boards are the highest level concept within the Trello workflow. The
* Boards API allows you to list, view, create, and edit Boards. Each Board
* has a name, description, a set of members attached, and an ordered array
* of Lists.
* <br><br>
* Boards can be open or closed, starred, and/or subscribed. Each
* Board belongs to an organization. Each board also has a set of preferences
* that affect its visual display, and additional features that may have been
* attached to the Board (such as Power-Ups).
*/

/**
* @api {get} /boards/:boardId getBoard
* @apiVersion 1.0.0
Expand Down
25 changes: 0 additions & 25 deletions internals/api-docs/resources/card.js
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>
*/
9 changes: 0 additions & 9 deletions internals/api-docs/resources/checklist.js
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.
*/
16 changes: 0 additions & 16 deletions internals/api-docs/resources/label.js
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.
*/


10 changes: 0 additions & 10 deletions internals/api-docs/resources/list.js
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.
*/

11 changes: 0 additions & 11 deletions internals/api-docs/resources/member.js
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.
*/

16 changes: 0 additions & 16 deletions internals/api-docs/resources/organization.js
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.
*/

18 changes: 0 additions & 18 deletions internals/api-docs/resources/search.js
Original file line number Diff line number Diff line change
@@ -1,21 +1,3 @@
/**
* @api {path} /search search
* @apiVersion 1.0.0
* @apiName search
* @apiGroup overview
* @apiDescription
* The Search API allows you to perform the same search that is available
* within Trello at the top of the window. This means that you can use
* modifiers such as <strong>edited:day</strong> within the query to modify
* the results you get back. For more information on modifiers, click
* "Learn More" within the Trello search popup.
* <br><br>
* Certain types of modifiers will restrict the types of objects that are
* returned with your search. One example of this is the
* <strong>edited</strong> modifier which will meant that your search will
* only contain <strong>Cards</strong>.
*/

// @todo: Add missing parameter information.
/**
* @api {get} /search performSearch
Expand Down
9 changes: 0 additions & 9 deletions internals/api-docs/resources/token.js
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.
*/
10 changes: 0 additions & 10 deletions internals/api-docs/resources/type.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
/**
* @api {path} /types type
* @apiVersion 1.0.0
* @apiName type
* @apiGroup overview
* @apiDescription
* The type endpoint allows you to determine if the specified ID, team, or
* username is a member or an organization.
*/

/**
* @api {get} /types/:teamOrUserId getType
* @apiVersion 1.0.0
Expand Down
14 changes: 0 additions & 14 deletions internals/api-docs/resources/webhook.js
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.
*/

0 comments on commit cf3c083

Please sign in to comment.