Document the ruby spec validator.

Signed-off-by: dblock <[email protected]>
opensearch-project · Nov 4, 2024 · 04716ca · 04716ca
1 parent fc4730c
commit 04716ca
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -28,6 +28,7 @@
     - [Test Tools (Integration)](#test-tools-integration)
     - [Validate Spec (Lint)](#validate-spec-lint)
     - [Validate Spec (Python)](#validate-spec-python)
+    - [Validate Spec (Ruby)](#validate-spec-ruby)
 <!-- TOC -->
 
 # Developer Guide
@@ -383,3 +384,7 @@ This workflow runs on PRs to invoke the [spec linter](#spec-linter) and ensure t
 ### [Validate Spec (Python)](.github/workflows/validate-spec-py.yml)
 
 This workflow runs on PRs to invoke the [Python openapi-spec-validator](https://pypi.org/project/openapi-spec-validator/) to ensure that the resulting spec can be loaded by Python tools.
+
+### [Validate Spec (Ruby)](.github/workflows/validate-spec-ruby.yml)
+
+This workflow runs on PRs to invoke the Ruby [Json Schemer](https://github.com/davishmcclurg/json_schemer/) to ensure that the resulting spec can be loaded by Ruby tools.
diff --git a/tools/src/validate-spec-ruby/validate.rb b/tools/src/validate-spec-ruby/validate.rb
@@ -11,7 +11,7 @@
 
 total_errors = 0
 schemer.validate.each do |error|
-  puts "#{error['data_pointer']}: #{error['error']}" # if total_errors < 100
+  puts "#{error['data_pointer']}: #{error['error']}" if total_errors < 10
   total_errors += 1
 end