breaking change: all comment annotations are using snake case only

vbilopav · vbilopav · commit bbe0c875d90e · 2025-05-17T10:59:24.000+02:00
diff --git a/NpgsqlRest/Defaults/DefaultCommentParser.cs b/NpgsqlRest/Defaults/DefaultCommentParser.cs
diff --git a/NpgsqlRestTests/BodyTests/BodyParameterNameTests.cs b/NpgsqlRestTests/BodyTests/BodyParameterNameTests.cs
@@ -9,21 +9,21 @@ create function body_param_name_1p(_p text)
 returns text language sql as 'select _p';
 comment on function body_param_name_1p(text) is '
 HTTP
-body-param-name p
+body_param_name p
 ';
 
 create function body_param_name_2p(_i int, _p text) 
 returns text language sql as 'select _i::text || '' '' || _p';
 comment on function body_param_name_2p(int, text) is '
 HTTP
-body-param-name _p
+body_param_name _p
 ';
 
 create function body_param_name_int(_int int) 
 returns text language sql as 'select _int';
 comment on function body_param_name_int(int) is '
 HTTP
-body-param-name int';
+body_param_name int';
 ");
     }
 }
diff --git a/NpgsqlRestTests/CommentTests/CommentAuthAttrTests.cs b/NpgsqlRestTests/CommentTests/CommentAuthAttrTests.cs
@@ -11,7 +11,7 @@ comment on function comment_authorize1() is 'HTTP
 
 create function comment_authorize2() returns text language sql as 'select ''authorize2''';
 comment on function comment_authorize2() is 'HTTP
-RequiresAuthorization';
+requires_authorization';
 
 create function comment_authorize3() returns text language sql as 'select ''authorize3''';
 comment on function comment_authorize3() is '
diff --git a/NpgsqlRestTests/CommentTests/CommentParamTypeAttrTests.cs b/NpgsqlRestTests/CommentTests/CommentParamTypeAttrTests.cs
@@ -8,25 +8,25 @@ public static void CommentParamTypeAttrTests()
 create function comment_param_type_query1(_t text) returns text language sql as 'select _t';
 comment on function comment_param_type_query1(text) is '
 HTTP
-RequestParamType QueryString
+request_param_type query_string
 ';
 
 create function comment_param_type_query2(_t text) returns text language sql as 'select _t';
 comment on function comment_param_type_query2(text) is '
 HTTP
-ParamType Query
+param_type query
 ';
 
 create function comment_get_param_type_json1(_t text) returns text language sql as 'select _t';
 comment on function comment_get_param_type_json1(text) is '
 HTTP
-RequestParamType BodyJson
+request_param_type body_json
 ';
 
 create function comment_get_param_type_json2(_t text) returns text language sql as 'select _t';
 comment on function comment_get_param_type_json2(text) is '
 HTTP
-ParamType Json
+param_type BODY
 ';
 ");
     }
diff --git a/NpgsqlRestTests/ConnectionNameTests/ConnectionNameTests.cs b/NpgsqlRestTests/ConnectionNameTests/ConnectionNameTests.cs
@@ -23,7 +23,7 @@ from pg_stat_activity
 where pid = pg_backend_pid();
 $$;
 
-comment on function get_conn1_connection_name() is 'ConnectionName conn1';
+comment on function get_conn1_connection_name() is 'connection_name conn1';
 
 create function get_conn2_connection_name() 
 returns text 
@@ -34,7 +34,7 @@ from pg_stat_activity
 where pid = pg_backend_pid();
 $$;
 
-comment on function get_conn2_connection_name() is 'ConnectionName conn2';
+comment on function get_conn2_connection_name() is 'connection_name conn2';
 
 create function get_conn3_connection_name() 
 returns text 
@@ -45,7 +45,7 @@ from pg_stat_activity
 where pid = pg_backend_pid();
 $$;
 
-comment on function get_conn3_connection_name() is 'ConnectionName conn3';
+comment on function get_conn3_connection_name() is 'connection_name conn3';
 ");
     }
 }
diff --git a/NpgsqlRestTests/ConnectionNameTests/ConnectionNameUsingParamsTests.cs b/NpgsqlRestTests/ConnectionNameTests/ConnectionNameUsingParamsTests.cs
@@ -36,7 +36,7 @@ from pg_stat_activity
 where pid = pg_backend_pid();
 $$;
 
-comment on function get_conn3_connection_name_p() is 'connection-name=conn3';
+comment on function get_conn3_connection_name_p() is 'connection_name=conn3';
 ");
     }
 }
diff --git a/NpgsqlRestTests/NullHandlingTests.cs b/NpgsqlRestTests/NullHandlingTests.cs
@@ -9,33 +9,33 @@ public static void NullHandlingTests()
         create function get_null1() returns text language sql as 'select null';
 
         create function get_null2() returns text language sql as 'select null';
-        comment on function get_null2() is 'response-null-handling emptystring';
+        comment on function get_null2() is 'response_null_handling empty_string';
 
         create function get_null3() returns text language sql as 'select null';
-        comment on function get_null3() is 'response-null-handling nullliteral';
+        comment on function get_null3() is 'response_null_handling null_literal';
 
         create function get_null4() returns text language sql as 'select null';
-        comment on function get_null4() is 'response-null-handling nocontent';
+        comment on function get_null4() is 'response_null_handling no_content';
 
         create function get_nullable_param1(_t text) returns text language sql as 'select _t';
-        comment on function get_nullable_param1(text) is 'response-null-handling nocontent';
+        comment on function get_nullable_param1(text) is 'response_null_handling no_content';
 
         create function get_nullable_param2(_t text) returns text language sql as 'select _t';
         comment on function get_nullable_param2(text) is '
-        response-null-handling nocontent
-        query-string-null-handling ignore
+        response_null_handling no_content
+        query_string_null_handling ignore
         ';
 
         create function get_nullable_param3(_t text) returns text language sql as 'select _t';
         comment on function get_nullable_param3(text) is '
-        response-null-handling nocontent
-        query-string-null-handling EmptyString
+        response_null_handling no_content
+        query_string_null_handling empty_string
         ';
 
         create function get_nullable_param4(_t text) returns text language sql as 'select _t';
         comment on function get_nullable_param4(text) is '
-        response-null-handling nocontent
-        query-string-null-handling NullLiteral
+        response_null_handling no_content
+        query_string_null_handling null_literal
         ';
         """);
     }
diff --git a/NpgsqlRestTests/RawContentTests/RawDownloadTests.cs b/NpgsqlRestTests/RawContentTests/RawDownloadTests.cs
@@ -23,7 +23,7 @@ select sub.*
         comment on function header_template_response1(text, text) is '
         raw
         separator ,
-        newline \n
+        new_line \n
         Content-Type: {_type}
         Content-Disposition: attachment; filename={_file}
         ';
@@ -45,7 +45,7 @@ select sub.*
         comment on function header_template_response2(text, text) is '
         raw
         separator ,
-        newline \n
+        new_line \n
         Content-Type: {type}
         Content-Disposition: attachment; filename={file}
         ';
diff --git a/NpgsqlRestTests/RawContentTests/RawResponseTests.cs b/NpgsqlRestTests/RawContentTests/RawResponseTests.cs
@@ -53,7 +53,7 @@ select sub.*
         comment on function raw_csv_separators_response1() is '
         raw
         separator ,
-        newline \n
+        new_line \n
         Content-Type: text/csv
         ';
 
@@ -73,7 +73,7 @@ select sub.*
         comment on function raw_csv_separators_with_headers_response1() is '
         raw
         separator ,
-        newline \n
+        new_line \n
         column_names
         Content-Type: text/csv
         ';
diff --git a/NpgsqlRestTests/RawContentTests/RawResponseUsingParamsTests.cs b/NpgsqlRestTests/RawContentTests/RawResponseUsingParamsTests.cs
@@ -72,7 +72,7 @@ select sub.*
         $$;
         comment on function raw_csv_separators_with_headers_response2() is '
         raw=true
-        raw-separator=,
+        raw_separator=,
         raw_new_line=\n
         column_names=true
         Content-Type: text/csv
diff --git a/NpgsqlRestTests/RequestHeadersTests.cs b/NpgsqlRestTests/RequestHeadersTests.cs
@@ -10,33 +10,33 @@ public static void RequestHeadersTests()
 create function get_req_headers_context() returns text language sql as 'select current_setting(''request.headers'', true)';
 comment on function get_req_headers_context() is '
 HTTP
-RequestHeaders Context
+request_headers context
 ';
 
 create function get_req_headers_parameter1(_headers text = null) returns text language sql as 'select _headers';
 comment on function get_req_headers_parameter1(text) is '
 HTTP
-request-headers parameter
+request_headers parameter
 ';
 
 create function get_req_headers_parameter2(headers text = null) returns text language sql as 'select headers';
 comment on function get_req_headers_parameter2(text) is '
 HTTP
-request-headers parameter
+request_headers parameter
 ';
 
 create function get_req_headers_parameter3(h text = null) returns text language sql as 'select h';
 comment on function get_req_headers_parameter3(text) is '
 HTTP
-request-headers parameter
-request-headers-parameter-name h
+request_headers parameter
+request_headers_parameter_name h
 ';
 
 create function get_req_headers_param_not_default(_not_default text) returns text language sql as 'select _not_default';
 comment on function get_req_headers_param_not_default(text) is '
 HTTP
-request-headers parameter
-request-headers-parameter-name _not_default
+request_headers parameter
+request_headers_parameter_name _not_default
 ';
 
 create function req_headers_parameter1(_headers text = null) returns text language sql as 'select _headers';
@@ -54,15 +54,15 @@ request_headers parameter
 create function req_headers_parameter3(h text = null) returns text language sql as 'select h';
 comment on function req_headers_parameter3(text) is '
 HTTP
-request-headers parameter
+request_headers parameter
 request_headers_parameter_name h
 ';
 
 create function req_headers_param_not_default(_not_default text) returns text language sql as 'select _not_default';
 comment on function req_headers_param_not_default(text) is '
 HTTP
-request-headers parameter
-request-headers-parameter-name _not_default
+request_headers parameter
+request_headers_parameter_name _not_default
 ';
 ");
     }

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ from pg_stat_activity`
`36`	`36`	`where pid = pg_backend_pid();`
`37`	`37`	`$$;`
`38`	`38`
`39`		`-comment on function get_conn3_connection_name_p() is 'connection-name=conn3';`
	`39`	`+comment on function get_conn3_connection_name_p() is 'connection_name=conn3';`
`40`	`40`	`");`
`41`	`41`	`}`
`42`	`42`	`}`