From 917a4e338f7fafa87fc1121806c21491e05a42d5 Mon Sep 17 00:00:00 2001 From: Tomas Della Vedova Date: Mon, 13 Jan 2020 12:21:39 +0100 Subject: [PATCH] Updated api reference header comment (#1049) --- scripts/utils/generateDocs.js | 42 ++++++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 8 deletions(-) diff --git a/scripts/utils/generateDocs.js b/scripts/utils/generateDocs.js index 28b060be4..4261520d2 100644 --- a/scripts/utils/generateDocs.js +++ b/scripts/utils/generateDocs.js @@ -15,6 +15,39 @@ const codeExamples = readdirSync(join(__dirname, '..', '..', 'docs', 'examples') function generateDocs (common, spec) { var doc = dedent` [[api-reference]] + + //////// + + + + =========================================================================================================================== + || || + || || + || || + || ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ || + || ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ || + || ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ || + || ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ || + || ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ || + || ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ || + || || + || || + || This file is autogenerated, DO NOT send pull requests that changes this file directly. || + || You should update the script that does the generation, which can be found in '/scripts/utils/generateDocs.js'. || + || || + || You can run the script with the following command: || + || node scripts/generate --branch || + || or || + || node scripts/generate --tag || + || || + || || + || || + =========================================================================================================================== + + + + //////// + == API Reference This document contains the entire list of the Elasticsearch API supported by the client, both OSS and commercial. The client is entirely licensed under Apache 2.0. @@ -53,14 +86,7 @@ function generateDocs (common, spec) { In this document, you will find the reference of every parameter accepted by the querystring or the url. If you also need to send the body, you can find the documentation of its format in the reference link that is present along with every endpoint. - //////// - - This documentation is generated by running: - node scripts/run.js --tag tagName - or - node scripts/run.js --branch branchName - - ////////\n\n` + \n\n` doc += commonParameters(common) spec.forEach(s => { doc += '\n' + generateApiDoc(s)