Skip to content

docs: document TransportConfig fields#283

Merged
BoxBoxJason merged 1 commit into
mainfrom
docs/transport-config-docs
Jun 13, 2026
Merged

docs: document TransportConfig fields#283
BoxBoxJason merged 1 commit into
mainfrom
docs/transport-config-docs

Conversation

@BoxBoxJason

Copy link
Copy Markdown
Owner

Description of your changes

This PR documents fields of the TransportConfig type. This adds a warning for the tls config skip verification.

Closes #254

I have:

  • Followed the git conventional commit message format.
  • Made sure all changes are covered by proper tests, reaching a coverage of at least 80% when applicable.

How has this code been tested

I have:

  • Made sure make lint passes to verify that the code style is correct.
  • Made sure make test passes to verify that the code is working as intended.
  • Made sure make e2e passes to verify that end-to-end tests pass against a real SonarQube instance.
  • Added unit tests to cover the code changes.
  • Added end-to-end tests if necessary.

Signed-off-by: BoxBoxJason <contact@boxboxjason.dev>
@BoxBoxJason BoxBoxJason added this to the User Production Readiness milestone Jun 13, 2026
@BoxBoxJason BoxBoxJason self-assigned this Jun 13, 2026
@BoxBoxJason BoxBoxJason added the documentation Improvements or additions to documentation label Jun 13, 2026
@BoxBoxJason BoxBoxJason changed the title docs: warn about insecure TLS configuration on TransportConfig docs: document TransportConfig fields Jun 13, 2026
@BoxBoxJason BoxBoxJason merged commit 669a209 into main Jun 13, 2026
5 checks passed
@BoxBoxJason BoxBoxJason deleted the docs/transport-config-docs branch June 13, 2026 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

No guardrail/warning around insecure TLS configuration

1 participant