Document JsonApiEndpoints

[verdie-g]

Closes #1298

I was not abled to reuse PR #1301.

QUALITY CHECKLIST

• Changes implemented in code
• Complies with our contributing guidelines
• Adapted tests
• Documentation updated

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.79%. Comparing base (e430330) to head (0ee91ef).
⚠️ Report is 745 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1423   +/-   ##
=======================================
  Coverage   90.79%   90.79%           
=======================================
  Files         342      342           
  Lines       11060    11060           
  Branches     1812     1812           
=======================================
  Hits        10042    10042           
  Misses        670      670           
  Partials      348      348           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[bkoelman]

Thanks.

This looks good, but cannot be merged yet, because cleanup-code fails on ubuntu/macos -or- windows. The bug is tracked at https://youtrack.jetbrains.com/issue/RSRP-494002.

[verdie-g]

Can we suppress the formatting on this file to avoid stalling that PR?

[bkoelman]

Superseded by #1304.