You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: NpgsqlRest/NpgsqlRestOptions.cs
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -104,7 +104,7 @@ public NpgsqlRestOptions(NpgsqlDataSource dataSource)
104
104
publicstring?UrlPathPrefix{get;set;}="/api";
105
105
106
106
/// <summary>
107
-
/// Custom function delegate that receives routine and options parameters and returns constructed URL path string for routine. Default the default URL builder that transforms snake case names to kebab case names.
107
+
/// Custom function delegate that receives routine and options parameters and returns constructed URL path string for routine. Default is the default URL builder that transforms snake case names to kebab case names.
@@ -181,7 +181,7 @@ public NpgsqlRestOptions(NpgsqlDataSource dataSource)
181
181
publicMethod?DefaultHttpMethod{get;set;}
182
182
183
183
/// <summary>
184
-
/// When not null, sets the request parameter position (request parameter types) for all created endpoints. Values are `QueryString` (parameters are sent using query string) or `BodyJson` (paremeters are sent using JSON request body). When this value is null (default), request parameter type is `QueryString` for all `GET` and `DELETE` endpoints, otherwise, request parameter type is `BodyJson`. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
184
+
/// When not null, sets the request parameter position (request parameter types) for all created endpoints. Values are `QueryString` (parameters are sent using query string) or `BodyJson` (parameters are sent using JSON request body). When this value is null (default), request parameter type is `QueryString` for all `GET` and `DELETE` endpoints, otherwise, request parameter type is `BodyJson`. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// Custom parameter validation method, asynchrounous version. When this callback option is not null, it will be executed for every database parameter created. The input structure will contain a current HTTP context that offers the opportunity to alter the response and cancel the request: If the current HTTP response reference has started or the status code is different than 200 OK, command execution will be canceled and the response will be returned.
194
+
/// Custom parameter validation method, asynchronous version. When this callback option is not null, it will be executed for every database parameter created. The input structure will contain a current HTTP context that offers the opportunity to alter the response and cancel the request: If the current HTTP response reference has started or the status code is different than 200 OK, command execution will be canceled and the response will be returned.
/// Configure how to send request headers to PostgreSQL routines execution. `Ignore` (default) don't send any request headers to routines. `Context` sets a context variable for the current session `context.headers` containing JSON string with current request headers. This executes `set_config('context.headers', headers, false)` before any routine executions. `Parameter` sends request headers to the routine parameter defined with the `RequestHeadersParameterName` option. Paremeter with this name must exist, must be one of the JSON or text types and must have the default value defined. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
204
+
/// Configure how to send request headers to PostgreSQL routines execution. `Ignore` (default) doesn't send any request headers to routines. `Context` sets a context variable for the current session `context.headers` containing JSON string with current request headers. This executes `set_config('context.headers', headers, false)` before any routine executions. `Parameter` sends request headers to the routine parameter defined with the `RequestHeadersParameterName` option. Parameter with this name must exist, must be one of the JSON or text types and must have the default value defined. This option for individual endpoints can be changed with the `EndpointCreated` function callback, or by using comment annotations.
/// When cache is enabled, this value sets the interval in minutes for cache pruning (removing expired entires). Default is 1 minute.
317
+
/// When cache is enabled, this value sets the interval in minutes for cache pruning (removing expired entries). Default is 1 minute.
318
318
/// </summary>
319
319
publicintCachePruneIntervalMin{get;set;}=1;
320
320
@@ -365,7 +365,7 @@ public class NpgsqlRestUploadOptions
365
365
366
366
/// <summary>
367
367
/// Name of the default upload metadata parameter.
368
-
/// This parameter is will be automatically assigned with the upload metadata JSON string when the upload is completed if UseDefaultUploadMetadataParameter is set to true.
368
+
/// This parameter will be automatically assigned with the upload metadata JSON string when the upload is completed if UseDefaultUploadMetadataParameter is set to true.
/// The default column name to in the data reader which will be used to read the value to determine the success or failure of the login operation.
400
+
/// The default column name in the data reader which will be used to read the value to determine the success or failure of the login operation.
401
401
///
402
402
/// - If this column is not present, the success is when the endpoint returns any records.
403
-
/// - If this column is not present, it must be either a boolean to indicate success or a numeric value to indicate the HTTP Status Code to return.
403
+
/// - If this column is present, it must be either a boolean to indicate success or a numeric value to indicate the HTTP Status Code to return.
404
404
/// - If this column is present and retrieves a numeric value, that value is assigned to the HTTP Status Code and the login will authenticate only when this value is 200.
405
405
/// </summary>
406
406
publicstring?StatusColumnName{get;set;}="status";
407
407
408
408
/// <summary>
409
-
/// The default column name to in the data reader which will be used to read the value of the authentication scheme of the login process.
409
+
/// The default column name in the data reader which will be used to read the value of the authentication scheme of the login process.
410
410
///
411
411
/// If this column is not present in the login response the default authentication scheme is used. Return new value to use a different authentication scheme with the login endpoint.
412
412
/// </summary>
413
413
publicstring?SchemeColumnName{get;set;}="scheme";
414
414
415
415
/// <summary>
416
-
/// The default column name to in the data reader which will return a text message with the login status.
416
+
/// The default column name in the data reader which will return a text message with the login status.
0 commit comments