add additional comments around the signer for the permissions DWN api

decentralized-identity · Aug 14, 2024 · 9ab0463 · 9ab0463
1 parent bec2b03
commit 9ab0463
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/packages/api/src/dwn-api.ts b/packages/api/src/dwn-api.ts
@@ -340,6 +340,11 @@ export class DwnApi {
    * API to interact with Grants
    *
    * NOTE: This is an EXPERIMENTAL API that will change behavior.
+   *
+   * Currently only supports issuing requests, grants, revokes and queries on behalf without permissions or impersonation.
+   * If the agent is connected to a delegateDid, the delegateDid will be used to sign/author the underlying records.
+   * If the agent is not connected to a delegateDid, the connectedDid will be used to sign/author the underlying records.
+   *
    * @beta
    */
   get permissions() {