Added config.d.ts entry with secrets for the shared auth block

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2024-02-29 14:33:04 +01:00
parent f235ca7982
commit e1f73d091e
2 changed files with 32 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-search-backend-module-elasticsearch': patch
---
Added config.d.ts entry with secrets for the shared auth block
+27
View File
@@ -212,6 +212,33 @@ export interface Config {
};
}
);
/**
* Authentication credentials for ElasticSearch. These are fallback
* credentials - in most cases, for known specific ES implementations, the
* respective auth block inside the clientOptions above will be used.
*
* If both ApiKey/Bearer token and username+password is provided, tokens
* take precedence
*/
auth?:
| {
username: string;
/**
* @visibility secret
*/
password: string;
}
| {
/**
* Base64 Encoded API key to be used to connect to the cluster.
* See: https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html
*
* @visibility secret
*/
apiKey: string;
};
};
};
}