habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

force replace a bad link in generated docs

Browse Source
This commit is contained in:
spalger
2019-10-31 12:31:43 -07:00
parent a3d0999efd
commit 388c5e8e7e
2 changed files with 14 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api_methods.asciidoc
View File

@ -3694,7 +3694,7 @@ client.indices.flushSynced([params, [callback]])
// no description
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-flush.html#synced-flush-api[the elasticsearch docs] for more information pertaining to this method.
Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-synced-flush-api.html[the elasticsearch docs] for more information pertaining to this method.
// no examples
@ -3717,7 +3717,7 @@ Options:::
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string for all indices
`body`::
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-flush.html#synced-flush-api[the elasticsearch docs] for details about what can be specified here.
<<api-param-type-object,`Object`>>, <<api-param-type-json,`JSON`>> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-synced-flush-api.html[the elasticsearch docs] for details about what can be specified here.
link:#[back to top]

13
scripts/generate/js_api.js
View File

@ -188,9 +188,20 @@ module.exports = function(branch, done) {
done();
}
var patchBadLinks = {
'https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-flush.html#synced-flush-api':
'https://www.elastic.co/guide/en/elasticsearch/reference/7.4/indices-synced-flush-api.html',
};
function writeMethodDocs(done) {
var filename = fromRoot('docs/api_methods' + branchSuffix + '.asciidoc');
fs.writeFile(filename, templates.apiMethods(docVars), function(err) {
var content = templates.apiMethods(docVars);
for (const [bad, good] of Object.entries(patchBadLinks)) {
content = content.split(bad).join(good);
}
fs.writeFile(filename, content, function(err) {
if (!err) {
console.log(
chalk.white.bold('wrote'),