grape-swagger-rails 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/frontend.yml +1 -1
  3. data/.github/workflows/rubocop.yml +1 -1
  4. data/.github/workflows/swagger-ui-update.yml +61 -0
  5. data/.github/workflows/test.yml +1 -1
  6. data/.gitignore +1 -0
  7. data/.pnp.cjs +110 -110
  8. data/.rubocop_todo.yml +0 -7
  9. data/.yarnrc.yml +1 -0
  10. data/CHANGELOG.md +13 -0
  11. data/README.md +8 -6
  12. data/app/assets/javascripts/grape_swagger_rails/index.js +21 -1
  13. data/app/assets/javascripts/grape_swagger_rails/index.min.js +1 -1
  14. data/app/assets/javascripts/grape_swagger_rails/index.min.js.map +3 -3
  15. data/app/assets/javascripts/grape_swagger_rails/swagger-ui-bundle.js +1 -1
  16. data/app/assets/javascripts/grape_swagger_rails/swagger-ui-standalone-preset.js +1 -1
  17. data/app/assets/stylesheets/grape_swagger_rails/index.css +5 -1
  18. data/frontend/grape_swagger_rails/index.ts +24 -1
  19. data/lib/grape-swagger-rails/version.rb +2 -2
  20. data/lib/grape-swagger-rails.rb +2 -1
  21. data/lib/tasks/swagger_ui.rake +20 -3
  22. data/package.json +1 -1
  23. data/spec/dummy/app/api/api.rb +6 -2
  24. data/spec/features/swagger_spec.rb +68 -0
  25. data/yarn.lock +109 -109
  26. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 61a592b658be0f0b08a98137d907c771b4444627d3da072b40b73cfe4ea40773
4
- data.tar.gz: c44bec534d280e3d579ecb71f4f0f63b722f672538b5b45495c6c5ca107da168
3
+ metadata.gz: e553b6cf61c7198e8a3222142e789e02c698eb352df278373cf970cc43ad4654
4
+ data.tar.gz: 67fc1c2bd489d46a31a5fa883628a77ba1b12a445939e81a5e7239063b3b3d73
5
5
  SHA512:
6
- metadata.gz: 1fd25759115054c6885fdb7c31a8dd9be252c0b82f6935d50c639d37e349d1149773302db8265f2569799ba99e87f74f63827d41a25af9b6b14b4ecee7c804e1
7
- data.tar.gz: cfedf854908cda46fd6ba7d55bb35fc02d5e65c35034251e12e90abaafe8889f137703564aec572acd470fe3e4d1574aa1d7185ad098fcc58dc9ca4c7b11421d
6
+ metadata.gz: f2d538f74841759f22beaac8da9d2a8638ce3426039ac648543364b71fadd73709e7dc849f2aa70327652635059176e03a6aa1a9cfe53c378d6d6f91a4fc2645
7
+ data.tar.gz: 3da5330fad9e3e04a83f3c06fe808ea3dc1c63e0a4be4ca875aa2a1b713ae12ed142bcd735cdf052f295ecc4c27337798ab20c3b341c8b34d7e68fb089f71a2c
data/.github/workflows/frontend.yml CHANGED
@@ -8,7 +8,7 @@ jobs:
8
8
  frontend:
9
9
  runs-on: ubuntu-latest
10
10
  steps:
11
- - uses: actions/checkout@v5
11
+ - uses: actions/checkout@v6
12
12
  - name: Set up Node
13
13
  uses: actions/setup-node@v4
14
14
  with:
data/.github/workflows/rubocop.yml CHANGED
@@ -4,7 +4,7 @@ jobs:
4
4
  rubocop:
5
5
  runs-on: ubuntu-latest
6
6
  steps:
7
- - uses: actions/checkout@v5
7
+ - uses: actions/checkout@v6
8
8
  - name: Set up Ruby
9
9
  uses: ruby/setup-ruby@v1
10
10
  with:
data/.github/workflows/swagger-ui-update.yml ADDED
@@ -0,0 +1,61 @@
1
+ name: Swagger UI Update
2
+
3
+ "on":
4
+ schedule:
5
+ - cron: "0 8 * * 1"
6
+ workflow_dispatch:
7
+
8
+ permissions:
9
+ contents: write
10
+ pull-requests: write
11
+
12
+ jobs:
13
+ update:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@v6
17
+
18
+ - name: Set up Ruby
19
+ uses: ruby/setup-ruby@v1
20
+ with:
21
+ ruby-version: "3.4"
22
+ bundler-cache: true
23
+
24
+ - name: Check latest Swagger UI release
25
+ id: swagger-ui
26
+ env:
27
+ GH_TOKEN: ${{ github.token }}
28
+ run: |
29
+ current_version="$(ruby -r ./lib/grape-swagger-rails/version -e 'print GrapeSwaggerRails::SWAGGER_UI_VERSION')"
30
+ latest_tag="$(gh api repos/swagger-api/swagger-ui/releases/latest --jq .tag_name)"
31
+ latest_version="${latest_tag#v}"
32
+
33
+ echo "current-version=${current_version}" >> "$GITHUB_OUTPUT"
34
+ echo "latest-tag=${latest_tag}" >> "$GITHUB_OUTPUT"
35
+ echo "latest-version=${latest_version}" >> "$GITHUB_OUTPUT"
36
+
37
+ if [ "$current_version" != "$latest_version" ]; then
38
+ echo "update-needed=true" >> "$GITHUB_OUTPUT"
39
+ else
40
+ echo "update-needed=false" >> "$GITHUB_OUTPUT"
41
+ fi
42
+
43
+ - name: Update Swagger UI assets
44
+ if: steps.swagger-ui.outputs.update-needed == 'true'
45
+ env:
46
+ SWAGGER_UI_VERSION: ${{ steps.swagger-ui.outputs.latest-tag }}
47
+ run: bundle exec rake swagger_ui:dist:update
48
+
49
+ - name: Create pull request
50
+ if: steps.swagger-ui.outputs.update-needed == 'true'
51
+ uses: peter-evans/create-pull-request@v7
52
+ with:
53
+ token: ${{ github.token }}
54
+ branch: update-swagger-ui-${{ steps.swagger-ui.outputs.latest-version }}
55
+ delete-branch: true
56
+ commit-message: Bump Swagger UI to ${{ steps.swagger-ui.outputs.latest-version }}
57
+ title: Bump Swagger UI to ${{ steps.swagger-ui.outputs.latest-version }}
58
+ body: |
59
+ Updates bundled Swagger UI assets from swagger-api/swagger-ui `${{ steps.swagger-ui.outputs.latest-tag }}`.
60
+
61
+ Generated by the scheduled Swagger UI update workflow.
data/.github/workflows/test.yml CHANGED
@@ -44,7 +44,7 @@ jobs:
44
44
  GRAPE_SWAGGER_VERSION: ${{ matrix.grape-swagger }}
45
45
  RAILS_VERSION: ${{ matrix.rails }}
46
46
  steps:
47
- - uses: actions/checkout@v5
47
+ - uses: actions/checkout@v6
48
48
  - name: Set up Ruby
49
49
  uses: ruby/setup-ruby@v1
50
50
  with:
data/.gitignore CHANGED
@@ -19,3 +19,4 @@ tmp
19
19
  .project
20
20
  .ruby-version
21
21
  .yarn
22
+ vendor/
data/.pnp.cjs CHANGED
@@ -28,7 +28,7 @@ const RAW_RUNTIME_STATE =
28
28
  [null, {\
29
29
  "packageLocation": "./",\
30
30
  "packageDependencies": [\
31
- ["esbuild", "npm:0.25.12"],\
31
+ ["esbuild", "npm:0.28.1"],\
32
32
  ["grape-swagger-rails", "workspace:."],\
33
33
  ["typescript", "patch:typescript@npm%3A5.9.3#optional!builtin<compat/typescript>::version=5.9.3&hash=5786d5"]\
34
34
  ],\
@@ -36,270 +36,270 @@ const RAW_RUNTIME_STATE =
36
36
  }]\
37
37
  ]],\
38
38
  ["@esbuild/aix-ppc64", [\
39
- ["npm:0.25.12", {\
40
- "packageLocation": "./.yarn/unplugged/@esbuild-aix-ppc64-npm-0.25.12-8c22abd617/node_modules/@esbuild/aix-ppc64/",\
39
+ ["npm:0.28.1", {\
40
+ "packageLocation": "./.yarn/unplugged/@esbuild-aix-ppc64-npm-0.28.1-d20a32173e/node_modules/@esbuild/aix-ppc64/",\
41
41
  "packageDependencies": [\
42
- ["@esbuild/aix-ppc64", "npm:0.25.12"]\
42
+ ["@esbuild/aix-ppc64", "npm:0.28.1"]\
43
43
  ],\
44
44
  "linkType": "HARD"\
45
45
  }]\
46
46
  ]],\
47
47
  ["@esbuild/android-arm", [\
48
- ["npm:0.25.12", {\
49
- "packageLocation": "./.yarn/unplugged/@esbuild-android-arm-npm-0.25.12-30cfcd9e3d/node_modules/@esbuild/android-arm/",\
48
+ ["npm:0.28.1", {\
49
+ "packageLocation": "./.yarn/unplugged/@esbuild-android-arm-npm-0.28.1-4d1de173ce/node_modules/@esbuild/android-arm/",\
50
50
  "packageDependencies": [\
51
- ["@esbuild/android-arm", "npm:0.25.12"]\
51
+ ["@esbuild/android-arm", "npm:0.28.1"]\
52
52
  ],\
53
53
  "linkType": "HARD"\
54
54
  }]\
55
55
  ]],\
56
56
  ["@esbuild/android-arm64", [\
57
- ["npm:0.25.12", {\
58
- "packageLocation": "./.yarn/unplugged/@esbuild-android-arm64-npm-0.25.12-00cec8936f/node_modules/@esbuild/android-arm64/",\
57
+ ["npm:0.28.1", {\
58
+ "packageLocation": "./.yarn/unplugged/@esbuild-android-arm64-npm-0.28.1-49fc0d8784/node_modules/@esbuild/android-arm64/",\
59
59
  "packageDependencies": [\
60
- ["@esbuild/android-arm64", "npm:0.25.12"]\
60
+ ["@esbuild/android-arm64", "npm:0.28.1"]\
61
61
  ],\
62
62
  "linkType": "HARD"\
63
63
  }]\
64
64
  ]],\
65
65
  ["@esbuild/android-x64", [\
66
- ["npm:0.25.12", {\
67
- "packageLocation": "./.yarn/unplugged/@esbuild-android-x64-npm-0.25.12-f0cc7556ec/node_modules/@esbuild/android-x64/",\
66
+ ["npm:0.28.1", {\
67
+ "packageLocation": "./.yarn/unplugged/@esbuild-android-x64-npm-0.28.1-69fbd6806e/node_modules/@esbuild/android-x64/",\
68
68
  "packageDependencies": [\
69
- ["@esbuild/android-x64", "npm:0.25.12"]\
69
+ ["@esbuild/android-x64", "npm:0.28.1"]\
70
70
  ],\
71
71
  "linkType": "HARD"\
72
72
  }]\
73
73
  ]],\
74
74
  ["@esbuild/darwin-arm64", [\
75
- ["npm:0.25.12", {\
76
- "packageLocation": "./.yarn/unplugged/@esbuild-darwin-arm64-npm-0.25.12-2a5a9f9710/node_modules/@esbuild/darwin-arm64/",\
75
+ ["npm:0.28.1", {\
76
+ "packageLocation": "./.yarn/unplugged/@esbuild-darwin-arm64-npm-0.28.1-b71e3b7721/node_modules/@esbuild/darwin-arm64/",\
77
77
  "packageDependencies": [\
78
- ["@esbuild/darwin-arm64", "npm:0.25.12"]\
78
+ ["@esbuild/darwin-arm64", "npm:0.28.1"]\
79
79
  ],\
80
80
  "linkType": "HARD"\
81
81
  }]\
82
82
  ]],\
83
83
  ["@esbuild/darwin-x64", [\
84
- ["npm:0.25.12", {\
85
- "packageLocation": "./.yarn/unplugged/@esbuild-darwin-x64-npm-0.25.12-157b2f4f8a/node_modules/@esbuild/darwin-x64/",\
84
+ ["npm:0.28.1", {\
85
+ "packageLocation": "./.yarn/unplugged/@esbuild-darwin-x64-npm-0.28.1-4318a1bdc6/node_modules/@esbuild/darwin-x64/",\
86
86
  "packageDependencies": [\
87
- ["@esbuild/darwin-x64", "npm:0.25.12"]\
87
+ ["@esbuild/darwin-x64", "npm:0.28.1"]\
88
88
  ],\
89
89
  "linkType": "HARD"\
90
90
  }]\
91
91
  ]],\
92
92
  ["@esbuild/freebsd-arm64", [\
93
- ["npm:0.25.12", {\
94
- "packageLocation": "./.yarn/unplugged/@esbuild-freebsd-arm64-npm-0.25.12-82171eee7e/node_modules/@esbuild/freebsd-arm64/",\
93
+ ["npm:0.28.1", {\
94
+ "packageLocation": "./.yarn/unplugged/@esbuild-freebsd-arm64-npm-0.28.1-3d5fe88a26/node_modules/@esbuild/freebsd-arm64/",\
95
95
  "packageDependencies": [\
96
- ["@esbuild/freebsd-arm64", "npm:0.25.12"]\
96
+ ["@esbuild/freebsd-arm64", "npm:0.28.1"]\
97
97
  ],\
98
98
  "linkType": "HARD"\
99
99
  }]\
100
100
  ]],\
101
101
  ["@esbuild/freebsd-x64", [\
102
- ["npm:0.25.12", {\
103
- "packageLocation": "./.yarn/unplugged/@esbuild-freebsd-x64-npm-0.25.12-464a938fa1/node_modules/@esbuild/freebsd-x64/",\
102
+ ["npm:0.28.1", {\
103
+ "packageLocation": "./.yarn/unplugged/@esbuild-freebsd-x64-npm-0.28.1-5dcb428cfa/node_modules/@esbuild/freebsd-x64/",\
104
104
  "packageDependencies": [\
105
- ["@esbuild/freebsd-x64", "npm:0.25.12"]\
105
+ ["@esbuild/freebsd-x64", "npm:0.28.1"]\
106
106
  ],\
107
107
  "linkType": "HARD"\
108
108
  }]\
109
109
  ]],\
110
110
  ["@esbuild/linux-arm", [\
111
- ["npm:0.25.12", {\
112
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-arm-npm-0.25.12-dd07033e1a/node_modules/@esbuild/linux-arm/",\
111
+ ["npm:0.28.1", {\
112
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-arm-npm-0.28.1-b25afdcd7d/node_modules/@esbuild/linux-arm/",\
113
113
  "packageDependencies": [\
114
- ["@esbuild/linux-arm", "npm:0.25.12"]\
114
+ ["@esbuild/linux-arm", "npm:0.28.1"]\
115
115
  ],\
116
116
  "linkType": "HARD"\
117
117
  }]\
118
118
  ]],\
119
119
  ["@esbuild/linux-arm64", [\
120
- ["npm:0.25.12", {\
121
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-arm64-npm-0.25.12-a5aaa0e70e/node_modules/@esbuild/linux-arm64/",\
120
+ ["npm:0.28.1", {\
121
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-arm64-npm-0.28.1-33ca543ef9/node_modules/@esbuild/linux-arm64/",\
122
122
  "packageDependencies": [\
123
- ["@esbuild/linux-arm64", "npm:0.25.12"]\
123
+ ["@esbuild/linux-arm64", "npm:0.28.1"]\
124
124
  ],\
125
125
  "linkType": "HARD"\
126
126
  }]\
127
127
  ]],\
128
128
  ["@esbuild/linux-ia32", [\
129
- ["npm:0.25.12", {\
130
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-ia32-npm-0.25.12-3b5addbfbb/node_modules/@esbuild/linux-ia32/",\
129
+ ["npm:0.28.1", {\
130
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-ia32-npm-0.28.1-1ab1ff7c72/node_modules/@esbuild/linux-ia32/",\
131
131
  "packageDependencies": [\
132
- ["@esbuild/linux-ia32", "npm:0.25.12"]\
132
+ ["@esbuild/linux-ia32", "npm:0.28.1"]\
133
133
  ],\
134
134
  "linkType": "HARD"\
135
135
  }]\
136
136
  ]],\
137
137
  ["@esbuild/linux-loong64", [\
138
- ["npm:0.25.12", {\
139
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-loong64-npm-0.25.12-4fec31ffb2/node_modules/@esbuild/linux-loong64/",\
138
+ ["npm:0.28.1", {\
139
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-loong64-npm-0.28.1-7a0f6a6d04/node_modules/@esbuild/linux-loong64/",\
140
140
  "packageDependencies": [\
141
- ["@esbuild/linux-loong64", "npm:0.25.12"]\
141
+ ["@esbuild/linux-loong64", "npm:0.28.1"]\
142
142
  ],\
143
143
  "linkType": "HARD"\
144
144
  }]\
145
145
  ]],\
146
146
  ["@esbuild/linux-mips64el", [\
147
- ["npm:0.25.12", {\
148
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-mips64el-npm-0.25.12-827ebfd4ef/node_modules/@esbuild/linux-mips64el/",\
147
+ ["npm:0.28.1", {\
148
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-mips64el-npm-0.28.1-a172b3d074/node_modules/@esbuild/linux-mips64el/",\
149
149
  "packageDependencies": [\
150
- ["@esbuild/linux-mips64el", "npm:0.25.12"]\
150
+ ["@esbuild/linux-mips64el", "npm:0.28.1"]\
151
151
  ],\
152
152
  "linkType": "HARD"\
153
153
  }]\
154
154
  ]],\
155
155
  ["@esbuild/linux-ppc64", [\
156
- ["npm:0.25.12", {\
157
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-ppc64-npm-0.25.12-02e9c28638/node_modules/@esbuild/linux-ppc64/",\
156
+ ["npm:0.28.1", {\
157
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-ppc64-npm-0.28.1-e25baf3a1a/node_modules/@esbuild/linux-ppc64/",\
158
158
  "packageDependencies": [\
159
- ["@esbuild/linux-ppc64", "npm:0.25.12"]\
159
+ ["@esbuild/linux-ppc64", "npm:0.28.1"]\
160
160
  ],\
161
161
  "linkType": "HARD"\
162
162
  }]\
163
163
  ]],\
164
164
  ["@esbuild/linux-riscv64", [\
165
- ["npm:0.25.12", {\
166
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-riscv64-npm-0.25.12-3c5f314835/node_modules/@esbuild/linux-riscv64/",\
165
+ ["npm:0.28.1", {\
166
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-riscv64-npm-0.28.1-1c6a6e51ef/node_modules/@esbuild/linux-riscv64/",\
167
167
  "packageDependencies": [\
168
- ["@esbuild/linux-riscv64", "npm:0.25.12"]\
168
+ ["@esbuild/linux-riscv64", "npm:0.28.1"]\
169
169
  ],\
170
170
  "linkType": "HARD"\
171
171
  }]\
172
172
  ]],\
173
173
  ["@esbuild/linux-s390x", [\
174
- ["npm:0.25.12", {\
175
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-s390x-npm-0.25.12-2106b3ddcb/node_modules/@esbuild/linux-s390x/",\
174
+ ["npm:0.28.1", {\
175
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-s390x-npm-0.28.1-260d089844/node_modules/@esbuild/linux-s390x/",\
176
176
  "packageDependencies": [\
177
- ["@esbuild/linux-s390x", "npm:0.25.12"]\
177
+ ["@esbuild/linux-s390x", "npm:0.28.1"]\
178
178
  ],\
179
179
  "linkType": "HARD"\
180
180
  }]\
181
181
  ]],\
182
182
  ["@esbuild/linux-x64", [\
183
- ["npm:0.25.12", {\
184
- "packageLocation": "./.yarn/unplugged/@esbuild-linux-x64-npm-0.25.12-07c7c22cce/node_modules/@esbuild/linux-x64/",\
183
+ ["npm:0.28.1", {\
184
+ "packageLocation": "./.yarn/unplugged/@esbuild-linux-x64-npm-0.28.1-f7b93afd3d/node_modules/@esbuild/linux-x64/",\
185
185
  "packageDependencies": [\
186
- ["@esbuild/linux-x64", "npm:0.25.12"]\
186
+ ["@esbuild/linux-x64", "npm:0.28.1"]\
187
187
  ],\
188
188
  "linkType": "HARD"\
189
189
  }]\
190
190
  ]],\
191
191
  ["@esbuild/netbsd-arm64", [\
192
- ["npm:0.25.12", {\
193
- "packageLocation": "./.yarn/unplugged/@esbuild-netbsd-arm64-npm-0.25.12-bd2cdd7715/node_modules/@esbuild/netbsd-arm64/",\
192
+ ["npm:0.28.1", {\
193
+ "packageLocation": "./.yarn/unplugged/@esbuild-netbsd-arm64-npm-0.28.1-ef076ca2a7/node_modules/@esbuild/netbsd-arm64/",\
194
194
  "packageDependencies": [\
195
- ["@esbuild/netbsd-arm64", "npm:0.25.12"]\
195
+ ["@esbuild/netbsd-arm64", "npm:0.28.1"]\
196
196
  ],\
197
197
  "linkType": "HARD"\
198
198
  }]\
199
199
  ]],\
200
200
  ["@esbuild/netbsd-x64", [\
201
- ["npm:0.25.12", {\
202
- "packageLocation": "./.yarn/unplugged/@esbuild-netbsd-x64-npm-0.25.12-1f5039ae72/node_modules/@esbuild/netbsd-x64/",\
201
+ ["npm:0.28.1", {\
202
+ "packageLocation": "./.yarn/unplugged/@esbuild-netbsd-x64-npm-0.28.1-b8ce686786/node_modules/@esbuild/netbsd-x64/",\
203
203
  "packageDependencies": [\
204
- ["@esbuild/netbsd-x64", "npm:0.25.12"]\
204
+ ["@esbuild/netbsd-x64", "npm:0.28.1"]\
205
205
  ],\
206
206
  "linkType": "HARD"\
207
207
  }]\
208
208
  ]],\
209
209
  ["@esbuild/openbsd-arm64", [\
210
- ["npm:0.25.12", {\
211
- "packageLocation": "./.yarn/unplugged/@esbuild-openbsd-arm64-npm-0.25.12-33119801dd/node_modules/@esbuild/openbsd-arm64/",\
210
+ ["npm:0.28.1", {\
211
+ "packageLocation": "./.yarn/unplugged/@esbuild-openbsd-arm64-npm-0.28.1-ac90044627/node_modules/@esbuild/openbsd-arm64/",\
212
212
  "packageDependencies": [\
213
- ["@esbuild/openbsd-arm64", "npm:0.25.12"]\
213
+ ["@esbuild/openbsd-arm64", "npm:0.28.1"]\
214
214
  ],\
215
215
  "linkType": "HARD"\
216
216
  }]\
217
217
  ]],\
218
218
  ["@esbuild/openbsd-x64", [\
219
- ["npm:0.25.12", {\
220
- "packageLocation": "./.yarn/unplugged/@esbuild-openbsd-x64-npm-0.25.12-e97e4dea2a/node_modules/@esbuild/openbsd-x64/",\
219
+ ["npm:0.28.1", {\
220
+ "packageLocation": "./.yarn/unplugged/@esbuild-openbsd-x64-npm-0.28.1-b1ac081cac/node_modules/@esbuild/openbsd-x64/",\
221
221
  "packageDependencies": [\
222
- ["@esbuild/openbsd-x64", "npm:0.25.12"]\
222
+ ["@esbuild/openbsd-x64", "npm:0.28.1"]\
223
223
  ],\
224
224
  "linkType": "HARD"\
225
225
  }]\
226
226
  ]],\
227
227
  ["@esbuild/openharmony-arm64", [\
228
- ["npm:0.25.12", {\
229
- "packageLocation": "./.yarn/unplugged/@esbuild-openharmony-arm64-npm-0.25.12-b6855e9fc4/node_modules/@esbuild/openharmony-arm64/",\
228
+ ["npm:0.28.1", {\
229
+ "packageLocation": "./.yarn/unplugged/@esbuild-openharmony-arm64-npm-0.28.1-9dd17b04fe/node_modules/@esbuild/openharmony-arm64/",\
230
230
  "packageDependencies": [\
231
- ["@esbuild/openharmony-arm64", "npm:0.25.12"]\
231
+ ["@esbuild/openharmony-arm64", "npm:0.28.1"]\
232
232
  ],\
233
233
  "linkType": "HARD"\
234
234
  }]\
235
235
  ]],\
236
236
  ["@esbuild/sunos-x64", [\
237
- ["npm:0.25.12", {\
238
- "packageLocation": "./.yarn/unplugged/@esbuild-sunos-x64-npm-0.25.12-21a61a61f1/node_modules/@esbuild/sunos-x64/",\
237
+ ["npm:0.28.1", {\
238
+ "packageLocation": "./.yarn/unplugged/@esbuild-sunos-x64-npm-0.28.1-fc4a551989/node_modules/@esbuild/sunos-x64/",\
239
239
  "packageDependencies": [\
240
- ["@esbuild/sunos-x64", "npm:0.25.12"]\
240
+ ["@esbuild/sunos-x64", "npm:0.28.1"]\
241
241
  ],\
242
242
  "linkType": "HARD"\
243
243
  }]\
244
244
  ]],\
245
245
  ["@esbuild/win32-arm64", [\
246
- ["npm:0.25.12", {\
247
- "packageLocation": "./.yarn/unplugged/@esbuild-win32-arm64-npm-0.25.12-daf31eb7a1/node_modules/@esbuild/win32-arm64/",\
246
+ ["npm:0.28.1", {\
247
+ "packageLocation": "./.yarn/unplugged/@esbuild-win32-arm64-npm-0.28.1-af465b17e5/node_modules/@esbuild/win32-arm64/",\
248
248
  "packageDependencies": [\
249
- ["@esbuild/win32-arm64", "npm:0.25.12"]\
249
+ ["@esbuild/win32-arm64", "npm:0.28.1"]\
250
250
  ],\
251
251
  "linkType": "HARD"\
252
252
  }]\
253
253
  ]],\
254
254
  ["@esbuild/win32-ia32", [\
255
- ["npm:0.25.12", {\
256
- "packageLocation": "./.yarn/unplugged/@esbuild-win32-ia32-npm-0.25.12-7915b5b56e/node_modules/@esbuild/win32-ia32/",\
255
+ ["npm:0.28.1", {\
256
+ "packageLocation": "./.yarn/unplugged/@esbuild-win32-ia32-npm-0.28.1-43f057dbe1/node_modules/@esbuild/win32-ia32/",\
257
257
  "packageDependencies": [\
258
- ["@esbuild/win32-ia32", "npm:0.25.12"]\
258
+ ["@esbuild/win32-ia32", "npm:0.28.1"]\
259
259
  ],\
260
260
  "linkType": "HARD"\
261
261
  }]\
262
262
  ]],\
263
263
  ["@esbuild/win32-x64", [\
264
- ["npm:0.25.12", {\
265
- "packageLocation": "./.yarn/unplugged/@esbuild-win32-x64-npm-0.25.12-2425a2e173/node_modules/@esbuild/win32-x64/",\
264
+ ["npm:0.28.1", {\
265
+ "packageLocation": "./.yarn/unplugged/@esbuild-win32-x64-npm-0.28.1-0393bda545/node_modules/@esbuild/win32-x64/",\
266
266
  "packageDependencies": [\
267
- ["@esbuild/win32-x64", "npm:0.25.12"]\
267
+ ["@esbuild/win32-x64", "npm:0.28.1"]\
268
268
  ],\
269
269
  "linkType": "HARD"\
270
270
  }]\
271
271
  ]],\
272
272
  ["esbuild", [\
273
- ["npm:0.25.12", {\
274
- "packageLocation": "../../.yarn/berry/cache/esbuild-npm-0.25.12-352393c4bd-10c0.zip/node_modules/esbuild/",\
273
+ ["npm:0.28.1", {\
274
+ "packageLocation": "./.yarn/cache/esbuild-npm-0.28.1-23da8d1b66-29cd456a79.zip/node_modules/esbuild/",\
275
275
  "packageDependencies": [\
276
- ["@esbuild/aix-ppc64", "npm:0.25.12"],\
277
- ["@esbuild/android-arm", "npm:0.25.12"],\
278
- ["@esbuild/android-arm64", "npm:0.25.12"],\
279
- ["@esbuild/android-x64", "npm:0.25.12"],\
280
- ["@esbuild/darwin-arm64", "npm:0.25.12"],\
281
- ["@esbuild/darwin-x64", "npm:0.25.12"],\
282
- ["@esbuild/freebsd-arm64", "npm:0.25.12"],\
283
- ["@esbuild/freebsd-x64", "npm:0.25.12"],\
284
- ["@esbuild/linux-arm", "npm:0.25.12"],\
285
- ["@esbuild/linux-arm64", "npm:0.25.12"],\
286
- ["@esbuild/linux-ia32", "npm:0.25.12"],\
287
- ["@esbuild/linux-loong64", "npm:0.25.12"],\
288
- ["@esbuild/linux-mips64el", "npm:0.25.12"],\
289
- ["@esbuild/linux-ppc64", "npm:0.25.12"],\
290
- ["@esbuild/linux-riscv64", "npm:0.25.12"],\
291
- ["@esbuild/linux-s390x", "npm:0.25.12"],\
292
- ["@esbuild/linux-x64", "npm:0.25.12"],\
293
- ["@esbuild/netbsd-arm64", "npm:0.25.12"],\
294
- ["@esbuild/netbsd-x64", "npm:0.25.12"],\
295
- ["@esbuild/openbsd-arm64", "npm:0.25.12"],\
296
- ["@esbuild/openbsd-x64", "npm:0.25.12"],\
297
- ["@esbuild/openharmony-arm64", "npm:0.25.12"],\
298
- ["@esbuild/sunos-x64", "npm:0.25.12"],\
299
- ["@esbuild/win32-arm64", "npm:0.25.12"],\
300
- ["@esbuild/win32-ia32", "npm:0.25.12"],\
301
- ["@esbuild/win32-x64", "npm:0.25.12"],\
302
- ["esbuild", "npm:0.25.12"]\
276
+ ["@esbuild/aix-ppc64", "npm:0.28.1"],\
277
+ ["@esbuild/android-arm", "npm:0.28.1"],\
278
+ ["@esbuild/android-arm64", "npm:0.28.1"],\
279
+ ["@esbuild/android-x64", "npm:0.28.1"],\
280
+ ["@esbuild/darwin-arm64", "npm:0.28.1"],\
281
+ ["@esbuild/darwin-x64", "npm:0.28.1"],\
282
+ ["@esbuild/freebsd-arm64", "npm:0.28.1"],\
283
+ ["@esbuild/freebsd-x64", "npm:0.28.1"],\
284
+ ["@esbuild/linux-arm", "npm:0.28.1"],\
285
+ ["@esbuild/linux-arm64", "npm:0.28.1"],\
286
+ ["@esbuild/linux-ia32", "npm:0.28.1"],\
287
+ ["@esbuild/linux-loong64", "npm:0.28.1"],\
288
+ ["@esbuild/linux-mips64el", "npm:0.28.1"],\
289
+ ["@esbuild/linux-ppc64", "npm:0.28.1"],\
290
+ ["@esbuild/linux-riscv64", "npm:0.28.1"],\
291
+ ["@esbuild/linux-s390x", "npm:0.28.1"],\
292
+ ["@esbuild/linux-x64", "npm:0.28.1"],\
293
+ ["@esbuild/netbsd-arm64", "npm:0.28.1"],\
294
+ ["@esbuild/netbsd-x64", "npm:0.28.1"],\
295
+ ["@esbuild/openbsd-arm64", "npm:0.28.1"],\
296
+ ["@esbuild/openbsd-x64", "npm:0.28.1"],\
297
+ ["@esbuild/openharmony-arm64", "npm:0.28.1"],\
298
+ ["@esbuild/sunos-x64", "npm:0.28.1"],\
299
+ ["@esbuild/win32-arm64", "npm:0.28.1"],\
300
+ ["@esbuild/win32-ia32", "npm:0.28.1"],\
301
+ ["@esbuild/win32-x64", "npm:0.28.1"],\
302
+ ["esbuild", "npm:0.28.1"]\
303
303
  ],\
304
304
  "linkType": "HARD"\
305
305
  }]\
@@ -308,7 +308,7 @@ const RAW_RUNTIME_STATE =
308
308
  ["workspace:.", {\
309
309
  "packageLocation": "./",\
310
310
  "packageDependencies": [\
311
- ["esbuild", "npm:0.25.12"],\
311
+ ["esbuild", "npm:0.28.1"],\
312
312
  ["grape-swagger-rails", "workspace:."],\
313
313
  ["typescript", "patch:typescript@npm%3A5.9.3#optional!builtin<compat/typescript>::version=5.9.3&hash=5786d5"]\
314
314
  ],\
@@ -317,7 +317,7 @@ const RAW_RUNTIME_STATE =
317
317
  ]],\
318
318
  ["typescript", [\
319
319
  ["patch:typescript@npm%3A5.9.3#optional!builtin<compat/typescript>::version=5.9.3&hash=5786d5", {\
320
- "packageLocation": "../../.yarn/berry/cache/typescript-patch-6fda4d02cf-10c0.zip/node_modules/typescript/",\
320
+ "packageLocation": "./.yarn/cache/typescript-patch-6fda4d02cf-ad09fdf7a7.zip/node_modules/typescript/",\
321
321
  "packageDependencies": [\
322
322
  ["typescript", "patch:typescript@npm%3A5.9.3#optional!builtin<compat/typescript>::version=5.9.3&hash=5786d5"]\
323
323
  ],\
data/.rubocop_todo.yml CHANGED
@@ -6,13 +6,6 @@
6
6
  # Note that changes in the inspected code, or installation of new
7
7
  # versions of RuboCop, may require this file to be generated again.
8
8
 
9
- # Offense count: 6
10
- # Configuration parameters: EnforcedStyle.
11
- # SupportedStyles: link_or_button, strict
12
- Capybara/ClickLinkOrButtonStyle:
13
- Exclude:
14
- - 'spec/features/swagger_spec.rb'
15
-
16
9
  # Offense count: 1
17
10
  # Configuration parameters: Severity, Include.
18
11
  # Include: **/*.gemspec
data/.yarnrc.yml ADDED
@@ -0,0 +1 @@
1
+ enableGlobalCache: false
data/CHANGELOG.md CHANGED
@@ -2,6 +2,19 @@
2
2
 
3
3
  * Your contribution here.
4
4
 
5
+ ### 1.0.3 (2026/06/23)
6
+
7
+ * [#158](https://github.com/ruby-grape/grape-swagger-rails/pull/158): Switch yarn to project-local cache so `.pnp.cjs` paths are stable across machines - [@moskvin](https://github.com/moskvin).
8
+ * [#164](https://github.com/ruby-grape/grape-swagger-rails/pull/164): Fix vertical alignment for description rows in swagger ui model box - [@moskvin](https://github.com/moskvin).
9
+ * [#166](https://github.com/ruby-grape/grape-swagger-rails/pull/166): Add security definitions for api key in swagger documentation - [@moskvin](https://github.com/moskvin).
10
+ * [#168](https://github.com/ruby-grape/grape-swagger-rails/pull/168): Bump swagger ui to 5.32.7 - [@moskvin](https://github.com/moskvin).
11
+
12
+ ### 1.0.2 (2026/05/26)
13
+
14
+ * [#162](https://github.com/ruby-grape/grape-swagger-rails/pull/162): Fix vertical alignment for property rows in swagger ui model box - [@moskvin](https://github.com/moskvin).
15
+ * [#160](https://github.com/ruby-grape/grape-swagger-rails/pull/160): Hide Swagger UI's confusing "Clear" button by default; expose `display[:clear_button]` to opt back in - [@moskvin](https://github.com/moskvin).
16
+ * [#159](https://github.com/ruby-grape/grape-swagger-rails/pull/159): Added github action update swagger ui version - [@moskvin](https://github.com/moskvin).
17
+
5
18
  ### 1.0.1 (2026/05/17)
6
19
 
7
20
  * [#155](https://github.com/ruby-grape/grape-swagger-rails/pull/155): Fix: autoload default spec and restyle version dropdown - [@moskvin](https://github.com/moskvin).
data/README.md CHANGED
@@ -46,9 +46,9 @@ This gem is continuously tested against the following stack:
46
46
 
47
47
  | Ruby | Rails | Grape | grape-swagger | Swagger UI |
48
48
  |-----:|--------:|--------:|--------------:|-----------:|
49
- | 3.4 | 7.2.2.2 | 1.8.x | 1.6.1 | 5.32.5 |
50
- | 3.2+ | 7.2.2.2 | 3.1.x | 2.1.4 | 5.32.5 |
51
- | 3.2+ | 8.1.x | 3.1.x | 2.1.4 | 5.32.5 |
49
+ | 3.4 | 7.2.2.2 | 1.8.x | 1.6.1 | 5.32.7 |
50
+ | 3.2+ | 7.2.2.2 | 3.1.x | 2.1.4 | 5.32.7 |
51
+ | 3.2+ | 8.1.x | 3.1.x | 2.1.4 | 5.32.7 |
52
52
 
53
53
  The dummy app and CI also exercise both supported Rails asset pipelines: Sprockets and Propshaft.
54
54
 
@@ -267,7 +267,8 @@ GrapeSwaggerRails.options.display = {
267
267
  api_key_input: false,
268
268
  info_url: false,
269
269
  doc_version: false,
270
- version_stamp: false
270
+ version_stamp: false,
271
+ clear_button: true
271
272
  }
272
273
  ```
273
274
 
@@ -277,12 +278,13 @@ Supported keys:
277
278
  - `info_url`: show or hide the API document URL link
278
279
  - `doc_version`: show or hide the API document version label
279
280
  - `version_stamp`: show or hide the `OAS 2.0` version stamp
281
+ - `clear_button`: show or hide Swagger UI's "Clear" button that appears next to "Execute" after "Try it out". Hidden by default because the upstream button only resets internal request/response state and leaves user-typed input values on screen, which is confusing (see [swagger-api/swagger-ui#5283](https://github.com/swagger-api/swagger-ui/issues/5283)).
280
282
 
281
- By default, all of these options are `true`.
283
+ By default, all of these options are `true` except `clear_button`, which defaults to `false`.
282
284
 
283
285
  ### Updating Swagger UI from Dist
284
286
 
285
- To update Swagger UI from its [distribution](https://github.com/wordnik/swagger-ui), run `bundle exec rake swagger_ui:dist:update`. Examine the changes carefully.
287
+ To update Swagger UI from its [distribution](https://github.com/swagger-api/swagger-ui), run `bundle exec rake swagger_ui:dist:update`. Examine the changes carefully.
286
288
 
287
289
  NOTE: This action should be run part of this gem (not your application). In case if you want to
288
290
  make it up-to-date, clone the repo, run the rake task, examine the diff, fix any bugs, make sure