krikkert/habitica
1
0
Fork 0
mirror of https://github.com/HabitRPG/habitica.git synced 2025-12-17 14:47:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

removing wrong info on updating challenge leader from apidoc (#12413)

Browse Source 
* removing wrong info on updating challenge leader

as discussed in the Aspiring Comrades, doing the change because the route `/api/v3/challenges/:challengeId` can't be used to change challenge leader, so I am deleting it from the docs

* adding summary to section title

as requested by @paglias

* missing comma

* fix(lint): line length

Co-authored-by: Sabe Jones <sabrecat@gmail.com>
This commit is contained in:
Ieahleen
2020-07-31 11:10:47 +02:00
committed by GitHub
parent 8003632041
commit c4049608a8
1 changed files with 1 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
website/server/controllers/api-v3/challenges.js
View File

@@ -659,7 +659,7 @@ api.exportChallengeCsv = {
}; };
/** /**
* @api {put} /api/v3/challenges/:challengeId Update the name, description, or leader of a challenge * @api {put} /api/v3/challenges/:challengeId Update a challenge's name, description, or summary
* *
* @apiName UpdateChallenge * @apiName UpdateChallenge
* @apiGroup Challenge * @apiGroup Challenge
@@ -668,7 +668,6 @@ api.exportChallengeCsv = {
* @apiParam (Body) {String} [challenge.name] The new full name of the challenge. * @apiParam (Body) {String} [challenge.name] The new full name of the challenge.
* @apiParam (Body) {String} [challenge.summary] The new challenge summary. * @apiParam (Body) {String} [challenge.summary] The new challenge summary.
* @apiParam (Body) {String} [challenge.description] The new challenge description. * @apiParam (Body) {String} [challenge.description] The new challenge description.
* @apiParam (Body) {String} [challenge.leader] The UUID of the new challenge leader.
* *
* @apiSuccess {Object} data The updated challenge * @apiSuccess {Object} data The updated challenge
* @apiPermission ChallengeLeader * @apiPermission ChallengeLeader