Add TSdoc

elastic · Feb 16, 2021 · 3026eb8 · 3026eb8
1 parent 68bc751
commit 3026eb8
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/x-pack/plugins/security/server/authorization/validate_es_response.ts b/x-pack/plugins/security/server/authorization/validate_es_response.ts
@@ -8,6 +8,11 @@
 import { schema } from '@kbn/config-schema';
 import { HasPrivilegesResponse } from './types';
 
+/**
+ * Validates an Elasticsearch "Has privileges" response against the expected application, actions, and resources.
+ *
+ * Note: the `actions` and `resources` parameters must be unique string arrays; any duplicates will cause validation to fail.
+ */
 export function validateEsPrivilegeResponse(
   response: HasPrivilegesResponse,
   application: string,