Add openapi conversion in the "contrib" target, misc cleanup

Author: swallez

.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/src/transform/schema-to-openapi.ts

@@ -1,9 +1,27 @@
+/*
+ * 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')
 

openapi-converter/Makefile

@@ -0,0 +1,10 @@
+REQUIRED_BINS := wasm-pack cargo
+$(foreach bin,$(REQUIRED_BINS),\
+    $(if $(shell command -v $(bin) 2> /dev/null),,$(error Please install `$(bin)`)))
+
+.PHONY: schema-wasm-lib
+
+schema-wasm-lib:
+	wasm-pack build --release -t nodejs schema-wasm-lib
+	# we do commit the result in git
+	rm schema-wasm-lib/pkg/.gitignore

openapi-converter/README.md

@@ -1,8 +1,14 @@
-# Elasticsearch Rust client generator and other code-generation utilities written in Rust.
+# Rust API schema manipulation utilities
 
-Workspace members:
+This directory contains a set of Rust crates to manipulate and transform the API specification's `schema.json` file. The primary feature is conversion of `schema.json` to an OpenAPI schema for Elasticsearch Serverless.
+
+## Workspace members
 
 * [`clients_schema`](./clients_schema/): a Rust implementation of the [Elasticsearch specification schema](https://github.com/elastic/elasticsearch-specification/blob/main/compiler/src/model/metamodel.ts) metamodel.
 * [`clients_schema_to_openapi`](./clients_schema_to_openapi): conversion of the `schema.json` format to OpenAPI. Supersedes [elasticsearch-openapi](https://github.com/elastic/elasticsearch-openapi).
-* [`openapi_to_clients_schema`](./openapi_to_clients_schema): experimental, translate an OpenAPI specification to an Elasticsearch 
-  schema that can be used as input for code generation.
+* [`schema-wasm-lib`](./schema-wasm-lib): a WebAssembly library that exposes features of this workspace, to allow its use from the larger [schema toolchain](../compiler). 
+* [`openapi_to_clients_schema`](./openapi_to_clients_schema): experimental, incomplete, work in progress: translate an OpenAPI specification to an Elasticsearch schema that can be used as input for code generation.
+
+## Building
+
+The output of this directory is the `schema-wasm-lib` WebAssembly library. It must be built and committed in this repository every time the Rust code is changed.

openapi-converter/clients_schema_to_openapi/.spectral.yaml

@@ -4,7 +4,7 @@ extends: ["spectral:oas"]
 
 # Silence some rules
 rules:
-  operation-tags: off   # Operation must have non-empty "tags" array.
-  oas3-api-servers: off # OpenAPI "servers" must be present and non-empty array.
-  info-contact: off     # Info object must have "contact" object.
-  info-description: off # Info "description" must be present and non-empty string
+  oas3-api-servers: off      # OpenAPI "servers" must be present and non-empty array.
+  info-contact: off          # Info object must have "contact" object.
+  info-description: off      # Info "description" must be present and non-empty string.
+  operation-tag-defined: off # Operation tags must be defined in global tags.