r2-oas 0.1.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +4 -0
  3. data/.rubocop.yml +6 -3
  4. data/.rubocop_todo.yml +68 -1
  5. data/.travis.yml +6 -2
  6. data/Appraisals +13 -0
  7. data/CHANGELOG.md +58 -1
  8. data/GEMSPEC.md +20 -0
  9. data/README.ja.md +65 -396
  10. data/README.md +62 -392
  11. data/devscript/all_support_ruby.sh +43 -0
  12. data/devscript/bundle_for_all_support_ruby.sh +31 -0
  13. data/devscript/rspec_for_all_support_ruby.sh +27 -0
  14. data/docs/.nojekyll +0 -0
  15. data/docs/README.md +173 -0
  16. data/docs/_sidebar.md +25 -0
  17. data/docs/attention/if_clash.md +17 -0
  18. data/docs/index.html +29 -0
  19. data/docs/{versions/v3.md → schema/3.0.0.md} +1 -1
  20. data/docs/setting/COC.md +14 -0
  21. data/docs/setting/CORS.md +22 -0
  22. data/docs/setting/configure.md +176 -0
  23. data/docs/trableshouting/runtime_error.md +44 -0
  24. data/docs/{HOW_TO_ANALYZE_DOCS.md → usage/analyze_docs.md} +52 -52
  25. data/docs/usage/clean_docs.md +19 -0
  26. data/docs/{HOW_TO_DEPLOY_SWAGGER_DOC.md → usage/deploy_docs.md} +29 -29
  27. data/docs/usage/display_paths_list.md +35 -0
  28. data/docs/{HOW_TO_DISPLAY_PATHS_STATS.md → usage/display_paths_stats.md} +15 -14
  29. data/docs/{HOW_TO_START_SWAGGER_EDITOR.md → usage/edit_docs.md} +88 -88
  30. data/docs/usage/generate_docs.md +412 -0
  31. data/docs/{HOW_TO_MONITOR_SWAGGER_DOC.md → usage/monitor_docs.md} +71 -71
  32. data/docs/usage/use_hook_methods.md +236 -0
  33. data/docs/{HOW_TO_USE_HOOK_WHEN_GENERATE_DOC.md → usage/use_hook_to_generate_docs.md} +48 -57
  34. data/docs/{HOW_TO_USE_SCHEMA_NAMESPACE.md → usage/use_schema_namespace.md} +46 -41
  35. data/docs/{HOW_TO_USE_TAG_NAMESPACE.md → usage/use_tag_namespace.md} +46 -42
  36. data/docs/{HOW_TO_START_SWAGGER_UI.md → usage/view_docs.md} +132 -132
  37. data/gemfiles/ruby_2.3.3.gemfile +11 -0
  38. data/gemfiles/ruby_2.4.2.gemfile +11 -0
  39. data/gemfiles/ruby_2.5.8.gemfile +11 -0
  40. data/gemfiles/ruby_2.6.6.gemfile +11 -0
  41. data/gemfiles/ruby_2.7.1.gemfile +11 -0
  42. data/lib/r2-oas.rb +3 -4
  43. data/lib/r2-oas/app_configuration.rb +19 -16
  44. data/lib/r2-oas/deploy/client.rb +14 -2
  45. data/lib/r2-oas/errors.rb +1 -0
  46. data/lib/r2-oas/lib/core_ext/hash/deep_merge.rb +44 -0
  47. data/lib/r2-oas/lib/core_ext/object/blank.rb +135 -0
  48. data/lib/r2-oas/lib/three-way-merge/twm.rb +83 -0
  49. data/lib/r2-oas/schema/builder.rb +23 -0
  50. data/lib/r2-oas/schema/editor.rb +26 -7
  51. data/lib/r2-oas/schema/generator.rb +1 -1
  52. data/lib/r2-oas/schema/manager/file_manager.rb +26 -0
  53. data/lib/r2-oas/schema/ui.rb +0 -1
  54. data/lib/r2-oas/schema/v3/analyzer/base_analyzer.rb +1 -6
  55. data/lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb +1 -1
  56. data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb +1 -1
  57. data/lib/r2-oas/schema/v3/analyzer/tag_analyzer.rb +1 -1
  58. data/lib/r2-oas/schema/v3/builder.rb +28 -0
  59. data/lib/r2-oas/schema/v3/builder/base_builder.rb +60 -0
  60. data/lib/r2-oas/schema/v3/builder/doc_builder.rb +43 -0
  61. data/lib/r2-oas/schema/v3/cleaner/base_cleaner.rb +1 -1
  62. data/lib/r2-oas/schema/v3/generator.rb +1 -5
  63. data/lib/r2-oas/schema/v3/generator/base_generator.rb +30 -1
  64. data/lib/r2-oas/schema/v3/generator/components/object_generator.rb +6 -25
  65. data/lib/r2-oas/schema/v3/generator/components/request_body_generator.rb +6 -6
  66. data/lib/r2-oas/schema/v3/generator/doc_generator.rb +84 -18
  67. data/lib/r2-oas/schema/v3/generator/path_generator.rb +7 -19
  68. data/lib/r2-oas/schema/v3/generator/schema_generator.rb +6 -26
  69. data/lib/r2-oas/schema/v3/manager/file/base_file_manager.rb +10 -4
  70. data/lib/r2-oas/schema/v3/manager/pathname_manager.rb +6 -1
  71. data/lib/r2-oas/schema/v3/object/path_item_object.rb +17 -9
  72. data/lib/r2-oas/store.rb +118 -0
  73. data/lib/r2-oas/task_logging.rb +6 -0
  74. data/lib/r2-oas/tasks/main.rake +66 -73
  75. data/lib/r2-oas/tasks/tool.rake +25 -28
  76. data/lib/r2-oas/tool/paths/ls.rb +1 -1
  77. data/lib/r2-oas/version.rb +1 -1
  78. data/r2-oas.gemspec +20 -25
  79. metadata +122 -52
  80. data/Gemfile.lock +0 -207
  81. data/docs/HOW_TO_CLEAN_DOCS.md +0 -19
  82. data/docs/HOW_TO_DISPLAY_PATHS_LIST.md +0 -28
  83. data/docs/HOW_TO_GENERATE_DOCS.md +0 -256
data/docs/usage/generate_docs.md ADDED
@@ -0,0 +1,412 @@
1
+ # Generate 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:docs
17
+ ```
18
+
19
+ ## Example
20
+
21
+ if there is routing like this:
22
+
23
+
24
+ [config/routes.rb]
25
+ ```ruby
26
+ Rails.application.routes.draw do
27
+ namespace :api do
28
+ namespace :v2 do
29
+ resources :posts
30
+ end
31
+ end
32
+ namespace :api do
33
+ namespace :v1 do
34
+ resources :tasks
35
+ end
36
+ end
37
+ resources :users
38
+ # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
39
+ end
40
+ ```
41
+
42
+ #### First try
43
+
44
+ ```
45
+ $ bundle exec rake routes:oas:docs
46
+ I, [2020-05-01T00:26:30.037255 #32948] INFO -- : [R2-OAS] start
47
+ I, [2020-05-01T00:26:30.672796 #32948] INFO -- : [Generate OAS schema files] start
48
+ I, [2020-05-01T00:26:30.672844 #32948] INFO -- : <From routes data>
49
+ I, [2020-05-01T00:26:30.672860 #32948] INFO -- : <Update schema files>
50
+ I, [2020-05-01T00:26:30.674709 #32948] INFO -- : Add schema file into store: oas_docs/src/openapi.yml
51
+ I, [2020-05-01T00:26:30.677510 #32948] INFO -- : Add schema file into store: oas_docs/src/info.yml
52
+ I, [2020-05-01T00:26:30.679245 #32948] INFO -- : Add schema file into store: oas_docs/src/tags.yml
53
+ I, [2020-05-01T00:26:30.679266 #32948] INFO -- : [Generate OAS schema files (paths)] start
54
+ I, [2020-05-01T00:26:30.733419 #32948] INFO -- : <From routes data>
55
+ I, [2020-05-01T00:26:30.733458 #32948] INFO -- : <Update schema files (paths)>
56
+ I, [2020-05-01T00:26:30.739675 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/api/v1/task.yml
57
+ I, [2020-05-01T00:26:30.746521 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/api/v2/post.yml
58
+ I, [2020-05-01T00:26:30.748522 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/blob.yml
59
+ I, [2020-05-01T00:26:30.750825 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/direct_upload.yml
60
+ I, [2020-05-01T00:26:30.753929 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/disk.yml
61
+ I, [2020-05-01T00:26:30.755903 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/representation.yml
62
+ I, [2020-05-01T00:26:30.761207 #32948] INFO -- : Add schema file into store: oas_docs/src/paths/user.yml
63
+ I, [2020-05-01T00:26:30.761230 #32948] INFO -- : [Generate OAS schema files (paths)] end
64
+ I, [2020-05-01T00:26:30.762215 #32948] INFO -- : Add schema file into store: oas_docs/src/external_docs.yml
65
+ I, [2020-05-01T00:26:30.763149 #32948] INFO -- : Add schema file into store: oas_docs/src/servers.yml
66
+ I, [2020-05-01T00:26:30.763188 #32948] INFO -- : [Generate OAS schema files (components)] start
67
+ I, [2020-05-01T00:26:30.866904 #32948] INFO -- : <From routes data>
68
+ I, [2020-05-01T00:26:30.866941 #32948] INFO -- : <Update Components schema files (components/schemas)>
69
+ I, [2020-05-01T00:26:30.868176 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
70
+ I, [2020-05-01T00:26:30.869116 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/blob.yml
71
+ I, [2020-05-01T00:26:30.870156 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
72
+ I, [2020-05-01T00:26:30.871289 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
73
+ I, [2020-05-01T00:26:30.872316 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/representation.yml
74
+ I, [2020-05-01T00:26:30.873301 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
75
+ I, [2020-05-01T00:26:30.874282 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
76
+ I, [2020-05-01T00:26:30.925057 #32948] INFO -- : <From routes data>
77
+ I, [2020-05-01T00:26:30.925096 #32948] INFO -- : <Update Components schema files (components/requestBodies)>
78
+ I, [2020-05-01T00:26:30.927746 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
79
+ I, [2020-05-01T00:26:30.929966 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
80
+ I, [2020-05-01T00:26:30.932245 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
81
+ I, [2020-05-01T00:26:30.934686 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
82
+ I, [2020-05-01T00:26:30.937036 #32948] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
83
+ I, [2020-05-01T00:26:30.994492 #32948] INFO -- : <From routes data>
84
+ I, [2020-05-01T00:26:30.994534 #32948] INFO -- : <Update Components schema files (components/securitySchemes)>
85
+ I, [2020-05-01T00:26:31.057864 #32948] INFO -- : <From routes data>
86
+ I, [2020-05-01T00:26:31.057907 #32948] INFO -- : <Update Components schema files (components/parameters)>
87
+ I, [2020-05-01T00:26:31.112288 #32948] INFO -- : <From routes data>
88
+ I, [2020-05-01T00:26:31.112324 #32948] INFO -- : <Update Components schema files (components/responses)>
89
+ I, [2020-05-01T00:26:31.168867 #32948] INFO -- : <From routes data>
90
+ I, [2020-05-01T00:26:31.168905 #32948] INFO -- : <Update Components schema files (components/examples)>
91
+ I, [2020-05-01T00:26:31.221234 #32948] INFO -- : <From routes data>
92
+ I, [2020-05-01T00:26:31.221311 #32948] INFO -- : <Update Components schema files (components/headers)>
93
+ I, [2020-05-01T00:26:31.278310 #32948] INFO -- : <From routes data>
94
+ I, [2020-05-01T00:26:31.278346 #32948] INFO -- : <Update Components schema files (components/links)>
95
+ I, [2020-05-01T00:26:31.332940 #32948] INFO -- : <From routes data>
96
+ I, [2020-05-01T00:26:31.333018 #32948] INFO -- : <Update Components schema files (components/callbacks)>
97
+ I, [2020-05-01T00:26:31.333037 #32948] INFO -- : [Generate OAS schema files (components)] end
98
+ I, [2020-05-01T00:26:31.335576 #32948] INFO -- : [Generate OAS docs] Update cache at ./oas_docs/.docs
99
+ I, [2020-05-01T00:26:31.335616 #32948] INFO -- : [Generate OAS schema files] end
100
+ I, [2020-05-01T00:26:31.335634 #32948] INFO -- : [R2-OAS] end
101
+ ```
102
+
103
+ Generate like this:
104
+
105
+ ```
106
+ $ tree -a oas_docs
107
+ oas_docs
108
+ ├── .docs
109
+ ├── .paths
110
+ └── src
111
+ ├── components
112
+ │   ├── requestBodies
113
+ │   │   ├── activestorage
114
+ │   │   │   ├── direct_upload.yml
115
+ │   │   │   └── disk.yml
116
+ │   │   ├── api
117
+ │   │   │   ├── v1
118
+ │   │   │   │   └── task.yml
119
+ │   │   │   └── v2
120
+ │   │   │   └── post.yml
121
+ │   │   └── user.yml
122
+ │   └── schemas
123
+ │   ├── activestorage
124
+ │   │   ├── blob.yml
125
+ │   │   ├── direct_upload.yml
126
+ │   │   ├── disk.yml
127
+ │   │   └── representation.yml
128
+ │   ├── api
129
+ │   │   ├── v1
130
+ │   │   │   └── task.yml
131
+ │   │   └── v2
132
+ │   │   └── post.yml
133
+ │   └── user.yml
134
+ ├── external_docs.yml
135
+ ├── info.yml
136
+ ├── openapi.yml
137
+ ├── paths
138
+ │   ├── active_storage
139
+ │   │   ├── blob.yml
140
+ │   │   ├── direct_upload.yml
141
+ │   │   ├── disk.yml
142
+ │   │   └── representation.yml
143
+ │   ├── api
144
+ │   │   ├── v1
145
+ │   │   │   └── task.yml
146
+ │   │   └── v2
147
+ │   │   └── post.yml
148
+ │   └── user.yml
149
+ ├── servers.yml
150
+ └── tags.yml
151
+
152
+ 17 directories, 26 files
153
+ ```
154
+
155
+ #### Second Try (Change routes)
156
+
157
+ If routing changes like this:
158
+
159
+ ```diff
160
+ Rails.application.routes.draw do
161
+ namespace :api do
162
+ namespace :v2 do
163
+ resources :posts
164
+ end
165
+ end
166
+ namespace :api do
167
+ namespace :v1 do
168
+ + resources :tasks, only: [:index, :create]
169
+ - resources :tasks
170
+ end
171
+ end
172
+ resources :users
173
+ # For details on the DSL available within this file, see http://guides.rubyonrails.org/routing.html
174
+ end
175
+ ```
176
+
177
+ When the `bundle exec rake routes:oas:docs` command is executed in this state, it becomes as follows:
178
+
179
+ ```
180
+ I, [2020-05-01T01:06:35.982655 #34660] INFO -- : [R2-OAS] start
181
+ I, [2020-05-01T01:06:36.508949 #34660] INFO -- : [Generate OAS schema files] start
182
+ I, [2020-05-01T01:06:36.509027 #34660] INFO -- : <From routes data>
183
+ I, [2020-05-01T01:06:36.509053 #34660] INFO -- : <Update schema files>
184
+ I, [2020-05-01T01:06:36.511900 #34660] INFO -- : Add schema file into store: oas_docs/src/openapi.yml
185
+ I, [2020-05-01T01:06:36.513213 #34660] INFO -- : Add schema file into store: oas_docs/src/info.yml
186
+ I, [2020-05-01T01:06:36.515045 #34660] INFO -- : Add schema file into store: oas_docs/src/tags.yml
187
+ I, [2020-05-01T01:06:36.515066 #34660] INFO -- : [Generate OAS schema files (paths)] start
188
+ I, [2020-05-01T01:06:36.572245 #34660] INFO -- : <From routes data>
189
+ I, [2020-05-01T01:06:36.572281 #34660] INFO -- : <Update schema files (paths)>
190
+ I, [2020-05-01T01:06:36.574396 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/api/v1/task.yml
191
+ I, [2020-05-01T01:06:36.580388 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/api/v2/post.yml
192
+ I, [2020-05-01T01:06:36.582187 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/blob.yml
193
+ I, [2020-05-01T01:06:36.583721 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/direct_upload.yml
194
+ I, [2020-05-01T01:06:36.585989 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/disk.yml
195
+ I, [2020-05-01T01:06:36.588352 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/representation.yml
196
+ I, [2020-05-01T01:06:36.594436 #34660] INFO -- : Add schema file into store: oas_docs/src/paths/user.yml
197
+ I, [2020-05-01T01:06:36.594470 #34660] INFO -- : [Generate OAS schema files (paths)] end
198
+ I, [2020-05-01T01:06:36.595590 #34660] INFO -- : Add schema file into store: oas_docs/src/external_docs.yml
199
+ I, [2020-05-01T01:06:36.596515 #34660] INFO -- : Add schema file into store: oas_docs/src/servers.yml
200
+ I, [2020-05-01T01:06:36.596534 #34660] INFO -- : [Generate OAS schema files (components)] start
201
+ I, [2020-05-01T01:06:36.717794 #34660] INFO -- : <From routes data>
202
+ I, [2020-05-01T01:06:36.717835 #34660] INFO -- : <Update Components schema files (components/schemas)>
203
+ I, [2020-05-01T01:06:36.718962 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
204
+ I, [2020-05-01T01:06:36.719937 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/blob.yml
205
+ I, [2020-05-01T01:06:36.720934 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
206
+ I, [2020-05-01T01:06:36.722095 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
207
+ I, [2020-05-01T01:06:36.723164 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/representation.yml
208
+ I, [2020-05-01T01:06:36.724655 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
209
+ I, [2020-05-01T01:06:36.725850 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
210
+ I, [2020-05-01T01:06:36.777317 #34660] INFO -- : <From routes data>
211
+ I, [2020-05-01T01:06:36.777355 #34660] INFO -- : <Update Components schema files (components/requestBodies)>
212
+ I, [2020-05-01T01:06:36.779647 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
213
+ I, [2020-05-01T01:06:36.782242 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
214
+ I, [2020-05-01T01:06:36.784386 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
215
+ I, [2020-05-01T01:06:36.786612 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
216
+ I, [2020-05-01T01:06:36.788868 #34660] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
217
+ I, [2020-05-01T01:06:36.841673 #34660] INFO -- : <From routes data>
218
+ I, [2020-05-01T01:06:36.841712 #34660] INFO -- : <Update Components schema files (components/securitySchemes)>
219
+ I, [2020-05-01T01:06:36.893801 #34660] INFO -- : <From routes data>
220
+ I, [2020-05-01T01:06:36.893842 #34660] INFO -- : <Update Components schema files (components/parameters)>
221
+ I, [2020-05-01T01:06:36.948128 #34660] INFO -- : <From routes data>
222
+ I, [2020-05-01T01:06:36.948166 #34660] INFO -- : <Update Components schema files (components/responses)>
223
+ I, [2020-05-01T01:06:37.000992 #34660] INFO -- : <From routes data>
224
+ I, [2020-05-01T01:06:37.001030 #34660] INFO -- : <Update Components schema files (components/examples)>
225
+ I, [2020-05-01T01:06:37.053304 #34660] INFO -- : <From routes data>
226
+ I, [2020-05-01T01:06:37.053342 #34660] INFO -- : <Update Components schema files (components/headers)>
227
+ I, [2020-05-01T01:06:37.109044 #34660] INFO -- : <From routes data>
228
+ I, [2020-05-01T01:06:37.109082 #34660] INFO -- : <Update Components schema files (components/links)>
229
+ I, [2020-05-01T01:06:37.159305 #34660] INFO -- : <From routes data>
230
+ I, [2020-05-01T01:06:37.159343 #34660] INFO -- : <Update Components schema files (components/callbacks)>
231
+ I, [2020-05-01T01:06:37.159354 #34660] INFO -- : [Generate OAS schema files (components)] end
232
+ I, [2020-05-01T01:06:37.160924 #34660] INFO -- : Delete schema file: oas_docs/src/paths/api/v1/task.yml
233
+ I, [2020-05-01T01:06:37.161753 #34660] INFO -- : Write schema file: oas_docs/src/paths/api/v1/task.yml
234
+ I, [2020-05-01T01:06:37.162357 #34660] INFO -- : [Generate OAS docs] Update cache at ./oas_docs/.docs
235
+ I, [2020-05-01T01:06:37.162374 #34660] INFO -- : [Generate OAS schema files] end
236
+ I, [2020-05-01T01:06:37.162386 #34660] INFO -- : [R2-OAS] end
237
+ ```
238
+
239
+ The file is updated by the route deleted in this way. The behavior will be the same when adding.
240
+
241
+ ## Create Cache Docs [Important]
242
+
243
+ It is a function of `v0.1.4` or later that the `.docs` file is generated when the `bundle exec rake routes:oas:docs` command is executed, so those who have used it before that need to hit the following command to create the` .docs` file.
244
+
245
+ ```bash
246
+ CACHE_DOCS=true bundle exec rake routes:oas:docs
247
+ ```
248
+
249
+ Create the cache information of API document with reference to the current information of `config/routes.rb`. Files under `src/**/**.yml` are not affected
250
+
251
+ <details>
252
+
253
+ ```
254
+ $ CACHE_DOCS=true bundle exec rake routes:oas:docs
255
+ I, [2020-05-01T01:31:23.512339 #38857] INFO -- : [R2-OAS] start
256
+ I, [2020-05-01T01:31:24.103471 #38857] INFO -- : [Generate OAS schema files] start
257
+ I, [2020-05-01T01:31:24.103509 #38857] INFO -- : <From routes data>
258
+ I, [2020-05-01T01:31:24.103546 #38857] INFO -- : <Update schema files>
259
+ I, [2020-05-01T01:31:24.106149 #38857] INFO -- : Add schema file into store: oas_docs/src/openapi.yml
260
+ I, [2020-05-01T01:31:24.108049 #38857] INFO -- : Add schema file into store: oas_docs/src/info.yml
261
+ I, [2020-05-01T01:31:24.110170 #38857] INFO -- : Add schema file into store: oas_docs/src/tags.yml
262
+ I, [2020-05-01T01:31:24.110190 #38857] INFO -- : [Generate OAS schema files (paths)] start
263
+ I, [2020-05-01T01:31:24.161252 #38857] INFO -- : <From routes data>
264
+ I, [2020-05-01T01:31:24.161307 #38857] INFO -- : <Update schema files (paths)>
265
+ I, [2020-05-01T01:31:24.168345 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/api/v1/task.yml
266
+ I, [2020-05-01T01:31:24.174644 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/api/v2/post.yml
267
+ I, [2020-05-01T01:31:24.177262 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/blob.yml
268
+ I, [2020-05-01T01:31:24.179036 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/direct_upload.yml
269
+ I, [2020-05-01T01:31:24.182049 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/disk.yml
270
+ I, [2020-05-01T01:31:24.184352 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/representation.yml
271
+ I, [2020-05-01T01:31:24.191103 #38857] INFO -- : Add schema file into store: oas_docs/src/paths/user.yml
272
+ I, [2020-05-01T01:31:24.191138 #38857] INFO -- : [Generate OAS schema files (paths)] end
273
+ I, [2020-05-01T01:31:24.192176 #38857] INFO -- : Add schema file into store: oas_docs/src/external_docs.yml
274
+ I, [2020-05-01T01:31:24.193420 #38857] INFO -- : Add schema file into store: oas_docs/src/servers.yml
275
+ I, [2020-05-01T01:31:24.193439 #38857] INFO -- : [Generate OAS schema files (components)] start
276
+ I, [2020-05-01T01:31:24.284912 #38857] INFO -- : <From routes data>
277
+ I, [2020-05-01T01:31:24.284948 #38857] INFO -- : <Update Components schema files (components/schemas)>
278
+ I, [2020-05-01T01:31:24.285956 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
279
+ I, [2020-05-01T01:31:24.287138 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/blob.yml
280
+ I, [2020-05-01T01:31:24.288612 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
281
+ I, [2020-05-01T01:31:24.289710 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
282
+ I, [2020-05-01T01:31:24.290637 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/representation.yml
283
+ I, [2020-05-01T01:31:24.291558 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
284
+ I, [2020-05-01T01:31:24.292834 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
285
+ I, [2020-05-01T01:31:24.409634 #38857] INFO -- : <From routes data>
286
+ I, [2020-05-01T01:31:24.409687 #38857] INFO -- : <Update Components schema files (components/requestBodies)>
287
+ I, [2020-05-01T01:31:24.412535 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
288
+ I, [2020-05-01T01:31:24.415665 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
289
+ I, [2020-05-01T01:31:24.418540 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
290
+ I, [2020-05-01T01:31:24.420598 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
291
+ I, [2020-05-01T01:31:24.423222 #38857] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
292
+ I, [2020-05-01T01:31:24.470555 #38857] INFO -- : <From routes data>
293
+ I, [2020-05-01T01:31:24.470597 #38857] INFO -- : <Update Components schema files (components/securitySchemes)>
294
+ I, [2020-05-01T01:31:24.522482 #38857] INFO -- : <From routes data>
295
+ I, [2020-05-01T01:31:24.522609 #38857] INFO -- : <Update Components schema files (components/parameters)>
296
+ I, [2020-05-01T01:31:24.569569 #38857] INFO -- : <From routes data>
297
+ I, [2020-05-01T01:31:24.569644 #38857] INFO -- : <Update Components schema files (components/responses)>
298
+ I, [2020-05-01T01:31:24.618008 #38857] INFO -- : <From routes data>
299
+ I, [2020-05-01T01:31:24.618045 #38857] INFO -- : <Update Components schema files (components/examples)>
300
+ I, [2020-05-01T01:31:24.663136 #38857] INFO -- : <From routes data>
301
+ I, [2020-05-01T01:31:24.663172 #38857] INFO -- : <Update Components schema files (components/headers)>
302
+ I, [2020-05-01T01:31:24.712207 #38857] INFO -- : <From routes data>
303
+ I, [2020-05-01T01:31:24.712244 #38857] INFO -- : <Update Components schema files (components/links)>
304
+ I, [2020-05-01T01:31:24.760286 #38857] INFO -- : <From routes data>
305
+ I, [2020-05-01T01:31:24.760322 #38857] INFO -- : <Update Components schema files (components/callbacks)>
306
+ I, [2020-05-01T01:31:24.760333 #38857] INFO -- : [Generate OAS schema files (components)] end
307
+ I, [2020-05-01T01:31:24.760948 #38857] INFO -- : [Generate OAS docs] Create cache at ./oas_docs/.docs
308
+ I, [2020-05-01T01:31:24.760966 #38857] INFO -- : [Generate OAS schema files] end
309
+ I, [2020-05-01T01:31:24.761044 #38857] INFO -- : [R2-OAS] end
310
+ ```
311
+
312
+ </details>
313
+
314
+ If you run the `bundle exec rake routes:oas:docs` command without the `.docs` file, an error will occur.
315
+
316
+ ```
317
+ rake aborted!
318
+ R2OAS::NoFileExistsError:
319
+ Can't find the file ./oas_docs/.docs
320
+ Please execute the following command to create ./oas_docs/.docs
321
+
322
+ CACHE_DOCS=true bundle exec rake routes:oas:docs
323
+ ```
324
+
325
+
326
+ <details>
327
+
328
+ ```
329
+ $ bundle exec rake routes:oas:docs
330
+ I, [2020-05-01T02:24:11.823975 #47636] INFO -- : [R2-OAS] start
331
+ I, [2020-05-01T02:24:12.337130 #47636] INFO -- : [Generate OAS schema files] start
332
+ I, [2020-05-01T02:24:12.337177 #47636] INFO -- : <From routes data>
333
+ I, [2020-05-01T02:24:12.337189 #47636] INFO -- : <Update schema files>
334
+ I, [2020-05-01T02:24:12.339013 #47636] INFO -- : Add schema file into store: oas_docs/src/openapi.yml
335
+ I, [2020-05-01T02:24:12.340182 #47636] INFO -- : Add schema file into store: oas_docs/src/info.yml
336
+ I, [2020-05-01T02:24:12.341872 #47636] INFO -- : Add schema file into store: oas_docs/src/tags.yml
337
+ I, [2020-05-01T02:24:12.341890 #47636] INFO -- : [Generate OAS schema files (paths)] start
338
+ I, [2020-05-01T02:24:12.391772 #47636] INFO -- : <From routes data>
339
+ I, [2020-05-01T02:24:12.391817 #47636] INFO -- : <Update schema files (paths)>
340
+ I, [2020-05-01T02:24:12.393787 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/api/v1/task.yml
341
+ I, [2020-05-01T02:24:12.400245 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/api/v2/post.yml
342
+ I, [2020-05-01T02:24:12.401931 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/blob.yml
343
+ I, [2020-05-01T02:24:12.403456 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/direct_upload.yml
344
+ I, [2020-05-01T02:24:12.405666 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/disk.yml
345
+ I, [2020-05-01T02:24:12.408723 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/active_storage/representation.yml
346
+ I, [2020-05-01T02:24:12.417412 #47636] INFO -- : Add schema file into store: oas_docs/src/paths/user.yml
347
+ I, [2020-05-01T02:24:12.417509 #47636] INFO -- : [Generate OAS schema files (paths)] end
348
+ I, [2020-05-01T02:24:12.420108 #47636] INFO -- : Add schema file into store: oas_docs/src/external_docs.yml
349
+ I, [2020-05-01T02:24:12.421518 #47636] INFO -- : Add schema file into store: oas_docs/src/servers.yml
350
+ I, [2020-05-01T02:24:12.421539 #47636] INFO -- : [Generate OAS schema files (components)] start
351
+ I, [2020-05-01T02:24:12.516931 #47636] INFO -- : <From routes data>
352
+ I, [2020-05-01T02:24:12.516967 #47636] INFO -- : <Update Components schema files (components/schemas)>
353
+ I, [2020-05-01T02:24:12.518440 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
354
+ I, [2020-05-01T02:24:12.519569 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/blob.yml
355
+ I, [2020-05-01T02:24:12.520535 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
356
+ I, [2020-05-01T02:24:12.521450 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
357
+ I, [2020-05-01T02:24:12.522427 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/representation.yml
358
+ I, [2020-05-01T02:24:12.523469 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
359
+ I, [2020-05-01T02:24:12.524670 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
360
+ I, [2020-05-01T02:24:12.576654 #47636] INFO -- : <From routes data>
361
+ I, [2020-05-01T02:24:12.576697 #47636] INFO -- : <Update Components schema files (components/requestBodies)>
362
+ I, [2020-05-01T02:24:12.580611 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/user.yml
363
+ I, [2020-05-01T02:24:12.582940 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/direct_upload.yml
364
+ I, [2020-05-01T02:24:12.585316 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/activestorage/disk.yml
365
+ I, [2020-05-01T02:24:12.587631 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v1/task.yml
366
+ I, [2020-05-01T02:24:12.589786 #47636] INFO -- : Add schema file into store: oas_docs/src/components/schemas/api/v2/post.yml
367
+ I, [2020-05-01T02:24:12.650356 #47636] INFO -- : <From routes data>
368
+ I, [2020-05-01T02:24:12.650394 #47636] INFO -- : <Update Components schema files (components/securitySchemes)>
369
+ I, [2020-05-01T02:24:12.710266 #47636] INFO -- : <From routes data>
370
+ I, [2020-05-01T02:24:12.710302 #47636] INFO -- : <Update Components schema files (components/parameters)>
371
+ I, [2020-05-01T02:24:12.760227 #47636] INFO -- : <From routes data>
372
+ I, [2020-05-01T02:24:12.760265 #47636] INFO -- : <Update Components schema files (components/responses)>
373
+ I, [2020-05-01T02:24:12.818019 #47636] INFO -- : <From routes data>
374
+ I, [2020-05-01T02:24:12.818056 #47636] INFO -- : <Update Components schema files (components/examples)>
375
+ I, [2020-05-01T02:24:12.867610 #47636] INFO -- : <From routes data>
376
+ I, [2020-05-01T02:24:12.867649 #47636] INFO -- : <Update Components schema files (components/headers)>
377
+ I, [2020-05-01T02:24:12.921801 #47636] INFO -- : <From routes data>
378
+ I, [2020-05-01T02:24:12.921836 #47636] INFO -- : <Update Components schema files (components/links)>
379
+ I, [2020-05-01T02:24:12.971004 #47636] INFO -- : <From routes data>
380
+ I, [2020-05-01T02:24:12.971040 #47636] INFO -- : <Update Components schema files (components/callbacks)>
381
+ I, [2020-05-01T02:24:12.971052 #47636] INFO -- : [Generate OAS schema files (components)] end
382
+ rake aborted!
383
+ R2OAS::NoFileExistsError:
384
+ Can't find the file ./oas_docs/.docs
385
+ Please execute the following command to create ./oas_docs/.docs
386
+
387
+ CACHE_DOCS=true bundle exec rake routes:oas:docs
388
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/v3/generator/doc_generator.rb:73:in `save_diff_schemas_from'
389
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/v3/generator/doc_generator.rb:28:in `save_schemas_from_store'
390
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/v3/generator/doc_generator.rb:20:in `generate_docs'
391
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/tasks/main.rake:17:in `block (4 levels) in <top (required)>'
392
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/task_logging.rb:25:in `start'
393
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/tasks/main.rake:13:in `block (3 levels) in <top (required)>'
394
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/task_logging.rb:11:in `block in task'
395
+ /Users/yukihirop/RubyProjects/r2-oas/example-523/vendor/bundle/ruby/2.3.0/gems/rake-12.3.3/exe/rake:27:in `<top (required)>'
396
+ /Users/yukihirop/.rbenv/versions/2.3.3/bin/bundle:22:in `load'
397
+ /Users/yukihirop/.rbenv/versions/2.3.3/bin/bundle:22:in `<main>'
398
+ Tasks: TOP => routes:oas:docs
399
+ (See full trace by running task with --trace)
400
+ ```
401
+
402
+ </details>
403
+
404
+ ## If you want to inspect .docs
405
+
406
+ You can check it by entering the following code with `pry` or something.
407
+
408
+ ```ruby
409
+ result = IO.binread("oas_docs/.docs")
410
+ inflate = Zlib::Inflate.inflate(result)
411
+ puts Marshal.load(inflate)
412
+ ```
data/docs/{HOW_TO_MONITOR_SWAGGER_DOC.md → usage/monitor_docs.md} RENAMED
@@ -1,17 +1,17 @@
1
- ## Basic Usage
1
+ # Monitor docs
2
2
 
3
- ```ruby
3
+ ## Prepare
4
4
 
5
- require 'r2-oas'
5
+ Add this line to your application's Gemfile:
6
6
 
7
- R2OAS.configure do |config|
8
- # default setting
9
- config.root_dir_path = "./oas_docs"
10
- config.schema_save_dir_name = "src"
11
- config.doc_save_file_name = "oas_doc.yml"
7
+ ```ruby
8
+ group :development do
9
+ gem 'r2-oas'
12
10
  end
13
11
  ```
14
12
 
13
+ ## Command
14
+
15
15
  ```bash
16
16
  $ bundle exec rake routes:oas:monitor
17
17
  ```
@@ -137,7 +137,7 @@ bulk_action POST /:model_name/bulk_action(.:format) rails_admin/main#
137
137
  show_in_app GET /:model_name/:id/show_in_app(.:format) rails_admin/main#show_in_app
138
138
  ```
139
139
 
140
- #### Usage
140
+ #### VS Code
141
141
 
142
142
  If you use [Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer)
143
143
 
@@ -145,35 +145,35 @@ If you use [Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=
145
145
 
146
146
  ```
147
147
  I, [2019-06-29T00:52:29.568306 #16277] INFO -- : [R2-OAS] start
148
- I, [2019-06-29T00:52:29.857556 #16277] INFO -- : [Generate Swagger schema files] start
149
- I, [2019-06-29T00:52:29.857599 #16277] INFO -- : [Generate Swagger schema files] end
150
- I, [2019-06-29T00:52:29.857609 #16277] INFO -- : [Generate Swagger docs from schema files] start
151
- I, [2019-06-29T00:52:29.858201 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
152
- I, [2019-06-29T00:52:29.859837 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
153
- I, [2019-06-29T00:52:29.861592 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/account_user_role.yml
154
- I, [2019-06-29T00:52:29.865069 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/user.yml
155
- I, [2019-06-29T00:52:29.866911 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/account.yml
156
- I, [2019-06-29T00:52:29.868569 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
157
- I, [2019-06-29T00:52:29.869994 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
158
- I, [2019-06-29T00:52:29.871558 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/custom_post.yml
159
- I, [2019-06-29T00:52:29.872561 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
160
- I, [2019-06-29T00:52:29.873925 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
161
- I, [2019-06-29T00:52:29.874329 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
162
- I, [2019-06-29T00:52:29.877551 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
163
- I, [2019-06-29T00:52:29.877670 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
164
- I, [2019-06-29T00:52:29.878309 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
165
- I, [2019-06-29T00:52:29.878477 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/account_user_role.yml
166
- I, [2019-06-29T00:52:29.878635 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/custom_post.yml
167
- I, [2019-06-29T00:52:29.878778 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user/new/200/get.yml
168
- I, [2019-06-29T00:52:29.878955 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user.yml
169
- I, [2019-06-29T00:52:29.879127 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/account.yml
170
- I, [2019-06-29T00:52:29.879270 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/task.yml
171
- I, [2019-06-29T00:52:29.879441 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/engine.yml
172
- I, [2019-06-29T00:52:29.879621 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/main.yml
173
- I, [2019-06-29T00:52:29.879767 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/post.yml
174
- I, [2019-06-29T00:52:29.879960 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
175
- I, [2019-06-29T00:52:29.880072 #16277] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
176
- I, [2019-06-29T00:52:29.926654 #16277] INFO -- : [Generate Swagger docs from schema files] end
148
+ I, [2019-06-29T00:52:29.857556 #16277] INFO -- : [Build OAS schema files] start
149
+ I, [2019-06-29T00:52:29.857599 #16277] INFO -- : [Build OAS schema files] end
150
+ I, [2019-06-29T00:52:29.857609 #16277] INFO -- : [Build OAS docs from schema files] start
151
+ I, [2019-06-29T00:52:29.858201 #16277] INFO -- : Use schema file: oas_docs/src/openapi.yml
152
+ I, [2019-06-29T00:52:29.859837 #16277] INFO -- : Use schema file: oas_docs/src/paths/user.yml
153
+ I, [2019-06-29T00:52:29.861592 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/account_user_role.yml
154
+ I, [2019-06-29T00:52:29.865069 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/user.yml
155
+ I, [2019-06-29T00:52:29.866911 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/account.yml
156
+ I, [2019-06-29T00:52:29.868569 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
157
+ I, [2019-06-29T00:52:29.869994 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v1/post.yml
158
+ I, [2019-06-29T00:52:29.871558 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v2/custom_post.yml
159
+ I, [2019-06-29T00:52:29.872561 #16277] INFO -- : Use schema file: oas_docs/src/paths/api/v2/post.yml
160
+ I, [2019-06-29T00:52:29.873925 #16277] INFO -- : Use schema file: oas_docs/src/paths/task.yml
161
+ I, [2019-06-29T00:52:29.874329 #16277] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/engine.yml
162
+ I, [2019-06-29T00:52:29.877551 #16277] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/main.yml
163
+ I, [2019-06-29T00:52:29.877670 #16277] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
164
+ I, [2019-06-29T00:52:29.878309 #16277] INFO -- : Use schema file: oas_docs/src/tags.yml
165
+ I, [2019-06-29T00:52:29.878477 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/account_user_role.yml
166
+ I, [2019-06-29T00:52:29.878635 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/custom_post.yml
167
+ I, [2019-06-29T00:52:29.878778 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/user/new/200/get.yml
168
+ I, [2019-06-29T00:52:29.878955 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/user.yml
169
+ I, [2019-06-29T00:52:29.879127 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/account.yml
170
+ I, [2019-06-29T00:52:29.879270 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/task.yml
171
+ I, [2019-06-29T00:52:29.879441 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/engine.yml
172
+ I, [2019-06-29T00:52:29.879621 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/main.yml
173
+ I, [2019-06-29T00:52:29.879767 #16277] INFO -- : Use schema file: oas_docs/src/components/schemas/post.yml
174
+ I, [2019-06-29T00:52:29.879960 #16277] INFO -- : Use schema file: oas_docs/src/info.yml
175
+ I, [2019-06-29T00:52:29.880072 #16277] INFO -- : Use schema file: oas_docs/src/servers.yml
176
+ I, [2019-06-29T00:52:29.926654 #16277] INFO -- : [Build OAS docs from schema files] end
177
177
 
178
178
  wait for single trap ...
179
179
  ```
@@ -182,38 +182,38 @@ When you press `Ctrl + C` after edit schema ,
182
182
 
183
183
  ```
184
184
  ^C
185
- ^CI, [2019-06-29T00:55:38.492337 #16277] INFO -- : [Analyze Swagger file] start
186
- I, [2019-06-29T00:55:38.494113 #16277] INFO -- : [Analyze Swagger file (paths)] start
187
- I, [2019-06-29T00:55:38.503677 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
188
- I, [2019-06-29T00:55:38.504894 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
189
- I, [2019-06-29T00:55:38.509686 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/account_user_role.yml
190
- I, [2019-06-29T00:55:38.522787 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/account.yml
191
- I, [2019-06-29T00:55:38.532995 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/user.yml
192
- I, [2019-06-29T00:55:38.537879 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
193
- I, [2019-06-29T00:55:38.542680 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
194
- I, [2019-06-29T00:55:38.548333 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/custom_post.yml
195
- I, [2019-06-29T00:55:38.552802 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
196
- I, [2019-06-29T00:55:38.560056 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
197
- I, [2019-06-29T00:55:38.566850 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
198
- I, [2019-06-29T00:55:38.566886 #16277] INFO -- : [Analyze Swagger file (paths)] end
199
- I, [2019-06-29T00:55:38.567852 #16277] INFO -- : [Analyze Swagger file (tags)] start
200
- I, [2019-06-29T00:55:38.569655 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
201
- I, [2019-06-29T00:55:38.569691 #16277] INFO -- : [Analyze Swagger file (tags)] end
202
- I, [2019-06-29T00:55:38.569708 #16277] INFO -- : [Analyze Swagger file (components)] start
203
- I, [2019-06-29T00:55:38.569724 #16277] INFO -- : [Analyze Swagger file (components/schemas)] start
204
- I, [2019-06-29T00:55:38.570894 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/account.yml
205
- I, [2019-06-29T00:55:38.571540 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/account_user_role.yml
206
- I, [2019-06-29T00:55:38.572217 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/custom_post.yml
207
- I, [2019-06-29T00:55:38.573028 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/engine.yml
208
- I, [2019-06-29T00:55:38.573710 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/main.yml
209
- I, [2019-06-29T00:55:38.574328 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/post.yml
210
- I, [2019-06-29T00:55:38.575088 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/task.yml
211
- I, [2019-06-29T00:55:38.575687 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user.yml
212
- I, [2019-06-29T00:55:38.576485 #16277] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user/new/200/get.yml
213
- I, [2019-06-29T00:55:38.576518 #16277] INFO -- : [Analyze Swagger file (components/schemas)] end
214
- I, [2019-06-29T00:55:38.576535 #16277] INFO -- : [Analyze Swagger file (components/requestBodies)] start
215
- I, [2019-06-29T00:55:38.576852 #16277] INFO -- : [Analyze Swagger file (components/requestBodies)] end
216
- I, [2019-06-29T00:55:38.576867 #16277] INFO -- : [Analyze Swagger file (components)] end
217
- I, [2019-06-29T00:55:38.580873 #16277] INFO -- : [Analyze Swagger file] end
185
+ ^CI, [2019-06-29T00:55:38.492337 #16277] INFO -- : [Analyze OAS file] start
186
+ I, [2019-06-29T00:55:38.494113 #16277] INFO -- : [Analyze OAS file (paths)] start
187
+ I, [2019-06-29T00:55:38.503677 #16277] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/main.yml
188
+ I, [2019-06-29T00:55:38.504894 #16277] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/engine.yml
189
+ I, [2019-06-29T00:55:38.509686 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/account_user_role.yml
190
+ I, [2019-06-29T00:55:38.522787 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/account.yml
191
+ I, [2019-06-29T00:55:38.532995 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/user.yml
192
+ I, [2019-06-29T00:55:38.537879 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/post.yml
193
+ I, [2019-06-29T00:55:38.542680 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v1/task.yml
194
+ I, [2019-06-29T00:55:38.548333 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v2/custom_post.yml
195
+ I, [2019-06-29T00:55:38.552802 #16277] INFO -- : Write schema file: oas_docs/src/paths/api/v2/post.yml
196
+ I, [2019-06-29T00:55:38.560056 #16277] INFO -- : Write schema file: oas_docs/src/paths/task.yml
197
+ I, [2019-06-29T00:55:38.566850 #16277] INFO -- : Write schema file: oas_docs/src/paths/user.yml
198
+ I, [2019-06-29T00:55:38.566886 #16277] INFO -- : [Analyze OAS file (paths)] end
199
+ I, [2019-06-29T00:55:38.567852 #16277] INFO -- : [Analyze OAS file (tags)] start
200
+ I, [2019-06-29T00:55:38.569655 #16277] INFO -- : Write schema file: oas_docs/src/tags.yml
201
+ I, [2019-06-29T00:55:38.569691 #16277] INFO -- : [Analyze OAS file (tags)] end
202
+ I, [2019-06-29T00:55:38.569708 #16277] INFO -- : [Analyze OAS file (components)] start
203
+ I, [2019-06-29T00:55:38.569724 #16277] INFO -- : [Analyze OAS file (components/schemas)] start
204
+ I, [2019-06-29T00:55:38.570894 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/account.yml
205
+ I, [2019-06-29T00:55:38.571540 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/account_user_role.yml
206
+ I, [2019-06-29T00:55:38.572217 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/custom_post.yml
207
+ I, [2019-06-29T00:55:38.573028 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/engine.yml
208
+ I, [2019-06-29T00:55:38.573710 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/main.yml
209
+ I, [2019-06-29T00:55:38.574328 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/post.yml
210
+ I, [2019-06-29T00:55:38.575088 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/task.yml
211
+ I, [2019-06-29T00:55:38.575687 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/user.yml
212
+ I, [2019-06-29T00:55:38.576485 #16277] INFO -- : Write schema file: oas_docs/src/components/schemas/user/new/200/get.yml
213
+ I, [2019-06-29T00:55:38.576518 #16277] INFO -- : [Analyze OAS file (components/schemas)] end
214
+ I, [2019-06-29T00:55:38.576535 #16277] INFO -- : [Analyze OAS file (components/requestBodies)] start
215
+ I, [2019-06-29T00:55:38.576852 #16277] INFO -- : [Analyze OAS file (components/requestBodies)] end
216
+ I, [2019-06-29T00:55:38.576867 #16277] INFO -- : [Analyze OAS file (components)] end
217
+ I, [2019-06-29T00:55:38.580873 #16277] INFO -- : [Analyze OAS file] end
218
218
  I, [2019-06-29T00:55:38.587586 #16277] INFO -- : [R2-OAS] end
219
219
  ```