Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

docs: ability_bonuses result does not match documentation

See original GitHub issue

Issue Description

An "ability_bonuses" field is returned from two endpoints, but the type description does not match the returned value.

`GET api/races/{index}`

actual result:

...
"ability_bonuses": [
    {
      "name": "CON",
      "index": "con",
      "bonus": 2,
      "url": "/api/ability-scores/con"
    }
  ],
...

documentation:

ability_bonuses | Racial bonuses to each of the six ability scores. | array (integer)

`GET api/subraces/{index}`

actual result:

...
"ability_bonuses": [
    {
      "name": "WIS",
      "index": "wis",
      "bonus": 1,
      "url": "/api/ability-scores/wis"
    }
  ],
...

documentation:

ability_bonuses | Additional ability bonuses granted by this sub race. | array (map)

Issue Analytics

State:
Created 2 years ago
Reactions:1
Comments:7 (4 by maintainers)

Top GitHub Comments

1reaction

fergcbcommented, Oct 20, 2020

An update to these docs would be welcome in tandem with an update to the actual structure of the data, I think.

It would be nice to separate the APIReference from the objects, as below, and update the docs accordingly.

"ability_bonuses": [
  {
    "ability_score": {
      "name": "WIS",
      "index": "wis",
      "url": "/api/ability-scores/wis"
    },
    "bonus": 1
  }
],

0reactions

bagelbitscommented, Oct 30, 2020

Closing as this has been merged in!