artin/OBP-API
1
0
Fork 0
mirror of https://github.com/OpenBankProject/OBP-API.git synced 2026-02-06 11:27:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor/remove checkmark emojis from documentation and logging

Browse Source 
- Remove ✅ emoji prefixes from APIMethods600 API documentation comments
- Remove ✅ emoji prefixes from SecureLogging utility method documentation
- Remove ✅ emoji prefixes from Http4sResponseConversionPropertyTest validation summary output
- Improve readability and consistency by using plain text instead of emoji markers
- Ensure documentation maintains clarity without relying on visual emoji indicators
This commit is contained in:
hongwei 2026-02-04 00:48:38 +01:00
parent 444c23eaec
commit 3061689938
3 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
obp-api/src/main/scala/code/api/v6_0_0/APIMethods600.scala
View File

@ -2414,9 +2414,9 @@ trait APIMethods600 {
|- ❌ `exclude_implemented_by_partial_functions` - NOT supported (returns error)
|
|Use `include_*` parameters instead (all optional):
|- ✅ `include_app_names` - Optional - include only these apps
|- ✅ `include_url_patterns` - Optional - include only URLs matching these patterns
|- ✅ `include_implemented_by_partial_functions` - Optional - include only these functions
|- `include_app_names` - Optional - include only these apps
|- `include_url_patterns` - Optional - include only URLs matching these patterns
|- `include_implemented_by_partial_functions` - Optional - include only these functions
|
|1 from_date e.g.:from_date=$DateWithMsExampleString
| **DEFAULT**: If not provided, automatically set to now - ${(APIUtil.getPropsValue("MappedMetrics.stable.boundary.seconds", "600").toInt - 1) / 60} minutes (keeps queries in recent data zone)

8
obp-api/src/main/scala/code/util/SecureLogging.scala
View File

@ -16,7 +16,7 @@ import scala.collection.mutable
object SecureLogging {
/**
* ✅ Conditional inclusion helper using APIUtil.getPropsAsBoolValue
* Conditional inclusion helper using APIUtil.getPropsAsBoolValue
*/
private def conditionalPattern(
prop: String,
@ -26,7 +26,7 @@ object SecureLogging {
}
/**
* ✅ Toggleable sensitive patterns
* Toggleable sensitive patterns
*/
private lazy val sensitivePatterns: List[(Pattern, String)] = {
val patterns = Seq(
@ -174,7 +174,7 @@ object SecureLogging {
}
/**
* ✅ Test method to demonstrate the masking functionality.
* Test method to demonstrate the masking functionality.
*/
def testMasking(): List[(String, String)] = {
val testMessages = List(
@ -198,7 +198,7 @@ object SecureLogging {
}
/**
* ✅ Print test results to console for manual verification.
* Print test results to console for manual verification.
*/
def printTestResults(): Unit = {
println("\n=== SecureLogging Test Results ===")

26
obp-api/src/test/scala/code/api/util/http4s/Http4sResponseConversionPropertyTest.scala
View File

@ -502,19 +502,19 @@ class Http4sResponseConversionPropertyTest extends FeatureSpec
info("Property 3: Response Conversion Completeness - VALIDATION SUMMARY")
info("=" * 80)
info("")
info("✅ InMemoryResponse status code preservation: 100/100 iterations")
info("✅ InMemoryResponse header preservation: 100/100 iterations")
info("✅ InMemoryResponse body preservation: 100/100 iterations")
info("✅ InMemoryResponse large body preservation: 100/100 iterations")
info("✅ InMemoryResponse Content-Type preservation: 100/100 iterations")
info("✅ StreamingResponse status and headers preservation: 100/100 iterations")
info("✅ StreamingResponse body preservation: 100/100 iterations")
info("✅ StreamingResponse callback invocation: 100/100 iterations")
info("✅ OutputStreamResponse status and headers preservation: 100/100 iterations")
info("✅ OutputStreamResponse body preservation: 100/100 iterations")
info("✅ OutputStreamResponse large body preservation: 100/100 iterations")
info("✅ BasicResponse status code preservation: 100/100 iterations")
info("✅ Comprehensive response conversion: 100/100 iterations")
info("InMemoryResponse status code preservation: 100/100 iterations")
info("InMemoryResponse header preservation: 100/100 iterations")
info("InMemoryResponse body preservation: 100/100 iterations")
info("InMemoryResponse large body preservation: 100/100 iterations")
info("InMemoryResponse Content-Type preservation: 100/100 iterations")
info("StreamingResponse status and headers preservation: 100/100 iterations")
info("StreamingResponse body preservation: 100/100 iterations")
info("StreamingResponse callback invocation: 100/100 iterations")
info("OutputStreamResponse status and headers preservation: 100/100 iterations")
info("OutputStreamResponse body preservation: 100/100 iterations")
info("OutputStreamResponse large body preservation: 100/100 iterations")
info("BasicResponse status code preservation: 100/100 iterations")
info("Comprehensive response conversion: 100/100 iterations")
info("")
info("Total Iterations: 1,300+")
info("Expected Success Rate: 100%")