zio-http icon indicating copy to clipboard operation
zio-http copied to clipboard

Configuration of ZIO HTTP

Open TomTriple opened this issue 2 years ago • 16 comments

What is not easy to do right now? There is no single source (website, markdown...) where one can find out about all config options in ZIO HTTP. One needs to inspect the code for the various configs we have e.g. zio.http.ConnectionPoolConfig.config or zio.http.Server.Config.config or zio.http.netty.Config.config.

Describe the solution you'd like We should auto-generate all config options (probably in the build process) into a markdown page entitled Configuration and with the help of zio.config. That works already:

val config = zio.http.ConnectionPoolConfig.config // compose with other configs
val docs = generateDocs(config).toTable.toGithubFlavouredMarkdown // generateDocs comes from zio.config
println(docs) // prints auto-generated content directly from inspecting the config instance

Also we could generate an example config file including default values from all given configs.

Why is it important? Easier configuration, user friendlyness and always up to date docs

Additional context zio.config: https://zio.dev/zio-config/dive-into-zio-config#documentations-using-config

TomTriple avatar Sep 08 '23 08:09 TomTriple

/bounty $100

jdegoes avatar Sep 26 '23 16:09 jdegoes

💎 $100 bounty • ZIO

Steps to solve:

  1. Start working: Comment /attempt #2431 with your implementation plan
  2. Submit work: Create a pull request including /claim #2431 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to zio/zio-http!

Add a bountyShare on socials

Attempt Started (GMT+0) Solution
🔴 @guersam Sep 30, 2023, 8:42:25 AM WIP
🔴 @vivasvan1 Oct 25, 2023, 9:46:43 AM WIP
🔴 @jaimin001 Dec 29, 2023, 11:34:06 PM WIP
🔴 @pragmaxim Apr 13, 2024, 11:14:32 AM WIP

algora-pbc[bot] avatar Sep 26 '23 16:09 algora-pbc[bot]

/attempt #2431

Options

guersam avatar Sep 30 '23 08:09 guersam

As the built-in zio.Config does not provide bidirectional config rendering, generating documentations for configs is more difficult than before.

Currently I'm writing an ad-hoc table generator from scratch for ZIO HTTP.

guersam avatar Oct 02 '23 11:10 guersam

@guersam: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

algora-pbc[bot] avatar Oct 07 '23 08:10 algora-pbc[bot]

The bounty is up for grabs! Everyone is welcome to /attempt #2431 🙌

algora-pbc[bot] avatar Oct 14 '23 08:10 algora-pbc[bot]

/attempt #2431

Options

vivasvan1 avatar Oct 25 '23 09:10 vivasvan1

@vivasvan1: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

algora-pbc[bot] avatar Nov 01 '23 09:11 algora-pbc[bot]

The bounty is up for grabs! Everyone is welcome to /attempt #2431 🙌

algora-pbc[bot] avatar Nov 08 '23 09:11 algora-pbc[bot]

/attempt #2431

jaimin001 avatar Dec 29 '23 23:12 jaimin001

@jaimin001: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

algora-pbc[bot] avatar Jan 05 '24 23:01 algora-pbc[bot]

The bounty is up for grabs! Everyone is welcome to /attempt #2431 🙌

algora-pbc[bot] avatar Jan 12 '24 23:01 algora-pbc[bot]

/attempt https://github.com/zio/zio-http/issues/2431

Options

pragmaxim avatar Apr 13 '24 11:04 pragmaxim

@pragmaxim: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

algora-pbc[bot] avatar Apr 20 '24 11:04 algora-pbc[bot]

The bounty is up for grabs! Everyone is welcome to /attempt #2431 🙌

algora-pbc[bot] avatar Apr 27 '24 11:04 algora-pbc[bot]