Cleanup

Author: SiloGecho97

.gitignore

@@ -30,4 +30,4 @@
 
 # Ignore master key for decrypting credentials and more.
 /config/master.key
-.byebug_history
+.byebug_history

Gemfile

@@ -35,7 +35,6 @@ gem "thruster", require: false
 # Use Rack CORS for handling Cross-Origin Resource Sharing (CORS), making cross-origin Ajax possible
 # gem "rack-cors"
 gem "committee"
-gem "openapi_first"
 gem "scalar_ruby", "~> 1.1"
 
 group :development, :test do

Gemfile.lock

@@ -106,7 +106,6 @@ GEM
       raabro (~> 1.4)
     globalid (1.2.1)
       activesupport (>= 6.1)
-    hana (1.3.7)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     io-console (0.8.0)
@@ -116,11 +115,6 @@ GEM
       reline (>= 0.4.2)
     json (2.10.2)
     json_schema (0.21.0)
-    json_schemer (2.4.0)
-      bigdecimal
-      hana (~> 1.3)
-      regexp_parser (~> 2.0)
-      simpleidn (~> 0.2)
     kamal (2.5.3)
       activesupport (>= 7.0)
       base64 (~> 0.2)
@@ -168,13 +162,6 @@ GEM
       racc (~> 1.4)
     nokogiri (1.18.3-x86_64-linux-gnu)
       racc (~> 1.4)
-    openapi_first (2.4.0)
-      hana (~> 1.3)
-      json_schemer (>= 2.1, < 3.0)
-      openapi_parameters (>= 0.3.3, < 2.0)
-      rack (>= 2.2, < 4.0)
-    openapi_parameters (0.4.0)
-      rack (>= 2.2)
     openapi_parser (2.2.4)
     ostruct (0.6.1)
     parallel (1.26.3)
@@ -265,7 +252,6 @@ GEM
     ruby-progressbar (1.13.0)
     scalar_ruby (1.1.0)
     securerandom (0.4.1)
-    simpleidn (0.2.3)
     solid_cable (3.0.7)
       actioncable (>= 7.2)
       activejob (>= 7.2)
@@ -323,7 +309,6 @@ DEPENDENCIES
   committee
   debug
   kamal
-  openapi_first
   puma (>= 5.0)
   rails (~> 8.0.2)
   rubocop-rails-omakase

docs/openapi.json

@@ -67,7 +67,7 @@
                 "schema": {
                   "type": "object",
                   "properties": {
-                    "id": { "type": "string" },
+                    "id": { "type": "number" },
                     "message": { "type": "string" },
                     "created_at": { "type": "string", "format": "date-time" },
                     "updated_at": { "type": "string", "format": "date-time" }

lib/open_api_schema/request_validator_middleware.rb

@@ -6,12 +6,12 @@ def initialize(app)
       @request_validator = Committee::Middleware::RequestValidation.new(app, schema_path: "docs/openapi.json", strict_reference_validation: true,  coerce_date_times: true,  params_key: "action_dispatch.request.request_parameters", query_hash_key: "action_dispatch.request.query_parameters")
     end
 
-    # Handles the middleware call to validate the schema if the "Validate-Schema" header is present.
-    # If the header is set to "1", it validates the request and response schema.
+    # Handles the middleware call to validate the schema if the "VALIDATE_SCHEMA" header is present.
+    # If the header is set to "1", it validates the request schema.
     # Otherwise, it continues the request-response cycle as usual.
     #
     # @param env [Hash] The Rack environment hash.
-    # @return [Array] The status, headers, and body of the response.
+    # @return [Array] The status, headers, and response.
     def call(env)
       status, headers, response = @app.call(env)
 

lib/open_api_schema/response_validator_middleware.rb

@@ -1,17 +1,19 @@
 
 module OpenApiSchema
   class ResponseValidatorMiddleware
+    # Initializes the middleware with the given Rack application and sets up the response validator.
+    #
+    # @param app [Object] The Rack application.
     def initialize(app)
       @app = app
       @response_validator = Committee::Middleware::ResponseValidation.new(app, schema_path: "docs/openapi.json", strict_reference_validation: true)
     end
 
-    # Handles the middleware call to validate the schema if the "Validate-Schema" header is present.
-    # If the header is set to "1", it validates the request and response schema.
-    # Otherwise, it continues the request-response cycle as usual.
+    # Handles the middleware call to validate the schema if the "VALIDATE_SCHEMA" header is present.
+    # If the header is set to "1", it validates the response schema.
     #
     # @param env [Hash] The Rack environment hash.
-    # @return [Array] The status, headers, and body of the response.
+    # @return [Array] The status, headers, and response.
     def call(env)
       status, headers, response = @app.call(env)
 
@@ -24,6 +26,10 @@ def call(env)
 
     private
 
+    # Checks if the "Validate-Schema" header is present in the environment hash.
+    #
+    # @param env [Hash] The Rack environment hash.
+    # @return [Boolean] True if the "Validate-Schema" header is present, false otherwise.
     def condition_for_response_validation?(env)
       env.key?("HTTP_VALIDATE_SCHEMA")
     end