http-filesystem proxy

The http-filesystem proxy binding adapts http data streams into filesystem data streams by mapping the path from an inbound http GET request into a filesystem relative path.

Behaves as a web server when combined with tcp, tls, http and filesystem bindings.

http_filesystem_proxy:
  type: http-filesystem
  kind: proxy
  routes:
    - when:
        - path: /{path}
      exit: filesystem_server
      with:
        path: ${params.path}

Configuration (* required)

routes

array of object

Conditional http-kafka specific routes.

routes:
  - when:
      - path: /{path}
    exit: filesystem_server
    with:
      path: ${params.path}

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes:
  - guarded:
      my_guard:
        - read:items

routes[].when

array of object

List of conditions (any match) to match this route when adapting http data streams into filesystem data streams. Read more: When a route matches

routes:
  - when:
      - path: /{path}

when[].path

string

Path with optional embedded parameter names, such as /{path}.

when[].method

enum [ GET, PUT, POST, DELETE, HEAD ]

HTTP method to match.

routes[].exit

string

Next binding when following this route.

routes:
  - when:
    ...
    exit: filesystem_server

routes[].with

object

Filesystem parameters used when adapting http data streams into filesystem data streams. At least one of path or directory is required.

with.path

string

File path, optionally referencing path parameter such as ${params.path}.

with.directory

string

Directory path for the response.

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*
    - http.*

telemetry.attributes

object as map of named string properties

Telemetry attributes to add to the binding metrics.