Renaming property to make its intent more explicit

config/kibana.yml

@@ -64,7 +64,7 @@
 # List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side
 # headers, set this value to null, not []. Setting it to [] will send the default list
 # of headers.
-# elasticsearch.requestHeaders: [ authorization ]
+# elasticsearch.requestHeadersWhitelist: [ authorization ]
 
 # Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable.
 # elasticsearch.shardTimeout: 0

docs/kibana-yml.asciidoc

@@ -29,7 +29,7 @@ to `false`.
 wait for Elasticsearch to respond to pings.
 `elasticsearch.requestTimeout:`:: *Default: 300000* Time in milliseconds to wait for responses from the back end or 
 Elasticsearch. This value must be a positive integer.
-`elasticsearch.requestHeaders:`:: *Default: `[ 'authorization' ]`* List of Kibana client-side headers to send to Elasticsearch.
+`elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List of Kibana client-side headers to send to Elasticsearch.
 To send *no* client-side headers, set this value to null, not []. Setting it to [] will send the default list of headers.
 `elasticsearch.shardTimeout:`:: *Default: 0* Time in milliseconds for Elasticsearch to wait for responses from shards. Set
 to 0 to disable.

docs/settings.asciidoc

@@ -376,7 +376,7 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2
 + 
 *default*: `500000`
 
-`elasticsearch.requestHeaders:` added[5.0]:: List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side headers, set this value to null, not []. Setting it to [] will send the default list of headers.
+`elasticsearch.requestHeadersWhitelist:` added[5.0]:: List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side headers, set this value to null, not []. Setting it to [] will send the default list of headers.
 +
 *default*: `[ 'authorization' ]`
 

src/plugins/elasticsearch/index.js

@@ -22,7 +22,7 @@ module.exports = function ({ Plugin }) {
         password: string(),
         shardTimeout: number().default(0),
         requestTimeout: number().default(30000),
-        requestHeaders: array().items().single().default(DEFAULT_REQUEST_HEADERS),
+        requestHeadersWhitelist: array().items().single().default(DEFAULT_REQUEST_HEADERS),
         pingTimeout: number().default(ref('requestTimeout')),
         startupTimeout: number().default(5000),
         ssl: object({

src/plugins/elasticsearch/lib/__tests__/map_uri.js

@@ -11,7 +11,7 @@ describe('plugins/elasticsearch', function () {
     beforeEach(function () {
       const get = sinon.stub()
       .withArgs('elasticsearch.url').returns('http://foobar:9200')
-      .withArgs('elasticsearch.requestHeaders').returns(['x-my-custom-HEADER', 'Authorization']);
+      .withArgs('elasticsearch.requestHeadersWhitelist').returns(['x-my-custom-HEADER', 'Authorization']);
       const config = function () { return { get: get }; };
       server = {
         config: config

src/plugins/elasticsearch/lib/call_with_request.js

@@ -7,7 +7,7 @@ import filterHeaders from './filter_headers';
 
 module.exports = (server, client) => {
   return (req, endpoint, params = {}) => {
-    const filteredHeaders = filterHeaders(req.headers, server.config().get('elasticsearch.requestHeaders'));
+    const filteredHeaders = filterHeaders(req.headers, server.config().get('elasticsearch.requestHeadersWhitelist'));
     _.set(params, 'headers', filteredHeaders);
     const path = toPath(endpoint);
     const api = _.get(client, path);

src/plugins/elasticsearch/lib/map_uri.js

@@ -14,7 +14,7 @@ module.exports = function mapUri(server, prefix) {
     }
     const query = querystring.stringify(request.query);
     if (query) url += '?' + query;
-    const filteredHeaders = filterHeaders(request.headers, server.config().get('elasticsearch.requestHeaders'));
+    const filteredHeaders = filterHeaders(request.headers, server.config().get('elasticsearch.requestHeadersWhitelist'));
     done(null, url, filteredHeaders);
   };
 };