REQUEST_HEADERS_PARAMETER_NAME

Set the parameter name that receives request headers when using parameter mode.

Keywords

request_headers_parameter_name, request_headers_param_name, request-headers-param-name

Syntax

request_headers_parameter_name <param-name>

Examples

Custom Parameter Name

create function process_request(_data text, _req_headers json default null)
returns json
language sql
as $$...$$;

comment on function process_request(text, json) is
'HTTP POST
request_headers_mode parameter
request_headers_parameter_name _req_headers';

Default Parameter Name

By default, uses _headers as the parameter name:

create function my_func(_input text, _headers json default null)
returns json
language sql
as $$...$$;

comment on function my_func(text, json) is
'HTTP POST
request_headers_mode parameter';

Behavior

• Only applies when request_headers_mode is parameter
• Parameter must have a default value (typically null)
• Parameter type should be json or text
• Headers are passed as JSON object

Related

• NpgsqlRest Options configuration - Configure default parameter name
• Comment Annotations Guide - How annotations work
• Configuration Guide - How configuration works

Related Annotations

• REQUEST_HEADERS_MODE - Set header passing mode