add language client examples to YAML files

Author: miguelgrinberg

Makefile

@@ -43,6 +43,7 @@ setup:	## Install dependencies for contrib target
 	@npm install --prefix validator
 	@npm install --prefix specification
 	@npm install @redocly/cli
+	@npm install --prefix docs/examples
 
 clean-dep:	## Clean npm dependencies
 	@rm -rf compiler/node_modules
@@ -74,6 +75,9 @@ overlay-docs: ## Apply overlays to OpenAPI documents
 	rm output/openapi/elasticsearch-serverless-openapi.tmp*.json
 	rm output/openapi/elasticsearch-openapi.tmp*.json
 
+generate-language-examples:
+	@node docs/examples/generate-language-examples.js
+
 lint-docs: ## Lint the OpenAPI documents after overlays
 	@npx @redocly/cli lint "output/openapi/elasticsearch-*.json" --config "docs/linters/redocly.yaml" --format stylish --max-problems 500
 

docs/examples/generate-language-examples.js

@@ -0,0 +1,57 @@
+const fs = require('fs');
+const path = require('path');
+const { parseDocument: yamlParseDocument } = require('yaml');
+const { convertRequests } = require('@elastic/request-converter');
+
+const LANGUAGES = ['Python', 'JavaScript', 'Ruby', 'PHP', 'curl'];
+
+async function generateLanguages(example) {
+  const doc = yamlParseDocument(await fs.promises.readFile(example, 'utf8'));
+  const data = doc.toJS();
+  let request = data.method_request;
+  if (data.value) {
+    if (typeof data.value === 'string') {
+      request += '\n' + data.value;
+    }
+    else {
+      request += '\n' + JSON.stringify(data.value);
+    }
+  }
+  data.alternatives = {};
+  for (const lang of LANGUAGES) {
+    data.alternatives[lang] = (await convertRequests(request, lang, {})).trim();
+  }
+  doc.delete('alternatives');
+  doc.add(doc.createPair('alternatives', data.alternatives));
+  await fs.promises.writeFile(example, doc.toString());
+}
+
+async function* walkExamples(dir) {
+  for await (const d of await fs.promises.opendir(dir)) {
+    const entry = path.join(dir, d.name);
+    if (d.isDirectory()) {
+      yield* walkExamples(entry);
+    }
+    else if (d.isFile() && entry.includes('/examples/request/') && entry.endsWith('.yaml')) {
+      yield entry;
+    }
+  }
+}
+
+async function main() {
+  let count = 0;
+  let errors = 0;
+  for await (const example of walkExamples('./specification/')) {
+    try {
+      await generateLanguages(example);
+    }
+    catch (err) {
+      console.log(`${example}: ${err}`);
+      errors += 1;
+    }
+    count += 1;
+  }
+  console.log(`${count} examples processed, ${errors} errors.`);
+}
+
+main();