Every comment annotation, generated from `npgsqlrest --annotations` (NpgsqlRest v3.18.1).

Annotations apply to both endpoint sources (database routines via `comment on`, and `.sql` files via leading `--` comments). The `@` prefix is optional. Regenerate with `npgsqlrest --annotations`.

- **Aliases:** http

- **Syntax:** `http [GET|POST|PUT|DELETE] [path]`

Enable endpoint and configure HTTP method and/or path. Required (for HTTP exposure) when CommentsMode is OnlyAnnotated (or its alias OnlyWithHttpTag).

- **Aliases:** path

- **Syntax:** `path <url_path>`

Override the endpoint URL path.

- **Aliases:** request_param_type, param_type

- **Syntax:** `param_type [query_string|query|body_json|body]`

Set request parameter type to query string or JSON body.

- **Aliases:** authorize, authorized, requires_authorization

- **Syntax:** `authorize [role1, role2, ...]`

Require authorization, optionally restricting to specific roles.

- **Aliases:** allow_anonymous, anonymous, allow_anon, anon

- **Syntax:** `allow_anonymous`

Allow unauthenticated access to this endpoint.

- **Aliases:** login, signin

- **Syntax:** `login`

Mark endpoint as a login/authentication endpoint.

- **Aliases:** logout, signout

- **Syntax:** `logout`

Mark endpoint as a logout endpoint.

- **Aliases:** raw, raw_mode, raw_results

- **Syntax:** `raw`

Return raw results without JSON formatting.

- **Aliases:** separator, raw_separator

- **Syntax:** `separator <value>`

Set the value separator for raw mode output.

- **Aliases:** new_line, raw_new_line

- **Syntax:** `new_line <value>`

Set the line separator for raw mode output.

- **Aliases:** columns, names, column_names

- **Syntax:** `columns`

Include column names as the first row in raw output.

- **Aliases:** buffer_rows, buffer

- **Syntax:** `buffer_rows <number>`

Set the number of rows to buffer before sending response.

- **Aliases:** cached

- **Syntax:** `cached [param1, param2, ...]`

Enable response caching, optionally specifying cache key parameters.

- **Aliases:** cache_expires, cache_expires_in

- **Syntax:** `cache_expires <interval>`

Set cache expiration time (PostgreSQL interval format).

- **Aliases:** cache_profile

- **Syntax:** `cache_profile <name>`

Select a named cache profile defined in CacheOptions.Profiles. The profile supplies the cache backend, default expiration, default key parameters, and per-parameter skip conditions. Implies caching even without @cached. Existing @cached and @cache_expires annotations override the profile's defaults. Unknown profile names cause startup to fail.

- **Aliases:** connection, connection_name

- **Syntax:** `connection_name <name>`

Use a specific named connection string for this endpoint.

- **Aliases:** command_timeout, timeout

- **Syntax:** `timeout <interval>`

Set command execution timeout (PostgreSQL interval format).

- **Aliases:** request_headers_mode, request_headers

- **Syntax:** `request_headers [ignore|context|parameter]`

Control how HTTP request headers are passed to the routine.

- **Aliases:** request_headers_parameter_name, request_headers_param_name, request-headers-param-name

- **Syntax:** `request_headers_parameter_name <name>`

Set the parameter name for request headers when mode is parameter.

- **Aliases:** body_parameter_name, body_param_name

- **Syntax:** `body_parameter_name <name>`

Set the parameter name for the JSON body content.

- **Aliases:** response_null_handling, response_null

- **Syntax:** `response_null [empty_string|null_literal|no_content|204]`

Control how NULL return values are rendered in responses.

- **Aliases:** query_string_null_handling, query_null_handling, query_string_null, query_null

- **Syntax:** `query_null [empty_string|null_literal|ignore]`

Control how NULL query string parameters are handled.

- **Aliases:** sensitive, security, security_sensitive

- **Syntax:** `security_sensitive`

Mark endpoint as security-sensitive (suppresses logging of parameters).

- **Aliases:** user_context

- **Syntax:** `user_context`

Pass authenticated user context to the routine via connection settings.

- **Aliases:** user_parameters, user_params

- **Syntax:** `user_parameters`

Map user claims to routine parameters.

- **Aliases:** upload

- **Syntax:** `upload [for handler1, handler2, ...]`

Enable file upload for this endpoint, optionally specifying upload handlers.

- **Aliases:** parameter, param

- **Syntax:** `param <name> is hash of <other_name> | param <name> is upload metadata | param <original> <new_name> [type] | param <original> is <new_name> [type]`

Configure parameter behavior: hash computation, upload metadata binding, or rename/retype. Rename forms: 'param $1 user_id', 'param $1 user_id integer', 'param $1 is user_id', 'param _old_name better_name'. Works on all endpoint types.

- **Aliases:** sse, sse_path, sse_events_path

- **Syntax:** `sse_path [path] [on info|notice|warning]`

Enable Server-Sent Events streaming with optional path and notice level.

- **Aliases:** sse_level, sse_events_level

- **Syntax:** `sse_level [info|notice|warning]`

Set the PostgreSQL notice level for SSE events.

- **Aliases:** sse_scope, sse_events_scope

- **Syntax:** `sse_scope [all|authorize|matching] [role1, role2, ...]`

Set the broadcast scope for SSE events.

- **Aliases:** basic_authentication, basic_auth

- **Syntax:** `basic_auth [username] [password]`

Enable HTTP Basic Authentication for this endpoint.

- **Aliases:** basic_authentication_realm, basic_auth_realm, realm

- **Syntax:** `basic_auth_realm <realm>`

Set the authentication realm for Basic Auth challenges.

- **Aliases:** basic_authentication_command, basic_auth_command, challenge_command

- **Syntax:** `basic_auth_command <sql_command>`

Set a custom SQL command for Basic Auth credential validation.

- **Aliases:** retry_strategy_name, retry_strategy, retry

- **Syntax:** `retry_strategy <name>`

Apply a named retry strategy for transient database errors.

- **Aliases:** rate_limiter_policy_name, rate_limiter_policy, rate_limiter

- **Syntax:** `rate_limiter <policy_name>`

Apply a named rate limiting policy to this endpoint.

- **Aliases:** error_code_policy_name, error_code_policy, error_code

- **Syntax:** `error_code_policy <name>`

Apply a named error code mapping policy for PostgreSQL error codes.

- **Aliases:** validate, validation

- **Syntax:** `validate <param_name> using <rule_name>`

Add parameter validation using a named validation rule.

- **Aliases:** proxy, reverse_proxy

- **Syntax:** `proxy [GET|POST|PUT|DELETE|PATCH] [host_url]`

Configure endpoint as a reverse proxy.

- **Aliases:** proxy_out, forward_proxy

- **Syntax:** `proxy_out [GET|POST|PUT|DELETE|PATCH] [host_url]`

Execute function first, then forward result body to upstream proxy service.

- **Aliases:** nested, nested_json, nested_composite

- **Syntax:** `nested_json`

Serialize composite type columns as nested JSON objects.

- **Aliases:** for, tags, tag

- **Syntax:** `for tag1, tag2, ...`

Filter endpoint availability by tags.

- **Aliases:** disabled

- **Syntax:** `disabled [tag1, tag2, ...]`

Disable this endpoint, optionally only for specific tags.

- **Aliases:** enabled

- **Syntax:** `enabled [tag1, tag2, ...]`

Enable this endpoint, optionally only for specific tags.

- **Aliases:** internal, internal_only

- **Syntax:** `internal`

Mark endpoint as internal-only. Not exposed as an HTTP route, only accessible via self-referencing calls (proxy, HTTP client types).

- **Aliases:** encrypt, encrypted, protect, protected

- **Syntax:** `encrypt [param1, param2, ...]`

Encrypt parameter values using the default data protector before sending to PostgreSQL. Without arguments, encrypts all text parameters.

- **Aliases:** decrypt, decrypted, unprotect, unprotected

- **Syntax:** `decrypt [column1, column2, ...]`

Decrypt result column values using the default data protector before returning to the client. Without arguments, decrypts all text columns.

- **Aliases:**

- **Syntax:** `key = value`

Define a custom parameter as key-value pair (separated by =).

- **Aliases:**

- **Syntax:** `Header-Name: header-value`

Add a response header (separated by :).

- **Aliases:** result1, result2, result3

- **Syntax:** `resultN <name> | resultN is <name>`

Rename a result key in multi-command SQL file responses. N is the 1-based command index. Example: '@result1 validate' renames the first result from 'result1' to 'validate'. SQL file source only.

- **Aliases:** define_param

- **Syntax:** `define_param <name> [type]`

Define a virtual parameter that exists for HTTP matching and claim mapping but is NOT bound to the PostgreSQL command. Useful for SQL file endpoints where you need parameters for comment placeholders or claim mapping without referencing them in SQL. Default type is text. SQL file source only.