grape-swagger-rails 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc39abcbbeb304658e33061d3a5a9bbf258a66beda61047a24a57890a97b793
-  data.tar.gz: ce8b864b428f69c0cfcad9219543706bcac89ed627fcfec85bd188546d57b726
+  metadata.gz: 5ecb777e34a30ebdb4040894ad38bfa90b3b3bd9ba2c66a5908b832e57b17af0
+  data.tar.gz: 667fc390286949f8f2db1553c8ba92e39f1ef8737bbd4421d86ebed064b5086b
 SHA512:
-  metadata.gz: '042399acc3c5a99da72fe96ec25de18d787de3c37882aa27bd4b7fc6d59b49ad4a1517b995514f2f01c7e47667e66678a371ac6a981ccfedbc2138d46023c939'
-  data.tar.gz: c4b12262becdb63a781acc27f2fad7396d7929843b8062069fe2e7aa4b632ad783138f2d8b16da55d283d7f822536f586f0213adb111329cc9f7ceba866dad3e
+  metadata.gz: 8fcd7a5f9ac2c84c712ae75e6fa7f569fc5b889af24c476709cc2181719d9c4cbfe25361549bfb1aa66e5f75584283de78ba356a1cbe272fe9d667b23abd6529
+  data.tar.gz: 51fc985776d938a1af472acea0e0b1d18d495db5c47378bbf3bdddf3dc2c592459cad5b75d19ad262ad63aced12494211395c51dba7d8fb7db04f72dc275414b

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * Your contribution here.
 
+### 1.0.5 (2026/07/16)
+
+* [#170](https://github.com/ruby-grape/grape-swagger-rails/pull/170): Enhance dark mode styling and improve api key documentation in swagger ui - [@moskvin](https://github.com/moskvin).
+
 ### 1.0.4 (2026/07/03)
 
 * [#169](https://github.com/ruby-grape/grape-swagger-rails/pull/169): Bump swagger ui to 5.32.8 - [@moskvin](https://github.com/moskvin).

data/app/assets/stylesheets/grape_swagger_rails/index.css

@@ -157,6 +157,17 @@ html[data-theme="dark"] .swagger-select option {
   display: none;
 }
 
+.swagger-ui .btn.authorize {
+  display: inline-flex;
+  align-items: center;
+  gap: 6px;
+}
+
+.swagger-ui .btn.authorize span {
+  float: none;
+  padding: 0;
+}
+
 html[data-hide-api-key="true"] .swagger-auth {
   display: none;
 }
@@ -191,9 +202,38 @@ html[data-theme="dark"] .swagger-ui .responses-inner,
 html[data-theme="dark"] .swagger-ui .opblock .opblock-section-header,
 html[data-theme="dark"] .swagger-ui .opblock-body pre,
 html[data-theme="dark"] .swagger-ui .highlight-code,
-html[data-theme="dark"] .swagger-ui .microlight,
+html[data-theme="dark"] .swagger-ui .microlight {
+  background: #0f172a;
+  color: #e2e8f0;
+}
+
+.swagger-ui .markdown,
+.swagger-ui .renderedMarkdown {
+  line-height: 1.2em;
+}
+
+.swagger-ui .markdown code,
+.swagger-ui .renderedMarkdown code {
+  padding: 2px 5px;
+  font-size: 1em;
+}
+
 html[data-theme="dark"] .swagger-ui .renderedMarkdown code,
-html[data-theme="dark"] .swagger-ui .renderedMarkdown pre {
+html[data-theme="dark"] .swagger-ui .markdown code {
+  background: #0f172a;
+  color: #c4b5fd;
+}
+
+html[data-theme="dark"] .swagger-ui .renderedMarkdown pre > code,
+html[data-theme="dark"] .swagger-ui .markdown pre > code {
+  display: block;
+  background: transparent;
+  color: inherit;
+  padding: 0;
+}
+
+html[data-theme="dark"] .swagger-ui .renderedMarkdown pre,
+html[data-theme="dark"] .swagger-ui .markdown pre {
   background: #0f172a;
   color: #e2e8f0;
 }

data/lib/grape-swagger-rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module GrapeSwaggerRails
-  VERSION = '1.0.4'
+  VERSION = '1.0.5'
   SWAGGER_UI_VERSION = '5.32.8'
 end

data/spec/dummy/app/api/api.rb

@@ -76,7 +76,18 @@ class API < Grape::API
 
   add_swagger_documentation(
     security_definitions: {
-      api_key: { type: 'apiKey', name: 'Authorization', in: 'header' }
+      api_key: {
+        type: 'apiKey',
+        name: 'Authorization',
+        in: 'header',
+        description: <<~HTML
+          The default API authentication token.
+          <br>
+          <br>
+          Fetch a token using the <code>POST /api/sign_in</code> endpoint.<br>
+          Then use the following format: <code>Bearer {token}</code>, or include additional information with <code>one extra code block</code>, <code>another extra code block</code>, <code>BLOCK 1</code>, <code>Second block</code>, <code>Third block</code>, and <code>Last block</code>.
+        HTML
+      }
     }
   )
 end

data/spec/features/swagger_spec.rb

@@ -111,6 +111,15 @@ describe 'Swagger' do
     find_by_id('input_apiKey').set(value)
   end
 
+  def auth_dialog_code_bg
+    find('.swagger-ui .scheme-container .btn.authorize', wait: 5).click
+    expect(page).to have_css('.swagger-ui .dialog-ux .markdown code', wait: 5)
+    page.evaluate_script(
+      '(function(){var c=document.querySelector(".swagger-ui .dialog-ux .markdown code");' \
+      'return c?window.getComputedStyle(c).backgroundColor:null;})()'
+    )
+  end
+
   def open_operation(tag_id, operation_id)
     find("##{tag_id} .expand-operation").click
     find("##{operation_id} .opblock-control-arrow").click
@@ -851,9 +860,8 @@ describe 'Swagger' do
       it 'serves the api_key security definition in the swagger document' do
         document = swagger_document
 
-        expect(document.fetch('securityDefinitions')).to eq(
-          'api_key' => { 'type' => 'apiKey', 'name' => 'Authorization',
-                         'in' => 'header' }
+        expect(document.fetch('securityDefinitions')).to include(
+          'api_key' => a_hash_including('type' => 'apiKey', 'name' => 'Authorization', 'in' => 'header')
         )
       end
 
@@ -885,6 +893,12 @@ describe 'Swagger' do
         expect(page).to have_css('#operations-foos-getApiFoos .opblock-summary', wait: 5)
         expect(page).to have_no_css('#operations-foos-getApiFoos .opblock-summary .authorization__btn')
       end
+
+      it 'renders inline code in the auth dialog without background bleed in dark mode' do
+        GrapeSwaggerRails.options.theme = 'dark'
+        visit_swagger
+        expect(auth_dialog_code_bg).to eq('rgb(15, 23, 42)')
+      end
     end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Alexander Logunov
+autorequire:
 bindir: bin
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml-rails
@@ -173,8 +174,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/ruby-grape/grape-swagger-rails/issues
   changelog_uri: https://github.com/ruby-grape/grape-swagger-rails/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/ruby-grape/grape-swagger-rails/tree/v1.0.4
+  source_code_uri: https://github.com/ruby-grape/grape-swagger-rails/tree/v1.0.5
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,7 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Rails engine for serving Swagger UI for grape-swagger.
 test_files: []