oas_rails 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7aba5fe8b9983dd63d1ff69467c419f26ac1c0733737da6994d65542ff00a5c
-  data.tar.gz: 7df7cc51ffcdb2690c42a9aaa6eef1d13ede77a96f6ae5b97891be16cc76dae1
+  metadata.gz: 0c02c7a454cec38660f5d327e61f35c88e3d7ab22b4fc5c18adbed3707c656d7
+  data.tar.gz: 8fb227b665f88c0c6299f1a1bbd9d4c681f1438c13fa93e6f552cd96b1ef7a00
 SHA512:
-  metadata.gz: f01774e088f4edd899ec6fe02373f29ddf609c8102f4759f372d32ffa36798fa3f35ee3c2f6137d21063b51d22c8df94de9f1fbaa12c4ad198ff2150a92df16b
-  data.tar.gz: 15c21a08bb93729fc3c1f129a2b4008f44132cf01e9b10a58e72a8c867fc985bd3f3e3a4f32cab03ff621ceaa41e674b6d927047351b254f92a51111ad15a69c
+  metadata.gz: 2d30c6f893f17476716208e57311b2c290f99208431781085de77d97d9c6c2d5601df5c29e53155d485a3e2d1268383ca6151dd97ae629461db2b8c369df9cdc
+  data.tar.gz: 6b7edd8df46e2ea3b8c20fdbc41ceed453f560a0c619fed3138ae49a5366625e34b36fd0ee6c5d1aff549602c00ae2e4e1b880b58ae1e6f62ffed4c1578e4c6d

data/README.md

@@ -37,452 +37,9 @@ After experiencing the interactive documentation in Python's fast-api framework,
 
 The goal is to minimize the effort required to create comprehensive documentation. By following REST principles in Rails, we believe this is achievable. You can enhance the documentation using [Yard](https://yardoc.org/) tags.
 
-## 📋 Table of Contents
+## Documentation
 
-- [Installation](#installation)
-- [Configuration](#configuration)
-  - [Basic Information about the API](#basic-information-about-the-api)
-  - [Servers Information](#servers-information)
-  - [Tag Information](#tag-information)
-  - [Optional Settings](#optional-settings)
-  - [Authentication Settings](#authentication-settings)
-  - [Default Responses (Errors)](#default-responses)
-- [Usage](#usage)
-  - [Documenting Your Endpoints](#documenting-your-endpoints)
-  - [Example](#example-of-documented-endpoints)
-- [Securing the OasRails Engine](#securing-the-oasrails-engine)
-- [Customizing the View](#customizing-the-view)
-- [Contributing](#contributing)
-  - [Roadmap and Ideas for Improvement](#roadmap-and-ideas-for-improvement)
-- [License](#license)
-
-## Installation
-
-1. Add this line to your Rails application's Gemfile:
-
-   ```ruby
-   gem "oas_rails"`
-   ```
-
-2. Execute:
-
-   ```bash
-   bundle
-   ```
-
-3. Mount the engine in your config/routes.rb file
-
-   ```ruby
-   mount OasRails::Engine => '/docs'
-   ```
-
-You'll now have **basic documentation** based on your routes and automatically gathered information at `localhost:3000/docs`. To enhance it, create an initializer file and add [Yard](https://yardoc.org/) tags to your controller methods.
-
-## ⚙️ Configuration
-
-To configure OasRails, **you MUST create an initializer file** including all your settings. The first step is to create your initializer file, which you can easily do with:
-
-```bash
-rails generate oas_rails:config
-```
-
-Then fill it with your data. Below are the available configuration options:
-
-### Basic Information about the API
-
-- `config.info.title`: The title of your API documentation.
-- `config.info.summary`: A brief summary of your API.
-- `config.info.description`: A detailed description of your API. This can include markdown formatting and will be displayed prominently in your documentation.
-- `config.info.contact.name`: The name of the contact person or organization.
-- `config.info.contact.email`: The contact email address.
-- `config.info.contact.url`: The URL for more information or support.
-
-### Servers Information
-
-- `config.servers`: An array of server objects, each containing `url` and `description` keys. For more details, refer to the [OpenAPI Specification](https://spec.openapis.org/oas/latest.html#server-object).
-
-### Tag Information
-
-- `config.tags`: An array of tag objects, each containing `name` and `description` keys. For more details, refer to the [OpenAPI Specification](https://spec.openapis.org/oas/latest.html#tag-object).
-
-### Optional Settings
-
-- `config.default_tags_from`: Determines the source of default tags for operations. Can be set to `:namespace` or `:controller`.
-- `config.autodiscover_request_body`: Automatically detects request bodies for create/update methods. Default is `true`.
-- `config.autodiscover_responses`: Automatically detects responses from controller renders. Default is `true`.
-- `config.api_path`: Sets the API path if your API is under a different namespace.
-- `config.ignored_actions`: Sets an array with the controller or controller#action. No necessary to add api_path before.
-- `config.http_verbs`: Defaults to `[:get, :post, :put, :patch, :delete]`
-- `config.use_model_names`: Use model names when possible, defaults to `false`
-
-### Authentication Settings
-
-- `config.authenticate_all_routes_by_default`: Determines whether to authenticate all routes by default. Default is `true`.
-- `config.security_schema`: The default security schema used for authentication. Choose a predefined security schema from `[:api_key_cookie, :api_key_header, :api_key_query, :basic, :bearer, :bearer_jwt, :mutual_tls]`.
-- `config.security_schemas`: Custom security schemas. Follow the [OpenAPI Specification](https://spec.openapis.org/oas/latest.html#security-scheme-object) for defining these schemas.
-
-### Default Errors
-
-- `config.set_default_responses`: Determines whether to add default errors responses to endpoint. Default is `true`.
-
-- `config.possible_default_responses`: Array with possible default errors.(Some will be added depending on the endpoint, example: not_found only works with show/update/delete). Default: [:not_found, :unauthorized, :forbidden]. It should be HTTP status code symbols from the list: `[:not_found, :unauthorized, :forbidden, :internal_server_error, :unprocessable_entity]`
-
-- `config.response_body_of_default`: body for use in default responses. It must be a String hash like the used in request body tags. Default: "{ message: String }"
-
-## 📓 Usage
-
-In addition to the information provided in the initializer file and the data that can be extracted from the routes and methods automatically, it is essential to document your API in the following way. The documentation is created **with the help of YARD**, so the methods are documented with **comment tags**.
-
-### Documenting Your Endpoints
-
-Almost every tag description in an OAS file supports **markdown formatting** (e.g., bold, italics, lists, links) for better readability in the generated documentation. Additionally, **multi-line descriptions** are supported. When using multi-line descriptions, ensure the content is indented at least one space more than the tag itself to maintain proper formatting.
-
-For example:
-
-```ruby
-  # @request_body_example Simple User [Hash]
-  #   {
-  #     user: {
-  #       name: "Oas",
-  #       email: "oas@test.com",
-  #       password: "Test12345"
-  #     }
-  #   }
-```
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@summary</summary>
-
-**Structure**: `@summary text`
-
-Used to add a summary to the endpoint. It replaces the default summary/title of the endpoint.
-
-**Example**:
-
-`# @summary This endpoint creates a User`
-
-```
-# @summary This endpoint
-#   creates a User
-```
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@parameter</summary>
-
-**Structure**: `@parameter name(position) [type] text`
-
-Represents a parameter for the endpoint. The position can be: `header`, `path`, `cookie`, or `query`. The type should be a valid Ruby class: `String`, `Integer`, `Array<String>`, etc. Add a `!` before the class to indicate a required parameter.
-
-**Examples**:
-`# @parameter page(query) [Integer] The page number.`
-`# @parameter slug(path) [!String] Slug of the Project.`
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@request_body</summary>
-
-**Structure**: `@request_body text [type<structure>]`
-
-Documents the request body needed by the endpoint. The structure is optional if you provide a valid Active Record class. Use `!` to indicate a required request body.
-
-**One line example**:
-
-`# @request_body The user to be created [!User]`
-
-`# @request_body The user to be created [User]`
-
-**Multi-line example**:
-
-```ruby
-  # @request_body User to be created
-  #   [
-  #     !Hash{
-  #       user: Hash{
-  #         name: String,
-  #         email: String,
-  #         age: Integer,
-  #         cars: Array<
-  #           Hash{
-  #             identifier: String
-  #           }
-  #         >
-  #       }
-  #     }
-  #   ]
-```
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@request_body_example</summary>
-
-**Structure**: `@request_body_example text [type] structure`
-
-Adds examples to the provided request body.
-
-**One line example**:
-
-`# @request_body_example A complete User. [Hash] {user: {name: 'Luis', age: 30, password: 'MyWeakPassword123'}}`
-
-**Multi-line example**:
-
-```ruby
-  # @request_body_example basic user [Hash]
-  #   {
-  #     user: {
-  #       name: "Oas",
-  #       email: "oas@test.com",
-  #       password: "Test12345"
-  #     }
-  #   }
-```
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@response</summary>
-
-**Structure**: `@response text(code) [type<structure>]`
-
-Documents the responses of the endpoint and overrides the default responses found by the engine.
-
-**One line example**:
-
-`# @response User not found by the provided Id(404) [Hash{success: Boolean, message: String}]`
-
-`# @response Validation errors(422) [Hash{success: Boolean, errors: Array<Hash{field: String, type: String, detail: Array<String>}>}]`
-
-**Multi-line example**:
-
-```ruby
-  # @response A test response from an Issue(405)
-  #   [
-  #     Hash{
-  #       message: String,
-  #       data: Hash{
-  #         availabilities: Array<String>,
-  #         dates: Array<Date>
-  #       }
-  #     }
-  #   ]
-```
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@response_example</summary>
-
-**Structure**: `@response_example text(code) [String Hash]`
-
-Documents response examples of the endpoint associated to a response code.
-
-**One line example**:
-
-`# @response_example Invalida Email(422) [{success: "false", errors: [{field: "email", type: "email", detail: ["Invalid email"]}] }]`
-
-`# @response_example Id not exists (404) [{success: "false", message: "Nothing found with the provided ID." }]`
-
-**Multi-line example**:
-
-```ruby
-  # @response_example Another 405 Error (405) [Hash]
-  #   {
-  #     message: "another",
-  #     data: {
-  #       availabilities: [
-  #         "three"
-  #       ],
-  #       dates: []
-  #     }
-  #   }
-```
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@tag</summary>
-
-**Structure**: `@tag text`
-
-Tags your endpoints. You can complete the tag documentation in the initializer file by defining these tags beforehand. It's not necessary for the tag to exist in your initializer file before use.
-
-**Example**:
-`# @tag Users`
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@no_auth</summary>
-
-**Structure**: `@no_auth`
-
-This tag will remove any security requirement from the endpoint. Useful when most of your endpoints require authentication and only a few do not.(Ex: Login, Registration...)
-
-**Example**:
-`# @no_auth`
-
-</details>
-
-<details>
-<summary style="font-weight: bold; font-size: 1.2em;">@auth</summary>
-
-**Structure**: `@auth [types]`
-
-This tag will set which security mechanisms can be used for the endpoint. The security mechanisms MUST be defined previously in the initializer file.
-
-**Example**:
-`# @auth [bearer, basic]`
-
-</details>
-
-You can use these tags in your controller methods to enhance the automatically generated documentation. Remember to use markdown formatting in your descriptions for better readability in the generated OAS document.
-
-### Example of documented endpoints
-
-```ruby
-class UsersController < ApplicationController
-  before_action :set_user, only: %i[show update destroy]
-
-  # @summary Returns a list of Users.
-  #
-  # @parameter offset(query) [Integer]  Used for pagination of response data (default: 25 items per response). Specifies the offset of the next block of data to receive.
-  # @parameter status(query) [Array<String>]   Filter by status. (e.g. status[]=inactive&status[]=deleted).
-  # @parameter X-front(header) [String] Header for identify the front.
-  def index
-    @users = User.all
-  end
-
-  # @summary Get a user by id.
-  # @auth [bearer]
-  #
-  # This method show a User by ID. The id must exist of other way it will be returning a **`404`**.
-  #
-  # @parameter id(path) [Integer] Used for identify the user.
-  # @response Requested User(200) [Hash] {user: {name: String, email: String, created_at: DateTime }}
-  # @response User not found by the provided Id(404) [Hash] {success: Boolean, message: String}
-  # @response You don't have the right permission for access to this resource(403) [Hash] {success: Boolean, message: String}
-  def show
-    render json: @user
-  end
-
-  # @summary Create a User
-  # @no_auth
-  #
-  # @request_body The user to be created. At least include an `email`. [!User]
-  # @request_body_example basic user [Hash] {user: {name: "Luis", email: "luis@gmail.ocom"}}
-  def create
-    @user = User.new(user_params)
-
-    if @user.save
-      render json: @user, status: :created
-    else
-      render json: { success: false, errors: @user.errors }, status: :unprocessable_entity
-    end
-  end
-
-  # A `user` can be updated with this method
-  # - There is no option
-  # - It must work
-  # @tags users, update
-  # @request_body User to be created [!Hash{user: { name: String, email: !String, age: Integer, available_dates: Array<Date>}}]
-  # @request_body_example Update user [Hash] {user: {name: "Luis", email: "luis@gmail.com"}}
-  # @request_body_example Complete User [Hash] {user: {name: "Luis", email: "luis@gmail.com", age: 21}}
-  def update
-    if @user.update(user_params)
-      render json: @user
-    else
-      render json: @user.errors, status: :unprocessable_entity
-    end
-  end
-
-  # @summary Delete a User
-  # Delete a user and his associated data.
-  def destroy
-    @user.destroy!
-    redirect_to users_url, notice: 'User was successfully destroyed.', status: :see_other
-  end
-
-  private
-
-  # Use callbacks to share common setup or constraints between actions.
-  def set_user
-    @user = User.find(params[:id])
-  end
-
-  # Only allow a list of trusted parameters through.
-  def user_params
-    params.require(:user).permit(:name, :email)
-  end
-end
-```
-
-## 🔒Securing the OasRails Engine
-
-To secure the OasRails engine, which exposes an endpoint for showing the OAS definition, you can configure authentication to ensure that only authorized users have access. Here are a few methods to achieve this:
-
-### 1. Using Basic Authentication
-
-Use basic authentication to protect the OasRails endpoint. You can set this up in an initializer:
-
-```ruby
-# config/initializers/oas_rails.rb
-OasRails::Engine.middleware.use(Rack::Auth::Basic) do |username, password|
-  ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.oas_rails_username, username) &
-    ActiveSupport::SecurityUtils.secure_compare(Rails.application.credentials.oas_rails_password, password)
-end
-```
-
-### 2. Using Devise's `authenticate` Helper
-
-You can use Devise's `authenticate` helper to restrict access to the OasRails endpoint. For example, you can allow only admin users to access the endpoint:
-
-```ruby
-# config/routes.rb
-# ...
-authenticate :user, ->(user) { user.admin? } do
-  mount OasRails::Engine, at: '/docs'
-end
-```
-
-### 3. Custom Authentication
-
-To support custom authentication, you can extend the OasRails' ApplicationController using a hook. This allows you to add custom before actions to check for specific user permissions:
-
-```ruby
-# config/initializers/oas_rails.rb
-
-ActiveSupport.on_load(:oas_rails_application_controller) do
-  # context here is OasRails::ApplicationController
-
-  before_action do
-    raise ActionController::RoutingError.new('Not Found') unless current_user&.admin?
-  end
-
-  def current_user
-    # Load the current user
-    User.find(session[:user_id]) # Adjust according to your authentication logic
-  end
-end
-```
-
-## ⛏️ Customizing the View
-
-The OasRails engine provides an easy way to display your OpenAPI Specification (OAS) within your Rails application. By default, it includes an `index` view in the `OasRailsController` that displays [RapiDoc](https://rapidocweb.com/) through a CDN with default configurations. You can easily override this view to replace RapiDoc entirely or configure it differently.
-
-#### Overriding the `index` View
-
-To override the `index` view provided by the OasRails engine, follow these steps:
-
-1. **Create the Override View File**: In your host application, create a new file at the path `app/views/oas_rails/oas_rails/index.html.erb`. If the directories do not exist, you will need to create them.
-
-2. **Customize the View**: Open the newly created `index.html.erb` file and add your custom HTML and ERB code to display the OAS as desired. You can refer to the source code of this project for guidance.
-
-#### Using the Custom View
-
-Once the custom view file is in place, Rails will automatically use it instead of the view provided by the OasRails engine. This allows you to fully customize the presentation of the OAS without modifying the engine's code.
+For see how to install, configure and use OasRails please refere to the [OasRailsBook](http://a-chacon.com/oas_rails/book)
 
 ## Contributing
 
@@ -496,17 +53,6 @@ If you plan a big feature, first open an issue to discuss it before any developm
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
-### Roadmap and Ideas for Improvement
-
-- [ ] Clean, document and structure the code
-- [x] Support documentation of authentication methods
-- [ ] Define Global Tags/Configuration (e.g., common responses like 404 errors)
-- [ ] Post-process the JSON and replace common objects with references to components
-- [ ] Create a temporary file with the JSON in production mode to avoid rebuilding it on every request
-- [ ] Create tags for popular gems used in APIs (e.g., a `@pagy` tag for common pagination parameters)
-- [x] Add basic authentication to OAS and UI for security reasons (Solution documented, not need to be managed by the engine)
-- [ ] Implement ability to define OAS by namespaces (e.g., generate OAS for specific routes like `/api` or separate versions V1 and V2)
-
 ## License
 
 The gem is available as open source under the terms of the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html#license-text).

data/app/views/oas_rails/oas_rails/index.html.erb

@@ -6,21 +6,133 @@
     <%= csp_meta_tag %>
     <meta charset="utf-8">
     <!-- Important: rapi-doc uses utf8 characters -->
-    <script type="module" src="https://unpkg.com/rapidoc/dist/rapidoc-min.js"></script>
+    <script type="module" src="/oas-rails-assets/rapidoc-min.js"></script>
+    <script>
+      function applyTheme() {
+        const theme = "<%= OasRails.config.rapidoc_theme %>";
+        const docEl = document.querySelector('rapi-doc');
+
+        // Reset all theme-related attributes
+        docEl.removeAttribute('theme');
+        docEl.removeAttribute('bg-color');
+        docEl.removeAttribute('text-color');
+        docEl.removeAttribute('nav-bg-color');
+        docEl.removeAttribute('nav-text-color');
+        docEl.removeAttribute('nav-hover-bg-color');
+        docEl.removeAttribute('nav-hover-text-color');
+        docEl.removeAttribute('nav-accent-color');
+        docEl.removeAttribute('primary-color');
+
+        console.log(theme === 'dark')
+
+        if (theme === 'dark'){
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#333');
+          docEl.setAttribute('text-color','#BBB');
+        } else if (theme === 'light'){
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FFF');
+          docEl.setAttribute('text-color','#444');
+        } else if (theme === 'night') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#14191f');
+          docEl.setAttribute('text-color','#aec2e0');
+        } else if (theme === 'mud') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#403635');
+          docEl.setAttribute('text-color','#c3b8b7');
+        } else if (theme === 'cofee') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#36312C');
+          docEl.setAttribute('text-color','#ceb8a0');
+        } else if (theme === 'forest') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#384244');
+          docEl.setAttribute('text-color','#BDD6DB');
+        } else if (theme === 'olive') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2a2f31');
+          docEl.setAttribute('text-color','#acc7c8');
+        } else if (theme === 'outerspace') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2D3133');
+          docEl.setAttribute('text-color','#CAD9E3');
+        } else if (theme === 'ebony') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2B303B');
+          docEl.setAttribute('text-color','#dee3ec');
+        } else if (theme === 'snow') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FAFAFA');
+          docEl.setAttribute('text-color','#555');
+        } else if (theme === 'green') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#f9fdf7');
+          docEl.setAttribute('text-color','#375F1B');
+        } else if (theme === 'blue') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#ecf1f7');
+          docEl.setAttribute('text-color','#133863');
+        } else if (theme === 'beige') {
+          docEl.setAttribute('show-header','true');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#fdf8ed');
+          docEl.setAttribute('text-color','#342809');
+        } else if (theme === 'graynav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-bg-color','#3e4b54');
+          docEl.setAttribute('nav-accent-color','#fd6964');
+          docEl.setAttribute('primary-color','#ea526f');
+        }  else if (theme === 'purplenav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-accent-color','#ffd8e7');
+          docEl.setAttribute('nav-bg-color','#666699');
+          docEl.setAttribute('primary-color','#ea526f');
+          docEl.setAttribute('bg-color','#fff9fb');
+        } else if (theme === 'lightgraynav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-bg-color','#fafafa');
+          docEl.setAttribute('nav-hover-text-color','#9b0700');
+          docEl.setAttribute('nav-hover-bg-color','#ffebea');
+          docEl.setAttribute('primary-color','#F63C41');
+          docEl.setAttribute('bg-color','#ffffff');
+        } else if (theme === 'darkbluenav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#f9f9fa');
+          docEl.setAttribute('nav-bg-color','#3f4d67');
+          docEl.setAttribute('nav-text-color','#a9b7d0');
+          docEl.setAttribute('nav-hover-bg-color','#333f54');
+          docEl.setAttribute('nav-hover-text-color','#fff');
+          docEl.setAttribute('nav-accent-color','#f87070');
+          docEl.setAttribute('primary-color','#5c7096');
+        } else if (theme === 'rails') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FFFFFF');
+          docEl.setAttribute('nav-bg-color','#101828');
+          docEl.setAttribute('nav-text-color','#fff');
+          docEl.setAttribute('nav-hover-bg-color','#261B23');
+          docEl.setAttribute('nav-hover-text-color','#fff');
+          docEl.setAttribute('nav-accent-color','#D30001');
+          docEl.setAttribute('primary-color','#D30001');
+        }
+      }
+
+      document.addEventListener('DOMContentLoaded', applyTheme);
+    </script>
   </head>
   <body>
     <rapi-doc
       spec-url="<%= OasRails::Engine.routes.find_script_name({}) %>.json"
-      theme="dark"
-      bg-color="#0F172A"
-      text-color="#f7f7f7"
       show-header="false"
-      primary-color="#2de410"
       font-size="largest"
       show-method-in-nav-bar="as-colored-text"
-      nav-text-color="#f7f7f7"
       nav-item-spacing="relaxed"
       allow-spec-file-download="true"
+      schema-style="table"
     >
     </rapi-doc>
 

data/lib/generators/oas_rails/config/templates/oas_rails_initializer.rb

@@ -68,7 +68,7 @@ OasRails.configure do |config|
   # Default: false
   # config.layout = "application"
 
-  # Excluding custom controlers or controlers#action
+  # Excluding custom controllers or controllers#action
   # Example: ["projects", "users#new"]
   # config.ignored_actions = []
 
@@ -77,7 +77,7 @@ OasRails.configure do |config|
   # #######################
 
   # Whether to authenticate all routes by default
-  # Default is true; set to false if you don't want all routes to include secutrity schemas by default
+  # Default is true; set to false if you don't want all routes to include security schemas by default
   # config.authenticate_all_routes_by_default = true
 
   # Default security schema used for authentication
@@ -101,7 +101,7 @@ OasRails.configure do |config|
   # Default Responses (Errors)
   # ###########################
 
-  # The default responses errors are setted only if the action allow it.
+  # The default responses errors are set only if the action allow it.
   # Example, if you add forbidden then it will be added only if the endpoint requires authentication.
   # Example: not_found will be setted to the endpoint only if the operation is a show/update/destroy action.
   # config.set_default_responses = true