apidocs misleading - causes API requests to /user/allocate always up Strength

[SabreCat]

Description

The data payload of a curl request to /api/v3/user/allocate appears not to be parsed correctly, leading to the default STR attribute being incremented regardless of the request. For instance, the following returns success but bumps STR instead of the desired INT:

curl -s -X POST --compressed -H "Content-Type:application/json" -H "x-api-user:USERID" -H "x-api-key:API_TOKEN" https://habitica.com/api/v3/user/allocate -d '{"stat": "int"}'

[TheHollidayInn]

That's because stats is supposed to be a query param. We document that:

• habitica/website/server/controllers/api-v3/user/stats.js

  Line 12 in 8b9bf88

  * @apiParam (Body) {String="str","con","int","per"} stat Query parameter - Default ='str'

  .

• habitica/website/common/script/ops/stats/allocate.js

  Line 12 in 8b9bf88

  let stat = get(req, 'query.stat', 'str');

I can see how this could be confusing, but it isn't a bug.

[Alys]

The apidocs for that route have it listed under the heading "Body Parameters", which is probably how the confusion arises (even though it's "query parameters" in the text).

I'm reopening this for the docs to be clarified but I"m assigning it to myself to fix because I want to make a couple of other wording changes too (e.g., "Stat Points")

[TheHollidayInn]

Ah I guess that's because of the body after param. I saw the query param next to the name on the doc line.