grape-swagger-rails 1.0.10 → 2.0.1
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.
- checksums.yaml +4 -4
- data/.github/workflows/swagger-ui-update.yml +9 -4
- data/.github/workflows/test.yml +6 -31
- data/CHANGELOG.md +10 -0
- data/CLAUDE.md +1 -2
- data/Gemfile +3 -1
- data/README.md +4 -5
- data/UPGRADING.md +17 -0
- data/app/assets/javascripts/grape_swagger_rails/swagger-ui-bundle.js +1 -1
- data/grape-swagger-rails.gemspec +2 -3
- data/lib/grape-swagger-rails/version.rb +2 -2
- data/script/swagger_ui_release_notes +71 -0
- data/script/update_changelog +9 -2
- metadata +6 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ffcf0643d9b054671fd47900f9f02945c79d714fb03fa2f80031797690e2727e
|
|
4
|
+
data.tar.gz: 184ba65717b81357770ed99ba76e226e8df2c6ac9df68a31aeef4369589c59e7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e265e51c6eaed1ce5c8dfc3b79b1cbe2edafa75176af8434470867584b6b3ecc154e685b227f72a3cfb1e52fd60fea6e13996c05c337228cf6681446eba5a059
|
|
7
|
+
data.tar.gz: e34c23d74700a8ea688371ec9de88787489d4178cbc8a96eb4d1b843cbd96ad0f0e05d20d1b22e6a8c47915b75b0689c9e4101455ecd521cfe6176e366330162
|
|
@@ -46,6 +46,14 @@ jobs:
|
|
|
46
46
|
SWAGGER_UI_VERSION: ${{ steps.swagger-ui.outputs.latest-tag }}
|
|
47
47
|
run: bundle exec rake swagger_ui:dist:update
|
|
48
48
|
|
|
49
|
+
- name: Collect Swagger UI release notes
|
|
50
|
+
if: steps.swagger-ui.outputs.update-needed == 'true'
|
|
51
|
+
env:
|
|
52
|
+
GH_TOKEN: ${{ github.token }}
|
|
53
|
+
FROM_VERSION: ${{ steps.swagger-ui.outputs.current-version }}
|
|
54
|
+
TO_VERSION: ${{ steps.swagger-ui.outputs.latest-version }}
|
|
55
|
+
run: ruby script/swagger_ui_release_notes > "${RUNNER_TEMP}/pull-request-body.md"
|
|
56
|
+
|
|
49
57
|
- name: Create pull request
|
|
50
58
|
id: pull-request
|
|
51
59
|
if: steps.swagger-ui.outputs.update-needed == 'true'
|
|
@@ -56,10 +64,7 @@ jobs:
|
|
|
56
64
|
delete-branch: true
|
|
57
65
|
commit-message: Bump Swagger UI to ${{ steps.swagger-ui.outputs.latest-version }}
|
|
58
66
|
title: Bump Swagger UI to ${{ steps.swagger-ui.outputs.latest-version }}
|
|
59
|
-
body:
|
|
60
|
-
Updates bundled Swagger UI assets from swagger-api/swagger-ui `${{ steps.swagger-ui.outputs.latest-tag }}`.
|
|
61
|
-
|
|
62
|
-
Generated by the scheduled Swagger UI update workflow.
|
|
67
|
+
body-path: ${{ runner.temp }}/pull-request-body.md
|
|
63
68
|
|
|
64
69
|
# PRs created with GITHUB_TOKEN do not trigger the Danger PR workflow.
|
|
65
70
|
- name: Add the pull request to the changelog
|
data/.github/workflows/test.yml
CHANGED
|
@@ -10,39 +10,14 @@ jobs:
|
|
|
10
10
|
strategy:
|
|
11
11
|
fail-fast: false
|
|
12
12
|
matrix:
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
grape: '~> 1.8.0'
|
|
17
|
-
grape-swagger: '1.6.1'
|
|
18
|
-
- ruby: '3.2'
|
|
19
|
-
rails: '7.2.2.2'
|
|
20
|
-
grape: '~> 3.1.0'
|
|
21
|
-
grape-swagger: '2.1.4'
|
|
22
|
-
- ruby: '3.3'
|
|
23
|
-
rails: '7.2.2.2'
|
|
24
|
-
grape: '~> 3.1.0'
|
|
25
|
-
grape-swagger: '2.1.4'
|
|
26
|
-
- ruby: '3.4'
|
|
27
|
-
rails: '7.2.2.2'
|
|
28
|
-
grape: '~> 3.1.0'
|
|
29
|
-
grape-swagger: '2.1.4'
|
|
30
|
-
- ruby: '3.2'
|
|
31
|
-
rails: '~> 8.1.3'
|
|
32
|
-
grape: '~> 3.1.0'
|
|
33
|
-
grape-swagger: '2.1.4'
|
|
34
|
-
- ruby: '3.3'
|
|
35
|
-
rails: '~> 8.1.3'
|
|
36
|
-
grape: '~> 3.1.0'
|
|
37
|
-
grape-swagger: '2.1.4'
|
|
38
|
-
- ruby: '3.4'
|
|
39
|
-
rails: '~> 8.1.3'
|
|
40
|
-
grape: '~> 3.1.0'
|
|
41
|
-
grape-swagger: '2.1.4'
|
|
13
|
+
ruby: ['3.2', '3.3', '3.4']
|
|
14
|
+
rails: ['~> 8.1.4']
|
|
15
|
+
json: ['~> 2.0', '~> 3.0']
|
|
42
16
|
env:
|
|
43
|
-
GRAPE_VERSION:
|
|
44
|
-
GRAPE_SWAGGER_VERSION:
|
|
17
|
+
GRAPE_VERSION: '~> 3.1.0'
|
|
18
|
+
GRAPE_SWAGGER_VERSION: '2.1.4'
|
|
45
19
|
RAILS_VERSION: ${{ matrix.rails }}
|
|
20
|
+
JSON_VERSION: ${{ matrix.json }}
|
|
46
21
|
steps:
|
|
47
22
|
- uses: actions/checkout@v6
|
|
48
23
|
- name: Set up Ruby
|
data/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
* Your contribution here.
|
|
4
4
|
|
|
5
|
+
### 2.0.1 (2026/10/13)
|
|
6
|
+
|
|
7
|
+
* [#180](https://github.com/ruby-grape/grape-swagger-rails/pull/180): Bump Swagger UI to 5.33.1 - [@moskvin](https://github.com/moskvin).
|
|
8
|
+
* [#182](https://github.com/ruby-grape/grape-swagger-rails/pull/182): Fix Danger changelog check for bot PRs and add Swagger UI release notes - [@moskvin](https://github.com/moskvin).
|
|
9
|
+
* [#181](https://github.com/ruby-grape/grape-swagger-rails/pull/181): Bump Swagger UI to 5.33.2 - [@github-actions](https://github.com/apps/github-actions).
|
|
10
|
+
|
|
11
|
+
### 2.0.0 (2026/10/02)
|
|
12
|
+
|
|
13
|
+
* [#179](https://github.com/ruby-grape/grape-swagger-rails/pull/179): Require Rails 8.1.4+ and allow JSON 3 - [@moskvin](https://github.com/moskvin).
|
|
14
|
+
|
|
5
15
|
### 1.0.10 (2026/09/22)
|
|
6
16
|
|
|
7
17
|
* [#177](https://github.com/ruby-grape/grape-swagger-rails/pull/177): Bump Swagger UI to 5.33.0 - [@moskvin](https://github.com/moskvin).
|
data/CLAUDE.md
CHANGED
|
@@ -73,8 +73,7 @@ Config in `.rubocop.yml` targets Ruby 3.4. Plugins: rubocop-capybara, rubocop-rs
|
|
|
73
73
|
|
|
74
74
|
## Compatibility Matrix
|
|
75
75
|
|
|
76
|
-
- Rails
|
|
77
|
-
- Rails 7.2 × Ruby 3.2 × grape-swagger 1.6.1 (grape ~> 1.8) — legacy combination
|
|
76
|
+
- Rails 8.1.4–8.1.x × Ruby 3.2–3.4 × JSON 2/3 × grape-swagger 2.1.4 (grape ~> 3.1)
|
|
78
77
|
- Ruby 3.1 is excluded from Rails 8 (requires 3.2+)
|
|
79
78
|
- grape ~> 1.8 is not tested on Ruby 3.4: Ruby 3.4 tightened `Forwardable` to raise on private-method delegation, which breaks Mustermann's `named_captures` forwarding used by grape-swagger 1.6.1 to introspect routes
|
|
80
79
|
- Both Sprockets and Propshaft asset pipelines are tested in CI
|
data/Gemfile
CHANGED
|
@@ -18,13 +18,15 @@ else
|
|
|
18
18
|
gem 'grape-swagger', grape_swagger_version
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
-
case rails_version = ENV.fetch('RAILS_VERSION', '>=
|
|
21
|
+
case rails_version = ENV.fetch('RAILS_VERSION', '>= 8.1.4')
|
|
22
22
|
when 'edge'
|
|
23
23
|
gem 'railties', github: 'rails/rails', branch: 'main'
|
|
24
24
|
else
|
|
25
25
|
gem 'railties', rails_version
|
|
26
26
|
end
|
|
27
27
|
|
|
28
|
+
gem 'json', ENV.fetch('JSON_VERSION') if ENV.key?('JSON_VERSION')
|
|
29
|
+
|
|
28
30
|
group :development, :test do
|
|
29
31
|
gem 'capybara'
|
|
30
32
|
gem 'danger', require: false
|
data/README.md
CHANGED
|
@@ -44,13 +44,12 @@ Or install it yourself as:
|
|
|
44
44
|
|
|
45
45
|
This gem is continuously tested against the following stack:
|
|
46
46
|
|
|
47
|
-
| Ruby | Rails
|
|
48
|
-
|
|
49
|
-
| 3.
|
|
50
|
-
| 3.2+ | 7.2.2.2 | 3.1.x | 2.1.4 | 5.33.0 |
|
|
51
|
-
| 3.2+ | 8.1.x | 3.1.x | 2.1.4 | 5.33.0 |
|
|
47
|
+
| Ruby | Rails | JSON | Grape | grape-swagger | Swagger UI |
|
|
48
|
+
|-----:|-------:|--------:|------:|--------------:|-----------:|
|
|
49
|
+
| 3.2+ | 8.1.4–8.1.x | 2.x/3.x | 3.1.x | 2.1.4 | 5.33.0 |
|
|
52
50
|
|
|
53
51
|
The dummy app and CI also exercise both supported Rails asset pipelines: Sprockets and Propshaft.
|
|
52
|
+
Rails 8.1.4 is required for JSON 3 compatibility; older Rails versions remain supported by the 1.x gem releases.
|
|
54
53
|
|
|
55
54
|
If you use a nearby version and hit an issue, please open one with your `Gemfile.lock` and a minimal reproduction.
|
|
56
55
|
|
data/UPGRADING.md
CHANGED
|
@@ -1,6 +1,23 @@
|
|
|
1
1
|
Upgrading Grape Swagger Rails
|
|
2
2
|
=============================
|
|
3
3
|
|
|
4
|
+
### Upgrading to 2.0.0
|
|
5
|
+
|
|
6
|
+
Version `2.0.0` drops support for Rails versions older than 8.1.4 and allows JSON 3. See [#179](https://github.com/ruby-grape/grape-swagger-rails/pull/179).
|
|
7
|
+
|
|
8
|
+
#### Upgrade checklist
|
|
9
|
+
|
|
10
|
+
1. Upgrade your application to Rails `>= 8.1.4, < 8.2`. The gem now depends on `railties >= 8.1.4, < 8.2` (previously `>= 7.2.2.2, < 8.2`); Rails 8.1.4 is the first release compatible with JSON 3.
|
|
11
|
+
2. The Ruby requirement is unchanged (`>= 3.2`).
|
|
12
|
+
3. The `json < 3.0` upper bound was removed, so both `json` 2.x and 3.x are supported. No configuration changes are needed.
|
|
13
|
+
4. If you cannot upgrade Rails yet, stay on the 1.x line:
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
gem 'grape-swagger-rails', '~> 1.0'
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
No `GrapeSwaggerRails.options` or template changes are required.
|
|
20
|
+
|
|
4
21
|
### Upgrading to 1.0.0
|
|
5
22
|
|
|
6
23
|
Version `1.0.0` includes a major Swagger UI integration refresh and several configuration additions.
|