r2-oas 0.3.1 → 0.4.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +50 -0
- data/GEMSPEC.md +2 -2
- data/README.ja.md +54 -37
- data/README.md +55 -32
- data/lib/r2-oas.rb +4 -5
- data/lib/r2-oas/app_configuration.rb +17 -5
- data/lib/r2-oas/app_configuration/deprecation.rb +28 -0
- data/lib/r2-oas/configuration.rb +56 -0
- data/lib/r2-oas/deploy/client.rb +21 -6
- data/lib/r2-oas/{plugins/schema/v3/object → dynamic/schema/v3/object/from_routes}/hookable_base_object.rb +7 -7
- data/lib/r2-oas/errors.rb +5 -0
- data/lib/r2-oas/hooks/hook.rb +7 -5
- data/lib/r2-oas/lib/core_ext/all.rb +5 -0
- data/lib/r2-oas/lib/core_ext/string/filters.rb +29 -0
- data/lib/r2-oas/pluggable_configuration.rb +8 -5
- data/lib/r2-oas/plugin/base.rb +44 -0
- data/lib/r2-oas/plugin/executor.rb +148 -0
- data/lib/r2-oas/plugin/hookable.rb +42 -0
- data/lib/r2-oas/plugin/public.rb +3 -0
- data/lib/r2-oas/plugin/transform/transform.rb +10 -0
- data/lib/r2-oas/plugin/transform/v3/transform.rb +20 -0
- data/lib/r2-oas/plugin/transform/v3/visitable.rb +37 -0
- data/lib/r2-oas/public.rb +5 -0
- data/lib/r2-oas/schema/base.rb +1 -1
- data/lib/r2-oas/schema/builder.rb +1 -1
- data/lib/r2-oas/schema/editor.rb +8 -1
- data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb +1 -1
- data/lib/r2-oas/schema/v3/builder.rb +1 -1
- data/lib/r2-oas/schema/v3/builder/base_builder.rb +14 -2
- data/lib/r2-oas/schema/v3/builder/doc_builder.rb +10 -2
- data/lib/r2-oas/schema/v3/generator/base_generator.rb +7 -2
- data/lib/r2-oas/schema/v3/generator/doc_generator.rb +1 -1
- data/lib/r2-oas/schema/v3/manager/file/include_ref_base_file_manager.rb +3 -2
- data/lib/r2-oas/schema/v3/object/from_files/base_object.rb +62 -0
- data/lib/r2-oas/schema/v3/object/from_files/components/request_body_object.rb +103 -0
- data/lib/r2-oas/schema/v3/object/from_files/components/schema_object.rb +102 -0
- data/lib/r2-oas/schema/v3/object/from_files/components_object.rb +46 -0
- data/lib/r2-oas/schema/v3/object/from_files/external_document_object.rb +23 -0
- data/lib/r2-oas/schema/v3/object/from_files/info_object.rb +23 -0
- data/lib/r2-oas/schema/v3/object/from_files/openapi_object.rb +61 -0
- data/lib/r2-oas/schema/v3/object/from_files/path_item_object.rb +110 -0
- data/lib/r2-oas/schema/v3/object/from_files/paths_object.rb +33 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/all.rb +4 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/deep_methods.rb +27 -0
- data/lib/r2-oas/schema/v3/object/from_files/utils/refs.rb +151 -0
- data/lib/r2-oas/schema/v3/object/{base_object.rb → from_routes/base_object.rb} +11 -1
- data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/request_body_object.rb +23 -19
- data/lib/r2-oas/schema/v3/object/{components → from_routes/components}/schema_object.rb +16 -12
- data/lib/r2-oas/schema/v3/object/{components_object.rb → from_routes/components_object.rb} +11 -11
- data/lib/r2-oas/schema/v3/object/from_routes/external_document_object.rb +28 -0
- data/lib/r2-oas/schema/v3/object/{info_object.rb → from_routes/info_object.rb} +11 -2
- data/lib/r2-oas/schema/v3/object/{openapi_object.rb → from_routes/openapi_object.rb} +12 -11
- data/lib/r2-oas/schema/v3/object/{path_item_object.rb → from_routes/path_item_object.rb} +6 -6
- data/lib/r2-oas/schema/v3/object/{paths_object.rb → from_routes/paths_object.rb} +11 -8
- data/lib/r2-oas/schema/v3/object/{public.rb → from_routes/public.rb} +0 -0
- data/lib/r2-oas/schema/v3/object/{server_object.rb → from_routes/server_object.rb} +0 -0
- data/lib/r2-oas/schema/v3/object/{tag_object.rb → from_routes/tag_object.rb} +2 -1
- data/lib/r2-oas/schema/v3/object/store.rb +54 -0
- data/lib/r2-oas/shared/all.rb +1 -0
- data/lib/r2-oas/shared/callable.rb +17 -0
- data/lib/r2-oas/store.rb +20 -16
- data/lib/r2-oas/support/deprecation.rb +26 -0
- data/lib/r2-oas/support/deprecation/behavior.rb +21 -0
- data/lib/r2-oas/support/deprecation/instance_delegator.rb +42 -0
- data/lib/r2-oas/support/deprecation/reporting.rb +91 -0
- data/lib/r2-oas/task.rb +1 -2
- data/lib/r2-oas/task_logging.rb +3 -7
- data/lib/r2-oas/tasks/common.rake +1 -2
- data/lib/r2-oas/tasks/main.rake +60 -9
- data/lib/r2-oas/version.rb +1 -1
- data/r2-oas.gemspec +1 -6
- metadata +51 -110
- data/.github/ISSUE_TEMPLATE.md +0 -12
- data/.github/PULL_REQUEST_TEMPLATE.md +0 -12
- data/.gitignore +0 -16
- data/.rspec +0 -3
- data/.rubocop.yml +0 -10
- data/.rubocop_todo.yml +0 -291
- data/.travis.yml +0 -26
- data/Appraisals +0 -13
- data/CODE_OF_CONDUCT.md +0 -74
- data/Gemfile +0 -12
- data/Rakefile +0 -8
- data/bin/console +0 -12
- data/bin/setup +0 -8
- data/devscript/all_support_ruby.sh +0 -43
- data/devscript/bundle_for_all_support_ruby.sh +0 -31
- data/devscript/rspec_for_all_support_ruby.sh +0 -27
- data/docs/.nojekyll +0 -0
- data/docs/README.md +0 -173
- data/docs/_sidebar.md +0 -25
- data/docs/attention/if_clash.md +0 -17
- data/docs/index.html +0 -29
- data/docs/schema/3.0.0.md +0 -155
- data/docs/setting/COC.md +0 -14
- data/docs/setting/CORS.md +0 -22
- data/docs/setting/configure.md +0 -176
- data/docs/trableshouting/runtime_error.md +0 -44
- data/docs/usage/analyze_docs.md +0 -875
- data/docs/usage/clean_docs.md +0 -19
- data/docs/usage/deploy_docs.md +0 -839
- data/docs/usage/display_paths_list.md +0 -35
- data/docs/usage/display_paths_stats.md +0 -54
- data/docs/usage/edit_docs.md +0 -218
- data/docs/usage/generate_docs.md +0 -412
- data/docs/usage/monitor_docs.md +0 -219
- data/docs/usage/use_hook_methods.md +0 -236
- data/docs/usage/use_hook_to_generate_docs.md +0 -235
- data/docs/usage/use_schema_namespace.md +0 -181
- data/docs/usage/use_tag_namespace.md +0 -180
- data/docs/usage/view_docs.md +0 -262
- data/gemfiles/ruby_2.3.3.gemfile +0 -11
- data/gemfiles/ruby_2.4.2.gemfile +0 -11
- data/gemfiles/ruby_2.5.8.gemfile +0 -11
- data/gemfiles/ruby_2.6.6.gemfile +0 -11
- data/gemfiles/ruby_2.7.1.gemfile +0 -11
- data/lib/r2-oas/app_configuration/tool.rb +0 -31
- data/lib/r2-oas/app_configuration/tool/paths/stats.rb +0 -43
- data/lib/r2-oas/deploy/swagger-ui/dist/favicon-16x16.png +0 -0
- data/lib/r2-oas/deploy/swagger-ui/dist/favicon-32x32.png +0 -0
- data/lib/r2-oas/deploy/swagger-ui/dist/oauth2-redirect.html +0 -68
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js +0 -134
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-bundle.js.map +0 -1
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js +0 -22
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui-standalone-preset.js.map +0 -1
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css +0 -4
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.css.map +0 -1
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js +0 -9
- data/lib/r2-oas/deploy/swagger-ui/dist/swagger-ui.js.map +0 -1
- data/lib/r2-oas/schema/v3/object/external_document_object.rb +0 -19
- data/lib/r2-oas/tasks/tool.rake +0 -76
- data/lib/r2-oas/tool/paths/ls.rb +0 -15
- data/lib/r2-oas/tool/paths/stats.rb +0 -84
data/docs/usage/view_docs.md
DELETED
@@ -1,262 +0,0 @@
|
|
1
|
-
# View docs
|
2
|
-
|
3
|
-
## Prepare
|
4
|
-
|
5
|
-
Add this line to your application's Gemfile:
|
6
|
-
|
7
|
-
```ruby
|
8
|
-
group :development do
|
9
|
-
gem 'r2-oas'
|
10
|
-
end
|
11
|
-
```
|
12
|
-
|
13
|
-
## Command
|
14
|
-
|
15
|
-
```bash
|
16
|
-
$ bundle exec rake routes:oas:ui
|
17
|
-
```
|
18
|
-
|
19
|
-
## Example
|
20
|
-
|
21
|
-
if there is routing like this:
|
22
|
-
|
23
|
-
```
|
24
|
-
$ bundle exec rake routes
|
25
|
-
Prefix Verb URI Pattern Controller#Action
|
26
|
-
rails_admin /admin RailsAdmin::Engine
|
27
|
-
api_v2_posts GET /api/v2/posts(.:format) api/v2/posts#index {:format=>:json}
|
28
|
-
POST /api/v2/posts(.:format) api/v2/posts#create {:format=>:json}
|
29
|
-
new_api_v2_post GET /api/v2/posts/new(.:format) api/v2/posts#new {:format=>:json}
|
30
|
-
edit_api_v2_post GET /api/v2/posts/:id/edit(.:format) api/v2/posts#edit {:format=>:json}
|
31
|
-
api_v2_post GET /api/v2/posts/:id(.:format) api/v2/posts#show {:format=>:json}
|
32
|
-
PATCH /api/v2/posts/:id(.:format) api/v2/posts#update {:format=>:json}
|
33
|
-
PUT /api/v2/posts/:id(.:format) api/v2/posts#update {:format=>:json}
|
34
|
-
DELETE /api/v2/posts/:id(.:format) api/v2/posts#destroy {:format=>:json}
|
35
|
-
api_v1_posts GET /api/v1/posts(.:format) api/v1/posts#index
|
36
|
-
POST /api/v1/posts(.:format) api/v1/posts#create
|
37
|
-
new_api_v1_post GET /api/v1/posts/new(.:format) api/v1/posts#new
|
38
|
-
edit_api_v1_post GET /api/v1/posts/:id/edit(.:format) api/v1/posts#edit
|
39
|
-
api_v1_post GET /api/v1/posts/:id(.:format) api/v1/posts#show
|
40
|
-
PATCH /api/v1/posts/:id(.:format) api/v1/posts#update
|
41
|
-
PUT /api/v1/posts/:id(.:format) api/v1/posts#update
|
42
|
-
DELETE /api/v1/posts/:id(.:format) api/v1/posts#destroy
|
43
|
-
api_v1_tasks GET /api/v1/tasks(.:format) api/v1/tasks#index
|
44
|
-
POST /api/v1/tasks(.:format) api/v1/tasks#create
|
45
|
-
new_api_v1_task GET /api/v1/tasks/new(.:format) api/v1/tasks#new
|
46
|
-
edit_api_v1_task GET /api/v1/tasks/:id/edit(.:format) api/v1/tasks#edit
|
47
|
-
api_v1_task GET /api/v1/tasks/:id(.:format) api/v1/tasks#show
|
48
|
-
PATCH /api/v1/tasks/:id(.:format) api/v1/tasks#update
|
49
|
-
PUT /api/v1/tasks/:id(.:format) api/v1/tasks#update
|
50
|
-
DELETE /api/v1/tasks/:id(.:format) api/v1/tasks#destroy
|
51
|
-
tasks GET /tasks(.:format) tasks#index
|
52
|
-
POST /tasks(.:format) tasks#create
|
53
|
-
new_task GET /tasks/new(.:format) tasks#new
|
54
|
-
edit_task GET /tasks/:id/edit(.:format) tasks#edit
|
55
|
-
task GET /tasks/:id(.:format) tasks#show
|
56
|
-
PATCH /tasks/:id(.:format) tasks#update
|
57
|
-
PUT /tasks/:id(.:format) tasks#update
|
58
|
-
DELETE /tasks/:id(.:format) tasks#destroy
|
59
|
-
users GET /users(.:format) users#index
|
60
|
-
POST /users(.:format) users#create
|
61
|
-
new_user GET /users/new(.:format) users#new
|
62
|
-
edit_user GET /users/:id/edit(.:format) users#edit
|
63
|
-
user GET /users/:id(.:format) users#show
|
64
|
-
PATCH /users/:id(.:format) users#update
|
65
|
-
PUT /users/:id(.:format) users#update
|
66
|
-
DELETE /users/:id(.:format) users#destroy
|
67
|
-
|
68
|
-
Routes for RailsAdmin::Engine:
|
69
|
-
dashboard GET / rails_admin/main#dashboard
|
70
|
-
index GET|POST /:model_name(.:format) rails_admin/main#index
|
71
|
-
new GET|POST /:model_name/new(.:format) rails_admin/main#new
|
72
|
-
export GET|POST /:model_name/export(.:format) rails_admin/main#export
|
73
|
-
bulk_delete POST|DELETE /:model_name/bulk_delete(.:format) rails_admin/main#bulk_delete
|
74
|
-
bulk_action POST /:model_name/bulk_action(.:format) rails_admin/main#bulk_action
|
75
|
-
show GET /:model_name/:id(.:format) rails_admin/main#show
|
76
|
-
edit GET|PUT /:model_name/:id/edit(.:format) rails_admin/main#edit
|
77
|
-
delete GET|DELETE /:model_name/:id/delete(.:format) rails_admin/main#delete
|
78
|
-
show_in_app GET /:model_name/:id/show_in_app(.:format) rails_admin/main#show_in_app
|
79
|
-
```
|
80
|
-
|
81
|
-
#### First try
|
82
|
-
|
83
|
-
The ui starts up with the schema set.
|
84
|
-
|
85
|
-
<img alt="swagger_ui" src="https://user-images.githubusercontent.com/11146767/56875699-6d606180-6a7d-11e9-9947-4edae2fd48cb.png" width="546">
|
86
|
-
|
87
|
-
```
|
88
|
-
I, [2019-04-29T12:53:03.010443 #10516] INFO -- : [R2-OAS] start
|
89
|
-
I, [2019-04-29T12:53:03.010557 #10516] INFO -- : [R2-OAS] start
|
90
|
-
I, [2019-04-29T12:53:03.133380 #10516] INFO -- : [Build OAS schema files] start
|
91
|
-
I, [2019-04-29T12:53:03.133776 #10516] INFO -- : <From schema files>
|
92
|
-
I, [2019-04-29T12:53:03.135212 #10516] INFO -- : Fetch schema file: oas_docs/src/openapi.yml
|
93
|
-
I, [2019-04-29T12:53:03.136340 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
|
94
|
-
I, [2019-04-29T12:53:03.137207 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
|
95
|
-
I, [2019-04-29T12:53:03.137860 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/post.yml
|
96
|
-
I, [2019-04-29T12:53:03.138488 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v2/post.yml
|
97
|
-
I, [2019-04-29T12:53:03.139113 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/task.yml
|
98
|
-
I, [2019-04-29T12:53:03.139660 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/engine.yml
|
99
|
-
I, [2019-04-29T12:53:03.141082 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/main.yml
|
100
|
-
I, [2019-04-29T12:53:03.141426 #10516] INFO -- : Fetch schema file: oas_docs/src/externalDocs.yml
|
101
|
-
I, [2019-04-29T12:53:03.142055 #10516] INFO -- : Fetch schema file: oas_docs/src/tags.yml
|
102
|
-
I, [2019-04-29T12:53:03.142364 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/user.yml
|
103
|
-
I, [2019-04-29T12:53:03.142690 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
104
|
-
I, [2019-04-29T12:53:03.143078 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/api/v1/post.yml
|
105
|
-
I, [2019-04-29T12:53:03.143408 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/api/v2/post.yml
|
106
|
-
I, [2019-04-29T12:53:03.143643 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/task.yml
|
107
|
-
I, [2019-04-29T12:53:03.143971 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/rails_admin/engine.yml
|
108
|
-
I, [2019-04-29T12:53:03.144315 #10516] INFO -- : Fetch schema file: oas_docs/src/components/schemas/rails_admin/main.yml
|
109
|
-
I, [2019-04-29T12:53:03.144806 #10516] INFO -- : Fetch schema file: oas_docs/src/info.yml
|
110
|
-
I, [2019-04-29T12:53:03.145013 #10516] INFO -- : Fetch schema file: oas_docs/src/servers.yml
|
111
|
-
I, [2019-04-29T12:53:03.145597 #10516] INFO -- : <Update schema files>
|
112
|
-
I, [2019-04-29T12:53:03.146179 #10516] INFO -- : Merge schema file: oas_docs/src/openapi.yml
|
113
|
-
I, [2019-04-29T12:53:03.146613 #10516] INFO -- : Merge schema file: oas_docs/src/info.yml
|
114
|
-
I, [2019-04-29T12:53:03.147470 #10516] INFO -- : Merge schema file: oas_docs/src/tags.yml
|
115
|
-
I, [2019-04-29T12:53:03.147492 #10516] INFO -- : [Build OAS schema files (paths)] start
|
116
|
-
I, [2019-04-29T12:53:03.183824 #10516] INFO -- : <From schema files>
|
117
|
-
I, [2019-04-29T12:53:03.184629 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
|
118
|
-
I, [2019-04-29T12:53:03.185143 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
|
119
|
-
I, [2019-04-29T12:53:03.185661 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/post.yml
|
120
|
-
I, [2019-04-29T12:53:03.186202 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/api/v2/post.yml
|
121
|
-
I, [2019-04-29T12:53:03.186675 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/task.yml
|
122
|
-
I, [2019-04-29T12:53:03.187142 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/engine.yml
|
123
|
-
I, [2019-04-29T12:53:03.188050 #10516] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/main.yml
|
124
|
-
I, [2019-04-29T12:53:03.188673 #10516] INFO -- : <Update schema files (paths)>
|
125
|
-
I, [2019-04-29T12:53:03.189751 #10516] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/engine.yml
|
126
|
-
I, [2019-04-29T12:53:03.190945 #10516] INFO -- : Merge schema file: oas_docs/src/paths/api/v2/post.yml
|
127
|
-
I, [2019-04-29T12:53:03.192400 #10516] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/post.yml
|
128
|
-
I, [2019-04-29T12:53:03.193803 #10516] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/task.yml
|
129
|
-
I, [2019-04-29T12:53:03.195408 #10516] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
|
130
|
-
I, [2019-04-29T12:53:03.196820 #10516] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
|
131
|
-
I, [2019-04-29T12:53:03.199474 #10516] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
|
132
|
-
I, [2019-04-29T12:53:03.199496 #10516] INFO -- : [Build OAS schema files (paths)] end
|
133
|
-
I, [2019-04-29T12:53:03.199768 #10516] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
|
134
|
-
I, [2019-04-29T12:53:03.200231 #10516] INFO -- : Merge schema file: oas_docs/src/servers.yml
|
135
|
-
I, [2019-04-29T12:53:03.200257 #10516] INFO -- : [Build OAS schema files (components)] start
|
136
|
-
I, [2019-04-29T12:53:03.268381 #10516] INFO -- : <From schema files>
|
137
|
-
I, [2019-04-29T12:53:03.268772 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/user.yml
|
138
|
-
I, [2019-04-29T12:53:03.268969 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
139
|
-
I, [2019-04-29T12:53:03.269135 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/post.yml
|
140
|
-
I, [2019-04-29T12:53:03.269280 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v2/post.yml
|
141
|
-
I, [2019-04-29T12:53:03.269427 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/task.yml
|
142
|
-
I, [2019-04-29T12:53:03.269642 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/rails_admin/engine.yml
|
143
|
-
I, [2019-04-29T12:53:03.269793 #10516] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/rails_admin/main.yml
|
144
|
-
I, [2019-04-29T12:53:03.269847 #10516] INFO -- : <Update Components schema files (components/schemas)>
|
145
|
-
I, [2019-04-29T12:53:03.270491 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/engine.yml
|
146
|
-
I, [2019-04-29T12:53:03.271096 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v2/post.yml
|
147
|
-
I, [2019-04-29T12:53:03.271632 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v1/post.yml
|
148
|
-
I, [2019-04-29T12:53:03.272166 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
149
|
-
I, [2019-04-29T12:53:03.272620 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/task.yml
|
150
|
-
I, [2019-04-29T12:53:03.273053 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/user.yml
|
151
|
-
I, [2019-04-29T12:53:03.273541 #10516] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/main.yml
|
152
|
-
I, [2019-04-29T12:53:03.273562 #10516] INFO -- : [Build OAS schema files (components)] end
|
153
|
-
I, [2019-04-29T12:53:03.273574 #10516] INFO -- : [Build OAS schema files] end
|
154
|
-
I, [2019-04-29T12:53:03.273584 #10516] INFO -- : [Build OAS docs from schema files] start
|
155
|
-
I, [2019-04-29T12:53:03.274133 #10516] INFO -- : Use schema file: oas_docs/src/openapi.yml
|
156
|
-
I, [2019-04-29T12:53:03.274566 #10516] INFO -- : Use schema file: oas_docs/src/paths/user.yml
|
157
|
-
I, [2019-04-29T12:53:03.275000 #10516] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
|
158
|
-
I, [2019-04-29T12:53:03.275443 #10516] INFO -- : Use schema file: oas_docs/src/paths/api/v1/post.yml
|
159
|
-
I, [2019-04-29T12:53:03.276159 #10516] INFO -- : Use schema file: oas_docs/src/paths/api/v2/post.yml
|
160
|
-
I, [2019-04-29T12:53:03.277020 #10516] INFO -- : Use schema file: oas_docs/src/paths/task.yml
|
161
|
-
I, [2019-04-29T12:53:03.277364 #10516] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/engine.yml
|
162
|
-
I, [2019-04-29T12:53:03.278296 #10516] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/main.yml
|
163
|
-
I, [2019-04-29T12:53:03.278432 #10516] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
|
164
|
-
I, [2019-04-29T12:53:03.278747 #10516] INFO -- : Use schema file: oas_docs/src/tags.yml
|
165
|
-
I, [2019-04-29T12:53:03.278897 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/user.yml
|
166
|
-
I, [2019-04-29T12:53:03.279043 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
167
|
-
I, [2019-04-29T12:53:03.279210 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/api/v1/post.yml
|
168
|
-
I, [2019-04-29T12:53:03.279356 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/api/v2/post.yml
|
169
|
-
I, [2019-04-29T12:53:03.279566 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/task.yml
|
170
|
-
I, [2019-04-29T12:53:03.279759 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/rails_admin/engine.yml
|
171
|
-
I, [2019-04-29T12:53:03.279935 #10516] INFO -- : Use schema file: oas_docs/src/components/schemas/rails_admin/main.yml
|
172
|
-
I, [2019-04-29T12:53:03.280107 #10516] INFO -- : Use schema file: oas_docs/src/info.yml
|
173
|
-
I, [2019-04-29T12:53:03.280223 #10516] INFO -- : Use schema file: oas_docs/src/servers.yml
|
174
|
-
I, [2019-04-29T12:53:03.301656 #10516] INFO -- : [Build OAS docs from schema files] end
|
175
|
-
I, [2019-04-29T12:53:03.301698 #10516] INFO -- : [R2-OAS] end
|
176
|
-
|
177
|
-
wait for single trap ...
|
178
|
-
|
179
|
-
```
|
180
|
-
|
181
|
-
When you press `Ctrl + C` , the ui closes and the following message appears.
|
182
|
-
|
183
|
-
```
|
184
|
-
^Ccontainer id: edd950ec30507b1138af1b714f0101ef0452d32d08b66e23eb6e22740c830576 removed
|
185
|
-
I, [2019-04-29T12:54:14.333082 #10516] INFO -- : [R2-OAS] end
|
186
|
-
```
|
187
|
-
|
188
|
-
## Use PATHS_FILE environment
|
189
|
-
|
190
|
-
If you want to generate docs by squeezing unit paths (For example, `api/v1/task.yml`),
|
191
|
-
you set `PATHS_FILE` environment like this:
|
192
|
-
|
193
|
-
```bash
|
194
|
-
$ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor
|
195
|
-
```
|
196
|
-
|
197
|
-
<img alt="swagger_ui_by_specify_schemas" src="https://user-images.githubusercontent.com/11146767/56875847-38084380-6a7e-11e9-90db-9710459da44c.png" width="546">
|
198
|
-
|
199
|
-
```
|
200
|
-
I, [2019-04-29T12:55:15.434226 #10698] INFO -- : [R2-OAS] start
|
201
|
-
I, [2019-04-29T12:55:15.434334 #10698] INFO -- : [R2-OAS] start
|
202
|
-
I, [2019-04-29T12:55:15.550674 #10698] INFO -- : [Build OAS schema files] start
|
203
|
-
I, [2019-04-29T12:55:15.551016 #10698] INFO -- : <From schema files>
|
204
|
-
I, [2019-04-29T12:55:15.551724 #10698] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
|
205
|
-
I, [2019-04-29T12:55:15.551870 #10698] INFO -- : Fetch schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
206
|
-
I, [2019-04-29T12:55:15.552005 #10698] INFO -- : Fetch schema file: oas_docs/src/openapi.yml
|
207
|
-
I, [2019-04-29T12:55:15.552257 #10698] INFO -- : Fetch schema file: oas_docs/src/externalDocs.yml
|
208
|
-
I, [2019-04-29T12:55:15.552608 #10698] INFO -- : Fetch schema file: oas_docs/src/tags.yml
|
209
|
-
I, [2019-04-29T12:55:15.552847 #10698] INFO -- : Fetch schema file: oas_docs/src/info.yml
|
210
|
-
I, [2019-04-29T12:55:15.553001 #10698] INFO -- : Fetch schema file: oas_docs/src/servers.yml
|
211
|
-
I, [2019-04-29T12:55:15.553144 #10698] INFO -- : <Update schema files>
|
212
|
-
I, [2019-04-29T12:55:15.553650 #10698] INFO -- : Merge schema file: oas_docs/src/openapi.yml
|
213
|
-
I, [2019-04-29T12:55:15.554101 #10698] INFO -- : Merge schema file: oas_docs/src/info.yml
|
214
|
-
I, [2019-04-29T12:55:15.555634 #10698] INFO -- : Merge schema file: oas_docs/src/tags.yml
|
215
|
-
I, [2019-04-29T12:55:15.555714 #10698] INFO -- : [Build OAS schema files (paths)] start
|
216
|
-
I, [2019-04-29T12:55:15.589466 #10698] INFO -- : <From schema files>
|
217
|
-
I, [2019-04-29T12:55:15.590112 #10698] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
|
218
|
-
I, [2019-04-29T12:55:15.590216 #10698] INFO -- : <Update schema files (paths)>
|
219
|
-
I, [2019-04-29T12:55:15.591618 #10698] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/engine.yml
|
220
|
-
I, [2019-04-29T12:55:15.593567 #10698] INFO -- : Merge schema file: oas_docs/src/paths/api/v2/post.yml
|
221
|
-
I, [2019-04-29T12:55:15.595107 #10698] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/post.yml
|
222
|
-
I, [2019-04-29T12:55:15.596491 #10698] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/task.yml
|
223
|
-
I, [2019-04-29T12:55:15.598158 #10698] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
|
224
|
-
I, [2019-04-29T12:55:15.599531 #10698] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
|
225
|
-
I, [2019-04-29T12:55:15.602490 #10698] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
|
226
|
-
I, [2019-04-29T12:55:15.602516 #10698] INFO -- : [Build OAS schema files (paths)] end
|
227
|
-
I, [2019-04-29T12:55:15.602822 #10698] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
|
228
|
-
I, [2019-04-29T12:55:15.603159 #10698] INFO -- : Merge schema file: oas_docs/src/servers.yml
|
229
|
-
I, [2019-04-29T12:55:15.603181 #10698] INFO -- : [Build OAS schema files (components)] start
|
230
|
-
I, [2019-04-29T12:55:15.669796 #10698] INFO -- : <From schema files>
|
231
|
-
I, [2019-04-29T12:55:15.670091 #10698] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
232
|
-
I, [2019-04-29T12:55:15.670122 #10698] INFO -- : <Update Components schema files (components/schemas)>
|
233
|
-
I, [2019-04-29T12:55:15.670729 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/engine.yml
|
234
|
-
I, [2019-04-29T12:55:15.671278 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v2/post.yml
|
235
|
-
I, [2019-04-29T12:55:15.671796 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v1/post.yml
|
236
|
-
I, [2019-04-29T12:55:15.672328 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
237
|
-
I, [2019-04-29T12:55:15.672745 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/task.yml
|
238
|
-
I, [2019-04-29T12:55:15.673160 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/user.yml
|
239
|
-
I, [2019-04-29T12:55:15.673729 #10698] INFO -- : Merge schema file: oas_docs/src/components/schemas/rails_admin/main.yml
|
240
|
-
I, [2019-04-29T12:55:15.673771 #10698] INFO -- : [Build OAS schema files (components)] end
|
241
|
-
I, [2019-04-29T12:55:15.673785 #10698] INFO -- : [Build OAS schema files] end
|
242
|
-
I, [2019-04-29T12:55:15.673830 #10698] INFO -- : [Build OAS docs from schema files] start
|
243
|
-
I, [2019-04-29T12:55:15.674608 #10698] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
|
244
|
-
I, [2019-04-29T12:55:15.674796 #10698] INFO -- : Use schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
245
|
-
I, [2019-04-29T12:55:15.675010 #10698] INFO -- : Use schema file: oas_docs/src/openapi.yml
|
246
|
-
I, [2019-04-29T12:55:15.675144 #10698] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
|
247
|
-
I, [2019-04-29T12:55:15.675523 #10698] INFO -- : Use schema file: oas_docs/src/tags.yml
|
248
|
-
I, [2019-04-29T12:55:15.675700 #10698] INFO -- : Use schema file: oas_docs/src/info.yml
|
249
|
-
I, [2019-04-29T12:55:15.675817 #10698] INFO -- : Use schema file: oas_docs/src/servers.yml
|
250
|
-
I, [2019-04-29T12:55:15.679925 #10698] INFO -- : [Build OAS docs from schema files] end
|
251
|
-
I, [2019-04-29T12:55:15.679950 #10698] INFO -- : [R2-OAS] end
|
252
|
-
|
253
|
-
wait for single trap ...
|
254
|
-
|
255
|
-
```
|
256
|
-
|
257
|
-
When you press `Ctrl + C` , the ui closes and the following message appears.
|
258
|
-
|
259
|
-
```
|
260
|
-
^Ccontainer id: dfb4752353f17dd8c1eb60ea53049575ce9e0cf04d928499441dc06754955875 removed
|
261
|
-
I, [2019-04-29T12:58:02.840740 #10698] INFO -- : [R2-OAS] end
|
262
|
-
```
|
data/gemfiles/ruby_2.3.3.gemfile
DELETED
data/gemfiles/ruby_2.4.2.gemfile
DELETED
data/gemfiles/ruby_2.5.8.gemfile
DELETED
data/gemfiles/ruby_2.6.6.gemfile
DELETED
data/gemfiles/ruby_2.7.1.gemfile
DELETED
@@ -1,31 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
require_relative 'tool/paths/stats'
|
4
|
-
|
5
|
-
module R2OAS
|
6
|
-
module AppConfiguration
|
7
|
-
class Tool
|
8
|
-
DEFAULT_PATHS_STATS = PathsStats.new
|
9
|
-
|
10
|
-
VALID_OPTIONS_KEYS = [
|
11
|
-
:paths_stats
|
12
|
-
].freeze
|
13
|
-
|
14
|
-
attr_accessor *VALID_OPTIONS_KEYS
|
15
|
-
|
16
|
-
def initialize
|
17
|
-
set_default
|
18
|
-
end
|
19
|
-
|
20
|
-
def configure
|
21
|
-
yield self
|
22
|
-
end
|
23
|
-
|
24
|
-
private
|
25
|
-
|
26
|
-
def set_default
|
27
|
-
self.paths_stats = DEFAULT_PATHS_STATS
|
28
|
-
end
|
29
|
-
end
|
30
|
-
end
|
31
|
-
end
|
@@ -1,43 +0,0 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
module R2OAS
|
4
|
-
module AppConfiguration
|
5
|
-
class Tool
|
6
|
-
class PathsStats
|
7
|
-
DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR = 3
|
8
|
-
DEFAULT_WARNING_COLOR = :red
|
9
|
-
DEFAULT_TABLE_TITLE_COLOR = :yellow
|
10
|
-
DEFAULT_HEADING_COLOR = :yellow
|
11
|
-
DEFAULT_HIGHLIGHT_COLOR = :magenta
|
12
|
-
|
13
|
-
VALID_OPTIONS_KEYS = %i[
|
14
|
-
month_to_turn_to_warning_color
|
15
|
-
warning_color
|
16
|
-
table_title_color
|
17
|
-
heading_color
|
18
|
-
highlight_color
|
19
|
-
].freeze
|
20
|
-
|
21
|
-
attr_accessor *VALID_OPTIONS_KEYS
|
22
|
-
|
23
|
-
def initialize
|
24
|
-
set_default
|
25
|
-
end
|
26
|
-
|
27
|
-
def configure
|
28
|
-
yield self
|
29
|
-
end
|
30
|
-
|
31
|
-
private
|
32
|
-
|
33
|
-
def set_default
|
34
|
-
self.month_to_turn_to_warning_color = DEFAULT_MONTH_TO_TURN_TO_WARNING_COLOR
|
35
|
-
self.warning_color = DEFAULT_WARNING_COLOR
|
36
|
-
self.table_title_color = DEFAULT_TABLE_TITLE_COLOR
|
37
|
-
self.heading_color = DEFAULT_HEADING_COLOR
|
38
|
-
self.highlight_color = DEFAULT_HIGHLIGHT_COLOR
|
39
|
-
end
|
40
|
-
end
|
41
|
-
end
|
42
|
-
end
|
43
|
-
end
|
Binary file
|
Binary file
|
@@ -1,68 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html lang="en-US">
|
3
|
-
<title>Swagger UI: OAuth2 Redirect</title>
|
4
|
-
<body onload="run()">
|
5
|
-
</body>
|
6
|
-
</html>
|
7
|
-
<script>
|
8
|
-
'use strict';
|
9
|
-
function run () {
|
10
|
-
var oauth2 = window.opener.swaggerUIRedirectOauth2;
|
11
|
-
var sentState = oauth2.state;
|
12
|
-
var redirectUrl = oauth2.redirectUrl;
|
13
|
-
var isValid, qp, arr;
|
14
|
-
|
15
|
-
if (/code|token|error/.test(window.location.hash)) {
|
16
|
-
qp = window.location.hash.substring(1);
|
17
|
-
} else {
|
18
|
-
qp = location.search.substring(1);
|
19
|
-
}
|
20
|
-
|
21
|
-
arr = qp.split("&")
|
22
|
-
arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';})
|
23
|
-
qp = qp ? JSON.parse('{' + arr.join() + '}',
|
24
|
-
function (key, value) {
|
25
|
-
return key === "" ? value : decodeURIComponent(value)
|
26
|
-
}
|
27
|
-
) : {}
|
28
|
-
|
29
|
-
isValid = qp.state === sentState
|
30
|
-
|
31
|
-
if ((
|
32
|
-
oauth2.auth.schema.get("flow") === "accessCode"||
|
33
|
-
oauth2.auth.schema.get("flow") === "authorizationCode"
|
34
|
-
) && !oauth2.auth.code) {
|
35
|
-
if (!isValid) {
|
36
|
-
oauth2.errCb({
|
37
|
-
authId: oauth2.auth.name,
|
38
|
-
source: "auth",
|
39
|
-
level: "warning",
|
40
|
-
message: "Authorization may be unsafe, passed state was changed in server Passed state wasn't returned from auth server"
|
41
|
-
});
|
42
|
-
}
|
43
|
-
|
44
|
-
if (qp.code) {
|
45
|
-
delete oauth2.state;
|
46
|
-
oauth2.auth.code = qp.code;
|
47
|
-
oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
|
48
|
-
} else {
|
49
|
-
let oauthErrorMsg
|
50
|
-
if (qp.error) {
|
51
|
-
oauthErrorMsg = "["+qp.error+"]: " +
|
52
|
-
(qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
|
53
|
-
(qp.error_uri ? "More info: "+qp.error_uri : "");
|
54
|
-
}
|
55
|
-
|
56
|
-
oauth2.errCb({
|
57
|
-
authId: oauth2.auth.name,
|
58
|
-
source: "auth",
|
59
|
-
level: "error",
|
60
|
-
message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server"
|
61
|
-
});
|
62
|
-
}
|
63
|
-
} else {
|
64
|
-
oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
|
65
|
-
}
|
66
|
-
window.close();
|
67
|
-
}
|
68
|
-
</script>
|