question-mark
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

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:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:7 (4 by maintainers)

github_iconTop 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!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Helping Consumers Resolve Data Matching Issues (DMIs)
A consumer's data may not match information at our trusted data sources. • A trusted data source may not have data for a...
Read more >
Verification, Updates, and Corrections - FSA Partner Connect
You are required to report results no more than 60 days following your first request to the student for documentation of identity and...
Read more >
Developer Program Policy - Play Console Help
Loyalty points or rewards with benefits, perks or rewards associated with a qualifying monetary transaction may only be awarded and redeemed on a...
Read more >
MATCH function - Microsoft Support
The MATCH function searches for a specified item in a range of cells, and then returns the relative position of that item in...
Read more >
NYS Healthcare Worker Bonus Program Frequently Asked ...
employers should retain the documentation on why the employee is eligible ... If the title does not match exactly, is the worker ineligible?...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found