imports:
  - time

docs:
  title: Delay system startup
  intro: |-
    You can configure these options to defer API execution until another external (HTTP) service is up and running.

    [ TIP ]
    ====
    Delaying API execution can come in handy in complex setups where execution order is important.
    ====

props:
  - name: Delay
    type: time.Duration
    env: WAIT_FOR
    default: 0
    description: |-
      Delays API startup for the amount of time specified (10s, 2m...).
          This delay happens before service (`WAIT_FOR_SERVICES`) probing.

  - name: StatusPage
    type: bool
    env: WAIT_FOR_STATUS_PAGE
    default: true
    description: Show temporary status web page.

  - name: Services
    env: WAIT_FOR_SERVICES
    description: |-
      Space delimited list of hosts and/or URLs to probe.
          Host format: `host` or `host:443` (port will default to 80).

      [NOTE]
      ====
      Services are probed in parallel.
      ====

  - name: ServicesTimeout
    type: time.Duration
    env: WAIT_FOR_SERVICES_TIMEOUT
    default: time.Minute
    description: Max time for each service probe.

  - name: ServicesProbeTimeout
    type: time.Duration
    env: WAIT_FOR_SERVICES_PROBE_TIMEOUT
    default: time.Second * 30
    description: Timeout for each service probe.

  - name: ServicesProbeInterval
    type: time.Duration
    env: WAIT_FOR_SERVICES_PROBE_INTERVAL
    default: time.Second * 5
    description: Interval between service probes.