feat: doc comment with clarification of console_logs blacklistedHeaders and hideList

This commit is contained in:
Aliaksei Tratseuski 2024-06-19 18:01:13 +04:00
parent 82a606e320
commit 3fc3a6e7f4
2 changed files with 7 additions and 0 deletions

View file

@ -71,6 +71,9 @@ class RestApiRequestConsoleLog extends ConsoleLog {
super.severity,
});
/// headers thath should not be included into clipboard buffer, as opposed to
/// `[[ConsoleLogItemDialog]]` `_KeyValueRow.hideList` which filters values,
/// that should be accessible from UI, but hidden in screenshots
static const blacklistedHeaders = ['Authorization'];
final String? method;

View file

@ -202,6 +202,10 @@ class _SectionRow extends StatelessWidget {
class _KeyValueRow extends StatelessWidget {
const _KeyValueRow(this.title, this.value);
/// headers thath should be hidden in screenshots, but still accessible for
/// user, as opposed to `[[ConsoleLog]]`
/// `RestApiRequestConsoleLog.blacklistedHeaders` which need to be filtered
/// out from clipboard content
static const List<String> hideList = ['Authorization'];
final String title;