feat: add doc comment with runtime api versioning guidelines

[dandanlen]

Pull Request

Closes: PRO-xxx

Checklist

Please conduct a thorough self-review before opening the PR.

• I am confident that the code works.
• I have written sufficient tests.
• I have written and tested required migrations.
• I have updated documentation where appropriate.

Summary

Please include a succinct description of the purpose and content of the PR. What problem does it solve, and how? Link issues, discussions, other PRs, and anything else that will help the reviewer.

Non-Breaking changes

If this PR includes non-breaking changes, select the non-breaking label. On merge, CI will automatically cherry-pick the commit to a PR against the release branch.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70%. Comparing base (8fa1f81) to head (0b3c5a1).
Report is 2 commits behind head on main.

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #5257   +/-   ##
=====================================
- Coverage     70%     70%   -0%     
=====================================
  Files        480     483    +3     
  Lines      86746   86764   +18     
  Branches   86746   86764   +18     
=====================================
- Hits       61062   61004   -58     
- Misses     22388   22458   +70     
- Partials    3296    3302    +6     

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