shotover / shotover-proxy

L7 data-layer proxy
https://docs.shotover.io
Apache License 2.0
83 stars 16 forks source link

Add missing documentation to transforms module #1699

Closed rukai closed 1 month ago

rukai commented 1 month ago

The transforms module is a core part of our public API, so it should be well documented. This PR adds documentation for many missing fields.

I noticed TransformContextConfig::protocol should really be named TransformContextConfig::up_chain_protocol but I have not renamed it because that would force us into shotover 0.5 so soon after 0.4, so I left a TODO instead.

codspeed-hq[bot] commented 1 month ago

CodSpeed Performance Report

Merging #1699 will not alter performance

Comparing rukai:document_transforms_module (1afa565) with main (580c782)

Summary

✅ 39 untouched benchmarks