gitlab-grape-openapi 0.0.0 → 0.1.0

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 (39) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +222 -4
  4. data/lib/gitlab/grape_openapi/concerns/fail_fast_annotatable.rb +23 -0
  5. data/lib/gitlab/grape_openapi/concerns/limit_resolver.rb +31 -0
  6. data/lib/gitlab/grape_openapi/concerns/regex_converter.rb +58 -0
  7. data/lib/gitlab/grape_openapi/concerns/serializable.rb +19 -0
  8. data/lib/gitlab/grape_openapi/configuration.rb +24 -0
  9. data/lib/gitlab/grape_openapi/converters/coercer_resolver.rb +74 -0
  10. data/lib/gitlab/grape_openapi/converters/entity_converter.rb +267 -0
  11. data/lib/gitlab/grape_openapi/converters/operation_converter.rb +250 -0
  12. data/lib/gitlab/grape_openapi/converters/parameter_converter.rb +252 -0
  13. data/lib/gitlab/grape_openapi/converters/path_converter.rb +152 -0
  14. data/lib/gitlab/grape_openapi/converters/request_body_converter.rb +97 -0
  15. data/lib/gitlab/grape_openapi/converters/response_converter.rb +185 -0
  16. data/lib/gitlab/grape_openapi/converters/tag_converter.rb +36 -0
  17. data/lib/gitlab/grape_openapi/converters/type_resolver.rb +75 -0
  18. data/lib/gitlab/grape_openapi/generator.rb +60 -0
  19. data/lib/gitlab/grape_openapi/models/info.rb +29 -0
  20. data/lib/gitlab/grape_openapi/models/operation.rb +47 -0
  21. data/lib/gitlab/grape_openapi/models/parameter.rb +43 -0
  22. data/lib/gitlab/grape_openapi/models/path_item.rb +26 -0
  23. data/lib/gitlab/grape_openapi/models/request_body/parameter_schema.rb +250 -0
  24. data/lib/gitlab/grape_openapi/models/request_body/parameters.rb +87 -0
  25. data/lib/gitlab/grape_openapi/models/response.rb +48 -0
  26. data/lib/gitlab/grape_openapi/models/schema.rb +61 -0
  27. data/lib/gitlab/grape_openapi/models/security_scheme.rb +130 -0
  28. data/lib/gitlab/grape_openapi/models/server.rb +31 -0
  29. data/lib/gitlab/grape_openapi/models/server_variable.rb +25 -0
  30. data/lib/gitlab/grape_openapi/models/tag.rb +44 -0
  31. data/lib/gitlab/grape_openapi/request_body_registry.rb +57 -0
  32. data/lib/gitlab/grape_openapi/schema_registry.rb +26 -0
  33. data/lib/gitlab/grape_openapi/serializers/time.rb +19 -0
  34. data/lib/gitlab/grape_openapi/tag_registry.rb +29 -0
  35. data/lib/gitlab/grape_openapi/version.rb +8 -0
  36. data/lib/gitlab-grape-openapi.rb +64 -0
  37. metadata +162 -12
  38. data/lib/gitlab/grape/openapi/version.rb +0 -9
  39. data/lib/gitlab/grape/openapi.rb +0 -21
metadata CHANGED
@@ -1,16 +1,129 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gitlab-grape-openapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.0
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - group::api
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-10-03 00:00:00.000000000 Z
12
- dependencies: []
13
- description: Reserved for GitLab
11
+ date: 2026-06-03 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: grape
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 2.0.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 2.0.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: grape-entity
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 1.0.1
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 1.0.1
41
+ - !ruby/object:Gem::Dependency
42
+ name: js_regex
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.8'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.8'
55
+ - !ruby/object:Gem::Dependency
56
+ name: gitlab-styles
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '13.1'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '13.1'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rake
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '13.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '13.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '3.0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '3.0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rubocop
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '1.71'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.71'
111
+ - !ruby/object:Gem::Dependency
112
+ name: rubocop-rspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '3.0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '3.0'
125
+ description: A Ruby gem that introspects Grape API definitions and generates OpenAPI
126
+ 3.0 specification files
14
127
  email:
15
128
  - engineering@gitlab.com
16
129
  executables: []
@@ -19,11 +132,48 @@ extra_rdoc_files: []
19
132
  files:
20
133
  - LICENSE
21
134
  - README.md
22
- - lib/gitlab/grape/openapi.rb
23
- - lib/gitlab/grape/openapi/version.rb
24
- homepage:
25
- licenses: []
26
- metadata: {}
135
+ - lib/gitlab-grape-openapi.rb
136
+ - lib/gitlab/grape_openapi/concerns/fail_fast_annotatable.rb
137
+ - lib/gitlab/grape_openapi/concerns/limit_resolver.rb
138
+ - lib/gitlab/grape_openapi/concerns/regex_converter.rb
139
+ - lib/gitlab/grape_openapi/concerns/serializable.rb
140
+ - lib/gitlab/grape_openapi/configuration.rb
141
+ - lib/gitlab/grape_openapi/converters/coercer_resolver.rb
142
+ - lib/gitlab/grape_openapi/converters/entity_converter.rb
143
+ - lib/gitlab/grape_openapi/converters/operation_converter.rb
144
+ - lib/gitlab/grape_openapi/converters/parameter_converter.rb
145
+ - lib/gitlab/grape_openapi/converters/path_converter.rb
146
+ - lib/gitlab/grape_openapi/converters/request_body_converter.rb
147
+ - lib/gitlab/grape_openapi/converters/response_converter.rb
148
+ - lib/gitlab/grape_openapi/converters/tag_converter.rb
149
+ - lib/gitlab/grape_openapi/converters/type_resolver.rb
150
+ - lib/gitlab/grape_openapi/generator.rb
151
+ - lib/gitlab/grape_openapi/models/info.rb
152
+ - lib/gitlab/grape_openapi/models/operation.rb
153
+ - lib/gitlab/grape_openapi/models/parameter.rb
154
+ - lib/gitlab/grape_openapi/models/path_item.rb
155
+ - lib/gitlab/grape_openapi/models/request_body/parameter_schema.rb
156
+ - lib/gitlab/grape_openapi/models/request_body/parameters.rb
157
+ - lib/gitlab/grape_openapi/models/response.rb
158
+ - lib/gitlab/grape_openapi/models/schema.rb
159
+ - lib/gitlab/grape_openapi/models/security_scheme.rb
160
+ - lib/gitlab/grape_openapi/models/server.rb
161
+ - lib/gitlab/grape_openapi/models/server_variable.rb
162
+ - lib/gitlab/grape_openapi/models/tag.rb
163
+ - lib/gitlab/grape_openapi/request_body_registry.rb
164
+ - lib/gitlab/grape_openapi/schema_registry.rb
165
+ - lib/gitlab/grape_openapi/serializers/time.rb
166
+ - lib/gitlab/grape_openapi/tag_registry.rb
167
+ - lib/gitlab/grape_openapi/version.rb
168
+ homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi
169
+ licenses:
170
+ - MIT
171
+ metadata:
172
+ homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi
173
+ source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi
174
+ changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi/-/blob/main/CHANGELOG.md
175
+ bug_tracker_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-grape-openapi/-/issues
176
+ rubygems_mfa_required: 'true'
27
177
  post_install_message:
28
178
  rdoc_options: []
29
179
  require_paths:
@@ -32,15 +182,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
32
182
  requirements:
33
183
  - - ">="
34
184
  - !ruby/object:Gem::Version
35
- version: 3.1.0
185
+ version: 3.2.0
36
186
  required_rubygems_version: !ruby/object:Gem::Requirement
37
187
  requirements:
38
188
  - - ">="
39
189
  - !ruby/object:Gem::Version
40
190
  version: '0'
41
191
  requirements: []
42
- rubygems_version: 3.5.11
192
+ rubygems_version: 3.5.22
43
193
  signing_key:
44
194
  specification_version: 4
45
- summary: Reserved for GitLab
195
+ summary: Generate OpenAPI 3.0 specifications from Grape APIs
46
196
  test_files: []
@@ -1,9 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Gitlab
4
- module Grape
5
- module Openapi
6
- VERSION = "0.0.0"
7
- end
8
- end
9
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "openapi/version"
4
-
5
- module Gitlab
6
- module Grape
7
- module Openapi
8
- class ReservedError < StandardError; end
9
-
10
- class << self
11
- def method_missing(*)
12
- raise ReservedError, "Reserved for GitLab"
13
- end
14
-
15
- def const_missing(*)
16
- raise ReservedError, "Reserved for GitLab"
17
- end
18
- end
19
- end
20
- end
21
- end