Skip to content

Commit

Permalink
Recommend doc for API about dynamic response
Browse files Browse the repository at this point in the history
  • Loading branch information
MrAlias committed May 17, 2024
1 parent 2086848 commit f924735
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions specification/logs/bridge-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ that want to optimize memory or handle indeterminable states the flexibility
they need. If an implementation does not need this flexibility, it SHOULD
return `false` when logging is disabled for the provided arguments.

The returned value is not always static, it can change over time. The API
SHOULD be documented that users needs to call this API each time they generate
a `LogRecord` to ensure they have the most up-to-date response.

## Optional and required parameters

The operations defined include various parameters, some of which are marked
Expand Down

0 comments on commit f924735

Please sign in to comment.