docs(prism-agent): ATL-6269 improve connections OpenAPI doc

[bvoiturier]

Overview

Fixes ATL-6269

Checklist

My PR contains...

• No code changes (changes to documentation, CI, metadata, etc.)
• Bug fixes (non-breaking change which fixes an issue)
• Improvements (misc. changes to existing features)
• Features (non-breaking change which adds functionality)

My changes...

• are breaking changes
• are not breaking changes
• If yes to above: I have updated the documentation accordingly

Documentation

• My changes do not require a change to the project documentation
• My changes require a change to the project documentation
• If yes to above: I have updated the documentation accordingly

Tests

• My changes can not or do not need to be tested
• My changes can and should be tested by unit and/or integration tests
• If yes to above: I have added tests to cover my changes
• If yes to above: I have taken care to cover edge cases in my tests

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

Integration Test Results

11 files  ±0  11 suites  ±0   2s ⏱️ ±0s
24 tests ±0  24 ✅ ±0  0 💤 ±0  0 ❌ ±0 
25 runs  ±0  25 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit a6e69c4. ± Comparison against base commit f77b796.

[github-actions]

Unit Test Results

 85 files  ±0   85 suites  ±0   21m 20s ⏱️ +4s
713 tests ±0  705 ✅ ±0  8 💤 ±0  0 ❌ ±0 
719 runs  ±0  711 ✅ ±0  8 💤 ±0  0 ❌ ±0 

Results for commit a6e69c4. ± Comparison against base commit f77b796.

[yshyn-iohk]

Good job, @bvoiturier!
Let's merge this PR and I will rebase&refactor mine based on it