Documentation

Hale.PostgREST.PostgREST.Config.Proxy

URI scheme (HTTP or HTTPS).

Instances For
    Equations
    • One or more equations did not get rendered due to their size.
    Instances For
      @[implicit_reducible]
      Equations
      • One or more equations did not get rendered due to their size.

      The default port for a given scheme. $$\text{defaultPort}(\text{http}) = 80,\quad \text{defaultPort}(\text{https}) = 443$$

      Equations
      Instances For

        A parsed proxy URI for OpenAPI server specification. $$\text{ProxyUri} = \{ \text{scheme},\; \text{host},\; \text{port} : \mathbb{N},\; \text{basePath} : \text{String} \}$$

        • puScheme : UriScheme

          The URI scheme (http or https).

        • puHost : String

          The hostname or IP address.

        • puPort : Nat

          The port number.

        • puBasePath : String

          The base path prefix (e.g., "/api/v1").

        Instances For
          Equations
          Instances For
            Equations
            • One or more equations did not get rendered due to their size.
            Instances For

              Reconstruct the full URI string from parts. $$\text{toUri}(p) = \text{scheme}\texttt{://}\text{host}[:\text{port}]\text{basePath}$$

              Equations
              • One or more equations did not get rendered due to their size.
              Instances For

                Parse a proxy URI string. $$\text{parse}(\texttt{https://api.example.com:8443/v1}) = \langle \text{https},\; \texttt{api.example.com},\; 8443,\; \texttt{/v1} \rangle$$

                Returns none if the URI cannot be parsed. Handles:

                • http:// and https:// schemes
                • Optional port (defaults to 80 or 443)
                • Optional path (defaults to "/")
                Equations
                • One or more equations did not get rendered due to their size.
                Instances For

                  Generate the OpenAPI server URL from configuration. If a proxy URI is configured, use it. Otherwise, construct a URL from the server host and port.

                  Equations
                  Instances For