README.md in api-regulator-0.1.1 vs README.md in api-regulator-0.1.2
- old
+ new
@@ -46,13 +46,12 @@
Add the following to `config/initializers/api_regulator.rb`:
```ruby
ApiRegulator.configure do |config|
- config.base_controller = "Api::ApplicationController" # Set your base API controller
config.api_base_url = "/api/v1" # Set a common base path for your API endpoints
- config.docs_path = Rails.root.join("doc", "openapi.json").to_s # Path for OpenAPI JSON file
+ config.docs_path = Rails.root.join("doc").to_s # Path for folder for docs
config.app_name = "My API" # shows in docs
config.rdme_api_id = ENV["RDME_API_ID"] # Optional: ReadMe API ID for schema uploads
config.servers = [
{ url: "https://stg.example.com", description: "Staging", "x-default": true },
{ url: "https://example.com", description: "Production" }
@@ -109,10 +108,10 @@
## Shared Schemas
Define reusable schemas for common responses in your initializer:
```ruby
-ApiRegulator.shared_schema :validation_errors, "Validation error response" do
+ApiRegulator.register_shared_schema :validation_errors, "Validation error response" do
param :errors, :array, desc: "Array of validation errors", items_type: :string
end
```
Reference the shared schema in your responses: