diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-01-23 12:33:52 -0500 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-01-23 12:33:52 -0500 |
commit | f4468bc0b65723a308135984306270a5ac4986a5 (patch) | |
tree | 30da86cef0a081fdf227958d8380da9256032d71 /doc | |
parent | ba5937b07490160affad8239a7a9e6227979f770 (diff) |
Change title heading level for API doc
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api-action-procedures.markdown | 12 | ||||
-rw-r--r-- | doc/api-application-procedures.markdown | 14 | ||||
-rw-r--r-- | doc/api-board-procedures.markdown | 16 | ||||
-rw-r--r-- | doc/api-category-procedures.markdown | 10 | ||||
-rw-r--r-- | doc/api-comment-procedures.markdown | 10 | ||||
-rw-r--r-- | doc/api-file-procedures.markdown | 12 | ||||
-rw-r--r-- | doc/api-group-member-procedures.markdown | 8 | ||||
-rw-r--r-- | doc/api-group-procedures.markdown | 10 | ||||
-rw-r--r-- | doc/api-link-procedures.markdown | 24 | ||||
-rw-r--r-- | doc/api-me-procedures.markdown | 14 | ||||
-rw-r--r-- | doc/api-project-permission-procedures.markdown | 16 | ||||
-rw-r--r-- | doc/api-project-procedures.markdown | 24 | ||||
-rw-r--r-- | doc/api-subtask-procedures.markdown | 10 | ||||
-rw-r--r-- | doc/api-swimlane-procedures.markdown | 26 | ||||
-rw-r--r-- | doc/api-task-procedures.markdown | 26 | ||||
-rw-r--r-- | doc/api-user-procedures.markdown | 12 |
16 files changed, 122 insertions, 122 deletions
diff --git a/doc/api-action-procedures.markdown b/doc/api-action-procedures.markdown index 67bd85de..377ca56a 100644 --- a/doc/api-action-procedures.markdown +++ b/doc/api-action-procedures.markdown @@ -1,7 +1,7 @@ API Automatic Actions Procedures ================================ -### getAvailableActions +## getAvailableActions - Purpose: **Get list of available automatic actions** - Parameters: none @@ -47,7 +47,7 @@ Response example: } ``` -### getAvailableActionEvents +## getAvailableActionEvents - Purpose: **Get list of available events for actions** - Parameters: none @@ -93,7 +93,7 @@ Response example: } ``` -### getCompatibleActionEvents +## getCompatibleActionEvents - Purpose: **Get list of events compatible with an action** - Parameters: @@ -131,7 +131,7 @@ Response example: } ``` -### getActions +## getActions - Purpose: **Get list of actions for a project** - Parameters: @@ -173,7 +173,7 @@ Response example: } ``` -### createAction +## createAction - Purpose: **Create an action** - Parameters: @@ -213,7 +213,7 @@ Response example: } ``` -### removeAction +## removeAction - Purpose: **Remove an action** - Parameters: diff --git a/doc/api-application-procedures.markdown b/doc/api-application-procedures.markdown index 2897b526..08474559 100644 --- a/doc/api-application-procedures.markdown +++ b/doc/api-application-procedures.markdown @@ -1,7 +1,7 @@ API Application Procedures ========================== -### getVersion +## getVersion - Purpose: **Get the application version** - Parameters: none @@ -27,7 +27,7 @@ Response example: } ``` -### getTimezone +## getTimezone - Purpose: **Get the application timezone** - Parameters: none @@ -54,7 +54,7 @@ Response example: } ``` -### getDefaultTaskColors +## getDefaultTaskColors - Purpose: **Get all default task colors** - Parameters: None @@ -161,7 +161,7 @@ Response example: } ``` -### getDefaultTaskColor +## getDefaultTaskColor - Purpose: **Get default task color** - Parameters: None @@ -187,7 +187,7 @@ Response example: } ``` -### getColorList +## getColorList - Purpose: **Get the list of task colors** - Parameters: none @@ -230,7 +230,7 @@ Response example: } ``` -### getApplicationRoles +## getApplicationRoles - Purpose: **Get the application roles** - Parameters: none @@ -260,7 +260,7 @@ Response example: } ``` -### getProjectRoles +## getProjectRoles - Purpose: **Get the project roles** - Parameters: none diff --git a/doc/api-board-procedures.markdown b/doc/api-board-procedures.markdown index 8643fa75..d8503d6d 100644 --- a/doc/api-board-procedures.markdown +++ b/doc/api-board-procedures.markdown @@ -1,7 +1,7 @@ API Board Procedures ==================== -### getBoard +## getBoard - Purpose: **Get all necessary information to display a board** - Parameters: @@ -157,7 +157,7 @@ Response example: } ``` -### getColumns +## getColumns - Purpose: **Get all columns information for a given project** - Parameters: @@ -210,7 +210,7 @@ Response example: } ``` -### getColumn +## getColumn - Purpose: **Get a single column** - Parameters: @@ -247,7 +247,7 @@ Response example: } ``` -### moveColumnUp +## moveColumnUp - Purpose: **Move up the column position** - Parameters: @@ -280,7 +280,7 @@ Response example: } ``` -### moveColumnDown +## moveColumnDown - Purpose: **Move down the column position** - Parameters: @@ -313,7 +313,7 @@ Response example: } ``` -### updateColumn +## updateColumn - Purpose: **Update column properties** - Parameters: @@ -349,7 +349,7 @@ Response example: } ``` -### addColumn +## addColumn - Purpose: **Add a new column** - Parameters: @@ -384,7 +384,7 @@ Response example: } ``` -### removeColumn +## removeColumn - Purpose: **Remove a column** - Parameters: diff --git a/doc/api-category-procedures.markdown b/doc/api-category-procedures.markdown index 6a762009..644c09c6 100644 --- a/doc/api-category-procedures.markdown +++ b/doc/api-category-procedures.markdown @@ -1,7 +1,7 @@ API Category Procedures ======================= -### createCategory +## createCategory - Purpose: **Create a new category** - Parameters: @@ -34,7 +34,7 @@ Response example: } ``` -### getCategory +## getCategory - Purpose: **Get category information** - Parameters: @@ -70,7 +70,7 @@ Response example: } ``` -### getAllCategories +## getAllCategories - Purpose: **Get all available categories** - Parameters: @@ -107,7 +107,7 @@ Response example: } ``` -### updateCategory +## updateCategory - Purpose: **Update a category** - Parameters: @@ -140,7 +140,7 @@ Response example: } ``` -### removeCategory +## removeCategory - Purpose: **Remove a category** - Parameters: diff --git a/doc/api-comment-procedures.markdown b/doc/api-comment-procedures.markdown index 33a856ea..5ac25b13 100644 --- a/doc/api-comment-procedures.markdown +++ b/doc/api-comment-procedures.markdown @@ -1,7 +1,7 @@ API Comment Procedures ====================== -### createComment +## createComment - Purpose: **Create a new comment** - Parameters: @@ -36,7 +36,7 @@ Response example: } ``` -### getComment +## getComment - Purpose: **Get comment information** - Parameters: @@ -75,7 +75,7 @@ Response example: } ``` -### getAllComments +## getAllComments - Purpose: **Get all available comments** - Parameters: @@ -117,7 +117,7 @@ Response example: } ``` -### updateComment +## updateComment - Purpose: **Update a comment** - Parameters: @@ -150,7 +150,7 @@ Response example: } ``` -### removeComment +## removeComment - Purpose: **Remove a comment** - Parameters: diff --git a/doc/api-file-procedures.markdown b/doc/api-file-procedures.markdown index 35f633a1..bd05ce6b 100644 --- a/doc/api-file-procedures.markdown +++ b/doc/api-file-procedures.markdown @@ -1,7 +1,7 @@ API File Procedures =================== -### createFile +## createFile - Purpose: **Create and upload a new task attachment** - Parameters: @@ -39,7 +39,7 @@ Response example: } ``` -### getAllFiles +## getAllFiles - Purpose: **Get all files attached to task** - Parameters: @@ -83,7 +83,7 @@ Response example: } ``` -### getFile +## getFile - Purpose: **Get file information** - Parameters: @@ -123,7 +123,7 @@ Response example: } ``` -### downloadFile +## downloadFile - Purpose: **Download file contents (encoded in base64)** - Parameters: @@ -154,7 +154,7 @@ Response example: } ``` -### removeFile +## removeFile - Purpose: **Remove file** - Parameters: @@ -185,7 +185,7 @@ Response example: } ``` -### removeAllFiles +## removeAllFiles - Purpose: **Remove all files associated to a task** - Parameters: diff --git a/doc/api-group-member-procedures.markdown b/doc/api-group-member-procedures.markdown index 54153537..c4889265 100644 --- a/doc/api-group-member-procedures.markdown +++ b/doc/api-group-member-procedures.markdown @@ -1,7 +1,7 @@ Group Member API Procedures =========================== -### getGroupMembers +## getGroupMembers - Purpose: **Get all members of a group** - Parameters: @@ -52,7 +52,7 @@ Response example: } ``` -### addGroupMember +## addGroupMember - Purpose: **Add a user to a group** - Parameters: @@ -85,7 +85,7 @@ Response example: } ``` -### removeGroupMember +## removeGroupMember - Purpose: **Remove a user from a group** - Parameters: @@ -118,7 +118,7 @@ Response example: } ``` -### isGroupMember +## isGroupMember - Purpose: **Check if a user is member of a group** - Parameters: diff --git a/doc/api-group-procedures.markdown b/doc/api-group-procedures.markdown index 1e976b8c..cb11fb96 100644 --- a/doc/api-group-procedures.markdown +++ b/doc/api-group-procedures.markdown @@ -1,7 +1,7 @@ Group API Procedures ==================== -### createGroup +## createGroup - Purpose: **Create a new group** - Parameters: @@ -34,7 +34,7 @@ Response example: } ``` -### updateGroup +## updateGroup - Purpose: **Update a group** - Parameters: @@ -69,7 +69,7 @@ Response example: } ``` -### removeGroup +## removeGroup - Purpose: **Remove a group** - Parameters: @@ -100,7 +100,7 @@ Response example: } ``` -### getGroup +## getGroup - Purpose: **Get one group** - Parameters: @@ -135,7 +135,7 @@ Response example: } ``` -### getAllGroups +## getAllGroups - Purpose: **Get all groups** - Parameters: none diff --git a/doc/api-link-procedures.markdown b/doc/api-link-procedures.markdown index 1eb5fd6f..6113316f 100644 --- a/doc/api-link-procedures.markdown +++ b/doc/api-link-procedures.markdown @@ -1,7 +1,7 @@ API Link Procedures =================== -### getAllLinks +## getAllLinks - Purpose: **Get the list of possible relations between tasks** - Parameters: none @@ -84,7 +84,7 @@ Response example: } ``` -### getOppositeLinkId +## getOppositeLinkId - Purpose: **Get the opposite link id of a task link** - Parameters: @@ -115,7 +115,7 @@ Response example: } ``` -### getLinkByLabel +## getLinkByLabel - Purpose: **Get a link by label** - Parameters: @@ -150,7 +150,7 @@ Response example: } ``` -### getLinkById +## getLinkById - Purpose: **Get a link by id** - Parameters: @@ -185,7 +185,7 @@ Response example: } ``` -### createLink +## createLink - Purpose: **Create a new task relation** - Parameters: @@ -218,7 +218,7 @@ Response example: } ``` -### updateLink +## updateLink - Purpose: **Update a link** - Parameters: @@ -253,7 +253,7 @@ Response example: } ``` -### removeLink +## removeLink - Purpose: **Remove a link** - Parameters: @@ -284,7 +284,7 @@ Response example: } ``` -### createTaskLink +## createTaskLink - Purpose: **Create a link between two tasks** - Parameters: @@ -319,7 +319,7 @@ Response example: } ``` -### updateTaskLink +## updateTaskLink - Purpose: **Update task link** - Parameters: @@ -356,7 +356,7 @@ Response example: } ``` -### getTaskLinkById +## getTaskLinkById - Purpose: **Get a task link** - Parameters: @@ -392,7 +392,7 @@ Response example: } ``` -### getAllTaskLinks +## getAllTaskLinks - Purpose: **Get all links related to a task** - Parameters: @@ -438,7 +438,7 @@ Response example: } ``` -### removeTaskLink +## removeTaskLink - Purpose: **Remove a link between two tasks** - Parameters: diff --git a/doc/api-me-procedures.markdown b/doc/api-me-procedures.markdown index 43afb0ef..e90bee61 100644 --- a/doc/api-me-procedures.markdown +++ b/doc/api-me-procedures.markdown @@ -1,7 +1,7 @@ User API Specific Procedures ============================ -### getMe +## getMe - Purpose: **Get logged user session** - Parameters: None @@ -45,7 +45,7 @@ Response example: } ``` -### getMyDashboard +## getMyDashboard - Purpose: **Get the dashboard of the logged user without pagination** - Parameters: None @@ -147,7 +147,7 @@ Response example: } ``` -### getMyActivityStream +## getMyActivityStream - Purpose: **Get the last 100 events for the logged user** - Parameters: None @@ -230,7 +230,7 @@ Response example: } ``` -### createMyPrivateProject +## createMyPrivateProject - Purpose: **Create a private project for the logged user** - Parameters: @@ -262,7 +262,7 @@ Response example: } ``` -### getMyProjectsList +## getMyProjectsList - Purpose: **Get projects of the connected user** - Parameters: None @@ -290,7 +290,7 @@ Response example: } } ``` -### getMyOverdueTasks +## getMyOverdueTasks - Purpose: **Get my overdue tasks** - Result on success: **List of tasks** @@ -336,7 +336,7 @@ Response example: } ``` -### getMyProjects +## getMyProjects - Purpose: **Get projects of connected user with full details** - Parameters: diff --git a/doc/api-project-permission-procedures.markdown b/doc/api-project-permission-procedures.markdown index f64028b9..2844ae3c 100644 --- a/doc/api-project-permission-procedures.markdown +++ b/doc/api-project-permission-procedures.markdown @@ -1,7 +1,7 @@ Project Permission API Procedures ================================= -### getProjectUsers +## getProjectUsers - Purpose: **Get all members of a project** - Parameters: @@ -34,7 +34,7 @@ Response example: } ``` -### getAssignableUsers +## getAssignableUsers - Purpose: **Get users that can be assigned to a task for a project** (all members except viewers) - Parameters: @@ -68,7 +68,7 @@ Response example: } ``` -### addProjectUser +## addProjectUser - Purpose: **Grant access to a project for a user** - Parameters: @@ -103,7 +103,7 @@ Response example: } ``` -### addProjectGroup +## addProjectGroup - Purpose: **Grant access to a project for a group** - Parameters: @@ -137,7 +137,7 @@ Response example: } ``` -### removeProjectUser +## removeProjectUser - Purpose: **Revoke user access to a project** - Parameters: @@ -170,7 +170,7 @@ Response example: } ``` -### removeProjectGroup +## removeProjectGroup - Purpose: **Revoke group access to a project** - Parameters: @@ -203,7 +203,7 @@ Response example: } ``` -### changeProjectUserRole +## changeProjectUserRole - Purpose: **Change role of a user for a project** - Parameters: @@ -238,7 +238,7 @@ Response example: } ``` -### changeProjectGroupRole +## changeProjectGroupRole - Purpose: **Change role of a group for a project** - Parameters: diff --git a/doc/api-project-procedures.markdown b/doc/api-project-procedures.markdown index 2d23615b..6cc1b15b 100644 --- a/doc/api-project-procedures.markdown +++ b/doc/api-project-procedures.markdown @@ -1,7 +1,7 @@ API Project Procedures ====================== -### createProject +## createProject - Purpose: **Create a new project** - Parameters: @@ -33,7 +33,7 @@ Response example: } ``` -### getProjectById +## getProjectById - Purpose: **Get project information** - Parameters: @@ -82,7 +82,7 @@ Response example: } ``` -### getProjectByName +## getProjectByName - Purpose: **Get project information** - Parameters: @@ -131,7 +131,7 @@ Response example: } ``` -### getAllProjects +## getAllProjects - Purpose: **Get all available projects** - Parameters: @@ -179,7 +179,7 @@ Response example: } ``` -### updateProject +## updateProject - Purpose: **Update a project** - Parameters: @@ -213,7 +213,7 @@ Response example: } ``` -### removeProject +## removeProject - Purpose: **Remove a project** - Parameters: @@ -244,7 +244,7 @@ Response example: } ``` -### enableProject +## enableProject - Purpose: **Enable a project** - Parameters: @@ -275,7 +275,7 @@ Response example: } ``` -### disableProject +## disableProject - Purpose: **Disable a project** - Parameters: @@ -306,7 +306,7 @@ Response example: } ``` -### enableProjectPublicAccess +## enableProjectPublicAccess - Purpose: **Enable public access for a given project** - Parameters: @@ -337,7 +337,7 @@ Response example: } ``` -### disableProjectPublicAccess +## disableProjectPublicAccess - Purpose: **Disable public access for a given project** - Parameters: @@ -368,7 +368,7 @@ Response example: } ``` -### getProjectActivity +## getProjectActivity - Purpose: **Get activity stream for a project** - Parameters: @@ -389,7 +389,7 @@ Request example: } ``` -### getProjectActivities +## getProjectActivities - Purpose: **Get Activityfeed for Project(s)** - Parameters: diff --git a/doc/api-subtask-procedures.markdown b/doc/api-subtask-procedures.markdown index 9ec9a807..c1dbae37 100644 --- a/doc/api-subtask-procedures.markdown +++ b/doc/api-subtask-procedures.markdown @@ -1,7 +1,7 @@ API Subtask procedures ====================== -### createSubtask +## createSubtask - Purpose: **Create a new subtask** - Parameters: @@ -38,7 +38,7 @@ Response example: } ``` -### getSubtask +## getSubtask - Purpose: **Get subtask information** - Parameters: @@ -77,7 +77,7 @@ Response example: } ``` -### getAllSubtasks +## getAllSubtasks - Purpose: **Get all available subtasks** - Parameters: @@ -121,7 +121,7 @@ Response example: } ``` -### updateSubtask +## updateSubtask - Purpose: **Update a subtask** - Parameters: @@ -162,7 +162,7 @@ Response example: } ``` -### removeSubtask +## removeSubtask - Purpose: **Remove a subtask** - Parameters: diff --git a/doc/api-swimlane-procedures.markdown b/doc/api-swimlane-procedures.markdown index fe917042..ab288c0c 100644 --- a/doc/api-swimlane-procedures.markdown +++ b/doc/api-swimlane-procedures.markdown @@ -1,7 +1,7 @@ API Swimlane Procedures ======================= -### getDefaultSwimlane +## getDefaultSwimlane - Purpose: **Get the default swimlane for a project** - Parameters: @@ -36,7 +36,7 @@ Response example: } ``` -### getActiveSwimlanes +## getActiveSwimlanes - Purpose: **Get the list of enabled swimlanes of a project (include default swimlane if enabled)** - Parameters: @@ -76,7 +76,7 @@ Response example: } ``` -### getAllSwimlanes +## getAllSwimlanes - Purpose: **Get the list of all swimlanes of a project (enabled or disabled) and sorted by position** - Parameters: @@ -122,7 +122,7 @@ Response example: } ``` -### getSwimlane +## getSwimlane - Purpose: **Get the a swimlane by id** - Parameters: @@ -159,7 +159,7 @@ Response example: } ``` -### getSwimlaneById +## getSwimlaneById - Purpose: **Get the a swimlane by id** - Parameters: @@ -196,7 +196,7 @@ Response example: } ``` -### getSwimlaneByName +## getSwimlaneByName - Purpose: **Get the a swimlane by name** - Parameters: @@ -235,7 +235,7 @@ Response example: } ``` -### moveSwimlaneUp +## moveSwimlaneUp - Purpose: **Move up the swimlane position** - Parameters: @@ -268,7 +268,7 @@ Response example: } ``` -### moveSwimlaneDown +## moveSwimlaneDown - Purpose: **Move down the swimlane position** - Parameters: @@ -301,7 +301,7 @@ Response example: } ``` -### updateSwimlane +## updateSwimlane - Purpose: **Update swimlane properties** - Parameters: @@ -335,7 +335,7 @@ Response example: } ``` -### addSwimlane +## addSwimlane - Purpose: **Add a new swimlane** - Parameters: @@ -369,7 +369,7 @@ Response example: } ``` -### removeSwimlane +## removeSwimlane - Purpose: **Remove a swimlane** - Parameters: @@ -402,7 +402,7 @@ Response example: } ``` -### disableSwimlane +## disableSwimlane - Purpose: **Enable a swimlane** - Parameters: @@ -435,7 +435,7 @@ Response example: } ``` -### enableSwimlane +## enableSwimlane - Purpose: **Enable a swimlane** - Parameters: diff --git a/doc/api-task-procedures.markdown b/doc/api-task-procedures.markdown index 49868e2a..486c0a09 100644 --- a/doc/api-task-procedures.markdown +++ b/doc/api-task-procedures.markdown @@ -1,7 +1,7 @@ API Task Procedures =================== -### createTask +## createTask - Purpose: **Create a new task** - Parameters: @@ -61,7 +61,7 @@ Response example: } ``` -### getTask +## getTask - Purpose: **Get task by the unique id** - Parameters: @@ -128,7 +128,7 @@ Response example: } ``` -### getTaskByReference +## getTaskByReference - Purpose: **Get task by the external reference** - Parameters: @@ -192,7 +192,7 @@ Response example: } ``` -### getAllTasks +## getAllTasks - Purpose: **Get all available tasks** - Parameters: @@ -291,7 +291,7 @@ Response example: } ``` -### getOverdueTasks +## getOverdueTasks - Purpose: **Get all overdue tasks** - Result on success: **List of tasks** @@ -337,7 +337,7 @@ Response example: } ``` -### getOverdueTasksByProject +## getOverdueTasksByProject - Purpose: **Get all overdue tasks for a special project** - Result on success: **List of tasks** @@ -386,7 +386,7 @@ Response example: } ``` -### updateTask +## updateTask - Purpose: **Update a task** - Parameters: @@ -430,7 +430,7 @@ Response example: } ``` -### openTask +## openTask - Purpose: **Set a task to the status open** - Parameters: @@ -461,7 +461,7 @@ Response example: } ``` -### closeTask +## closeTask - Purpose: **Set a task to the status close** - Parameters: @@ -492,7 +492,7 @@ Response example: } ``` -### removeTask +## removeTask - Purpose: **Remove a task** - Parameters: @@ -523,7 +523,7 @@ Response example: } ``` -### moveTaskPosition +## moveTaskPosition - Purpose: **Move a task to another column, position or swimlane inside the same board** - Parameters: @@ -561,7 +561,7 @@ Response example: } ``` -### moveTaskToProject +## moveTaskToProject - Purpose: **Move a task to another project** - Parameters: @@ -598,7 +598,7 @@ Response example: } ``` -### duplicateTaskToProject +## duplicateTaskToProject - Purpose: **Move a task to another column or another position** - Parameters: diff --git a/doc/api-user-procedures.markdown b/doc/api-user-procedures.markdown index ccf4a6a6..6ecf12c6 100644 --- a/doc/api-user-procedures.markdown +++ b/doc/api-user-procedures.markdown @@ -1,7 +1,7 @@ API User Procedures =================== -### createUser +## createUser - Purpose: **Create a new user** - Parameters: @@ -37,7 +37,7 @@ Response example: } ``` -### createLdapUser +## createLdapUser - Purpose: **Create a new user authentified by LDAP** - Parameters: @@ -71,7 +71,7 @@ Response example: } ``` -### getUser +## getUser - Purpose: **Get user information** - Parameters: @@ -113,7 +113,7 @@ Response example: } ``` -### getAllUsers +## getAllUsers - Purpose: **Get all available users** - Parameters: @@ -154,7 +154,7 @@ Response example: } ``` -### updateUser +## updateUser - Purpose: **Update a user** - Parameters: @@ -190,7 +190,7 @@ Response example: } ``` -### removeUser +## removeUser - Purpose: **Remove a user** - Parameters: |