Skip to content

Commit

Permalink
docs(servient): expand addCredentials documentation
Browse files Browse the repository at this point in the history
The use of the `definitionKey` parameter is now better
documented.
  • Loading branch information
JKRhb committed Mar 10, 2022
1 parent 44aee60 commit 5115a56
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lib/src/core/servient.dart
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ class Servient {
}

/// Adds new [credentials] to this [Servient].
///
/// The [definitionKey] must refer to an entry of the `securityDefinitions`
/// map of a TD, while the [credentials] have to match the type of the
/// Security Scheme they are being assigned to. Otherwise they will be
/// ignored.
void addCredentials(
String id, String definitionKey, Credentials credentials) {
final currentCredentials = _credentialsStore[id];
Expand Down

0 comments on commit 5115a56

Please sign in to comment.