Generate OpenAPI schema for Elasticsearch Serverless

.github/check-license-headers.sh

@@ -27,13 +27,13 @@ function check_license_header {
 
 cd "$TOP"
 nErrors=0
-for f in $(git ls-files | grep '\.ts$'); do
+for f in $(git ls-files | grep -v schema-wasm-lib/pkg | grep '\.ts$'); do
     if ! check_license_header $f; then
         nErrors=$((nErrors+1))
     fi
 done
 
-for f in $(git ls-files | grep '\.js$'); do
+for f in $(git ls-files | grep -v schema-wasm-lib/pkg |grep '\.js$'); do
     if ! check_license_header $f; then
         nErrors=$((nErrors+1))
     fi

Makefile

@@ -47,10 +47,13 @@ clean-dep:	## Clean npm dependencies
 transform-expand-generics: ## Create a new schema with all generics expanded
 	@npm run transform-expand-generics --prefix compiler
 
+transform-to-openapi: ## Generate the OpenAPI definition from the compiled schema
+	@npm run transform-to-openapi --prefix compiler
+
 dump-routes: ## Create a new schema with all generics expanded
 	@npm run dump-routes --prefix compiler
 
-contrib: | generate license-check spec-format-fix 	## Pre contribution target
+contrib: | generate license-check spec-format-fix transform-to-openapi ## Pre contribution target
 
 bump:
 	@echo ">> bumping..."

compiler/package.json

@@ -10,6 +10,7 @@
     "format:fix": "prettier --config .prettierrc.json --write ../specification/",
     "generate-schema": "ts-node src/index.ts",
     "transform-expand-generics": "ts-node src/transform/expand-generics.ts",
+    "transform-to-openapi": "ts-node src/transform/schema-to-openapi.ts",
     "filter-by-availability": "ts-node src/transform/filter-by-availability.ts",
     "dump-routes": "ts-node src/dump/extract-routes.ts",
     "compile:specification": "tsc --project ../specification/tsconfig.json --noEmit",
@@ -36,6 +37,7 @@
     "fastest-levenshtein": "^1.0.12",
     "ora": "^5.4.1",
     "safe-stable-stringify": "^2.3.1",
+    "schema-wasm-lib": "file:../openapi-converter/schema-wasm-lib/pkg",
     "semver": "^7.5.2",
     "ts-morph": "^13.0.3",
     "zx": "^4.3.0"

compiler/src/transform/schema-to-openapi.ts

@@ -0,0 +1,39 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { convert_schema_to_openapi } from 'schema-wasm-lib'
+import { argv } from 'zx'
+import { join } from 'path'
+import { readFileSync, writeFileSync } from 'fs'
+
+const inputPath = argv.input ?? join(__dirname, '..', '..', '..', 'output', 'schema', 'schema.json')
+const outputPath = argv.output ?? join(__dirname, '..', '..', '..', 'output', 'openapi', 'elasticsearch-serverless-openapi.json')
+
+const inputText = readFileSync(
+  inputPath,
+  { encoding: 'utf8' }
+)
+
+const output = convert_schema_to_openapi(inputText, 'serverless')
+
+writeFileSync(
+  outputPath,
+  output,
+  'utf8'
+)

openapi-converter/.gitignore

@@ -0,0 +1,2 @@
+.idea
+target