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.
- checksums.yaml +4 -4
- data/.gitignore +4 -0
- data/.rubocop.yml +6 -3
- data/.rubocop_todo.yml +68 -1
- data/.travis.yml +6 -2
- data/Appraisals +13 -0
- data/CHANGELOG.md +58 -1
- data/GEMSPEC.md +20 -0
- data/README.ja.md +65 -396
- data/README.md +62 -392
- data/devscript/all_support_ruby.sh +43 -0
- data/devscript/bundle_for_all_support_ruby.sh +31 -0
- data/devscript/rspec_for_all_support_ruby.sh +27 -0
- data/docs/.nojekyll +0 -0
- data/docs/README.md +173 -0
- data/docs/_sidebar.md +25 -0
- data/docs/attention/if_clash.md +17 -0
- data/docs/index.html +29 -0
- data/docs/{versions/v3.md → schema/3.0.0.md} +1 -1
- data/docs/setting/COC.md +14 -0
- data/docs/setting/CORS.md +22 -0
- data/docs/setting/configure.md +176 -0
- data/docs/trableshouting/runtime_error.md +44 -0
- data/docs/{HOW_TO_ANALYZE_DOCS.md → usage/analyze_docs.md} +52 -52
- data/docs/usage/clean_docs.md +19 -0
- data/docs/{HOW_TO_DEPLOY_SWAGGER_DOC.md → usage/deploy_docs.md} +29 -29
- data/docs/usage/display_paths_list.md +35 -0
- data/docs/{HOW_TO_DISPLAY_PATHS_STATS.md → usage/display_paths_stats.md} +15 -14
- data/docs/{HOW_TO_START_SWAGGER_EDITOR.md → usage/edit_docs.md} +88 -88
- data/docs/usage/generate_docs.md +412 -0
- data/docs/{HOW_TO_MONITOR_SWAGGER_DOC.md → usage/monitor_docs.md} +71 -71
- data/docs/usage/use_hook_methods.md +236 -0
- data/docs/{HOW_TO_USE_HOOK_WHEN_GENERATE_DOC.md → usage/use_hook_to_generate_docs.md} +48 -57
- data/docs/{HOW_TO_USE_SCHEMA_NAMESPACE.md → usage/use_schema_namespace.md} +46 -41
- data/docs/{HOW_TO_USE_TAG_NAMESPACE.md → usage/use_tag_namespace.md} +46 -42
- data/docs/{HOW_TO_START_SWAGGER_UI.md → usage/view_docs.md} +132 -132
- data/gemfiles/ruby_2.3.3.gemfile +11 -0
- data/gemfiles/ruby_2.4.2.gemfile +11 -0
- data/gemfiles/ruby_2.5.8.gemfile +11 -0
- data/gemfiles/ruby_2.6.6.gemfile +11 -0
- data/gemfiles/ruby_2.7.1.gemfile +11 -0
- data/lib/r2-oas.rb +3 -4
- data/lib/r2-oas/app_configuration.rb +19 -16
- data/lib/r2-oas/deploy/client.rb +14 -2
- data/lib/r2-oas/errors.rb +1 -0
- data/lib/r2-oas/lib/core_ext/hash/deep_merge.rb +44 -0
- data/lib/r2-oas/lib/core_ext/object/blank.rb +135 -0
- data/lib/r2-oas/lib/three-way-merge/twm.rb +83 -0
- data/lib/r2-oas/schema/builder.rb +23 -0
- data/lib/r2-oas/schema/editor.rb +26 -7
- data/lib/r2-oas/schema/generator.rb +1 -1
- data/lib/r2-oas/schema/manager/file_manager.rb +26 -0
- data/lib/r2-oas/schema/ui.rb +0 -1
- data/lib/r2-oas/schema/v3/analyzer/base_analyzer.rb +1 -6
- data/lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb +1 -1
- data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb +1 -1
- data/lib/r2-oas/schema/v3/analyzer/tag_analyzer.rb +1 -1
- data/lib/r2-oas/schema/v3/builder.rb +28 -0
- data/lib/r2-oas/schema/v3/builder/base_builder.rb +60 -0
- data/lib/r2-oas/schema/v3/builder/doc_builder.rb +43 -0
- data/lib/r2-oas/schema/v3/cleaner/base_cleaner.rb +1 -1
- data/lib/r2-oas/schema/v3/generator.rb +1 -5
- data/lib/r2-oas/schema/v3/generator/base_generator.rb +30 -1
- data/lib/r2-oas/schema/v3/generator/components/object_generator.rb +6 -25
- data/lib/r2-oas/schema/v3/generator/components/request_body_generator.rb +6 -6
- data/lib/r2-oas/schema/v3/generator/doc_generator.rb +84 -18
- data/lib/r2-oas/schema/v3/generator/path_generator.rb +7 -19
- data/lib/r2-oas/schema/v3/generator/schema_generator.rb +6 -26
- data/lib/r2-oas/schema/v3/manager/file/base_file_manager.rb +10 -4
- data/lib/r2-oas/schema/v3/manager/pathname_manager.rb +6 -1
- data/lib/r2-oas/schema/v3/object/path_item_object.rb +17 -9
- data/lib/r2-oas/store.rb +118 -0
- data/lib/r2-oas/task_logging.rb +6 -0
- data/lib/r2-oas/tasks/main.rake +66 -73
- data/lib/r2-oas/tasks/tool.rake +25 -28
- data/lib/r2-oas/tool/paths/ls.rb +1 -1
- data/lib/r2-oas/version.rb +1 -1
- data/r2-oas.gemspec +20 -25
- metadata +122 -52
- data/Gemfile.lock +0 -207
- data/docs/HOW_TO_CLEAN_DOCS.md +0 -19
- data/docs/HOW_TO_DISPLAY_PATHS_LIST.md +0 -28
- data/docs/HOW_TO_GENERATE_DOCS.md +0 -256
@@ -1,20 +1,27 @@
|
|
1
|
-
|
1
|
+
# Use Tag Namespace
|
2
|
+
|
3
|
+
## Prepare
|
4
|
+
|
5
|
+
Add this line to your application's Gemfile:
|
2
6
|
|
3
7
|
```ruby
|
8
|
+
group :development do
|
9
|
+
gem 'r2-oas'
|
10
|
+
end
|
11
|
+
```
|
4
12
|
|
13
|
+
Add the following settings to your rails project's `config/environments/development.rb`.
|
14
|
+
|
15
|
+
```ruby
|
5
16
|
require 'r2-oas'
|
6
17
|
|
7
18
|
R2OAS.configure do |config|
|
8
|
-
|
9
|
-
|
10
|
-
config.schema_save_dir_name = "src"
|
11
|
-
config.doc_save_file_name = "oas_doc.yml"
|
12
|
-
# default
|
13
|
-
config.use_tag_namespace = true # write here
|
14
|
-
config.use_schema_namespace = true
|
15
|
-
end
|
19
|
+
config.use_tag_namespace = true
|
20
|
+
end
|
16
21
|
```
|
17
22
|
|
23
|
+
## Command
|
24
|
+
|
18
25
|
```bash
|
19
26
|
$ bundle exec rake routes:oas:docs
|
20
27
|
```
|
@@ -118,25 +125,23 @@ oas_docs
|
|
118
125
|
│ │ └── user.yml
|
119
126
|
│ ├── servers.yml
|
120
127
|
│ └── tags.yml
|
121
|
-
└── oas_doc.yml
|
122
128
|
```
|
123
129
|
|
124
|
-
|
130
|
+
# Do not Use Tag Namespace
|
131
|
+
|
132
|
+
## Prepare
|
125
133
|
|
126
134
|
```ruby
|
127
135
|
|
128
136
|
require 'r2-oas'
|
129
137
|
|
130
138
|
R2OAS.configure do |config|
|
131
|
-
|
132
|
-
config.root_dir_path = "./oas_docs"
|
133
|
-
config.schema_save_dir_name = "src"
|
134
|
-
config.doc_save_file_name = "oas_doc.yml"
|
135
|
-
config.use_tag_namespace = false # write here
|
136
|
-
config.use_schema_namespace = true
|
139
|
+
config.use_tag_namespace = false
|
137
140
|
end
|
138
141
|
```
|
139
142
|
|
143
|
+
## Command
|
144
|
+
|
140
145
|
```bash
|
141
146
|
$ bundle exec rake routes:oas:docs
|
142
147
|
```
|
@@ -148,29 +153,28 @@ Generate like this:
|
|
148
153
|
```
|
149
154
|
oas_docs
|
150
155
|
├── schema
|
151
|
-
|
152
|
-
│
|
153
|
-
│
|
154
|
-
│
|
155
|
-
│
|
156
|
-
│
|
157
|
-
│
|
158
|
-
│
|
159
|
-
│
|
160
|
-
│
|
161
|
-
│
|
162
|
-
│
|
163
|
-
│
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
│
|
169
|
-
│
|
170
|
-
│
|
171
|
-
│
|
172
|
-
│
|
173
|
-
|
174
|
-
|
175
|
-
└── oas_doc.yml
|
156
|
+
├── components
|
157
|
+
│ └── schemas
|
158
|
+
│ ├── api
|
159
|
+
│ │ ├── v1
|
160
|
+
│ │ │ ├── post.yml
|
161
|
+
│ │ │ └── task.yml
|
162
|
+
│ │ └── v2
|
163
|
+
│ │ └── post.yml
|
164
|
+
│ ├── rails_admin
|
165
|
+
│ │ ├── engine.yml
|
166
|
+
│ │ └── main.yml
|
167
|
+
│ ├── task.yml
|
168
|
+
│ └── user.yml
|
169
|
+
├── externalDocs.yml
|
170
|
+
├── info.yml
|
171
|
+
├── openapi.yml
|
172
|
+
├── paths
|
173
|
+
│ ├── engine.yml
|
174
|
+
│ ├── main.yml
|
175
|
+
│ ├── post.yml
|
176
|
+
│ ├── task.yml
|
177
|
+
│ └── user.yml
|
178
|
+
├── servers.yml
|
179
|
+
└── tags.yml
|
176
180
|
```
|
@@ -1,17 +1,17 @@
|
|
1
|
-
|
1
|
+
# View docs
|
2
2
|
|
3
|
-
|
3
|
+
## Prepare
|
4
4
|
|
5
|
-
|
5
|
+
Add this line to your application's Gemfile:
|
6
6
|
|
7
|
-
|
8
|
-
|
9
|
-
|
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:ui
|
17
17
|
```
|
@@ -87,91 +87,91 @@ The ui starts up with the schema set.
|
|
87
87
|
```
|
88
88
|
I, [2019-04-29T12:53:03.010443 #10516] INFO -- : [R2-OAS] start
|
89
89
|
I, [2019-04-29T12:53:03.010557 #10516] INFO -- : [R2-OAS] start
|
90
|
-
I, [2019-04-29T12:53:03.133380 #10516] INFO -- : [
|
90
|
+
I, [2019-04-29T12:53:03.133380 #10516] INFO -- : [Build OAS schema files] start
|
91
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:
|
93
|
-
I, [2019-04-29T12:53:03.136340 #10516] INFO -- : Fetch schema file:
|
94
|
-
I, [2019-04-29T12:53:03.137207 #10516] INFO -- : Fetch schema file:
|
95
|
-
I, [2019-04-29T12:53:03.137860 #10516] INFO -- : Fetch schema file:
|
96
|
-
I, [2019-04-29T12:53:03.138488 #10516] INFO -- : Fetch schema file:
|
97
|
-
I, [2019-04-29T12:53:03.139113 #10516] INFO -- : Fetch schema file:
|
98
|
-
I, [2019-04-29T12:53:03.139660 #10516] INFO -- : Fetch schema file:
|
99
|
-
I, [2019-04-29T12:53:03.141082 #10516] INFO -- : Fetch schema file:
|
100
|
-
I, [2019-04-29T12:53:03.141426 #10516] INFO -- : Fetch schema file:
|
101
|
-
I, [2019-04-29T12:53:03.142055 #10516] INFO -- : Fetch schema file:
|
102
|
-
I, [2019-04-29T12:53:03.142364 #10516] INFO -- : Fetch schema file:
|
103
|
-
I, [2019-04-29T12:53:03.142690 #10516] INFO -- : Fetch schema file:
|
104
|
-
I, [2019-04-29T12:53:03.143078 #10516] INFO -- : Fetch schema file:
|
105
|
-
I, [2019-04-29T12:53:03.143408 #10516] INFO -- : Fetch schema file:
|
106
|
-
I, [2019-04-29T12:53:03.143643 #10516] INFO -- : Fetch schema file:
|
107
|
-
I, [2019-04-29T12:53:03.143971 #10516] INFO -- : Fetch schema file:
|
108
|
-
I, [2019-04-29T12:53:03.144315 #10516] INFO -- : Fetch schema file:
|
109
|
-
I, [2019-04-29T12:53:03.144806 #10516] INFO -- : Fetch schema file:
|
110
|
-
I, [2019-04-29T12:53:03.145013 #10516] INFO -- : Fetch schema file:
|
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
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:
|
113
|
-
I, [2019-04-29T12:53:03.146613 #10516] INFO -- : Merge schema file:
|
114
|
-
I, [2019-04-29T12:53:03.147470 #10516] INFO -- : Merge schema file:
|
115
|
-
I, [2019-04-29T12:53:03.147492 #10516] INFO -- : [
|
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
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:
|
118
|
-
I, [2019-04-29T12:53:03.185143 #10516] INFO -- : Fetch schema file:
|
119
|
-
I, [2019-04-29T12:53:03.185661 #10516] INFO -- : Fetch schema file:
|
120
|
-
I, [2019-04-29T12:53:03.186202 #10516] INFO -- : Fetch schema file:
|
121
|
-
I, [2019-04-29T12:53:03.186675 #10516] INFO -- : Fetch schema file:
|
122
|
-
I, [2019-04-29T12:53:03.187142 #10516] INFO -- : Fetch schema file:
|
123
|
-
I, [2019-04-29T12:53:03.188050 #10516] INFO -- : Fetch schema file:
|
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
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:
|
126
|
-
I, [2019-04-29T12:53:03.190945 #10516] INFO -- : Merge schema file:
|
127
|
-
I, [2019-04-29T12:53:03.192400 #10516] INFO -- : Merge schema file:
|
128
|
-
I, [2019-04-29T12:53:03.193803 #10516] INFO -- : Merge schema file:
|
129
|
-
I, [2019-04-29T12:53:03.195408 #10516] INFO -- : Merge schema file:
|
130
|
-
I, [2019-04-29T12:53:03.196820 #10516] INFO -- : Merge schema file:
|
131
|
-
I, [2019-04-29T12:53:03.199474 #10516] INFO -- : Merge schema file:
|
132
|
-
I, [2019-04-29T12:53:03.199496 #10516] INFO -- : [
|
133
|
-
I, [2019-04-29T12:53:03.199768 #10516] INFO -- : Merge schema file:
|
134
|
-
I, [2019-04-29T12:53:03.200231 #10516] INFO -- : Merge schema file:
|
135
|
-
I, [2019-04-29T12:53:03.200257 #10516] INFO -- : [
|
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
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:
|
138
|
-
I, [2019-04-29T12:53:03.268969 #10516] INFO -- : Fetch Components schema file:
|
139
|
-
I, [2019-04-29T12:53:03.269135 #10516] INFO -- : Fetch Components schema file:
|
140
|
-
I, [2019-04-29T12:53:03.269280 #10516] INFO -- : Fetch Components schema file:
|
141
|
-
I, [2019-04-29T12:53:03.269427 #10516] INFO -- : Fetch Components schema file:
|
142
|
-
I, [2019-04-29T12:53:03.269642 #10516] INFO -- : Fetch Components schema file:
|
143
|
-
I, [2019-04-29T12:53:03.269793 #10516] INFO -- : Fetch Components schema file:
|
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
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:
|
146
|
-
I, [2019-04-29T12:53:03.271096 #10516] INFO -- : Merge schema file:
|
147
|
-
I, [2019-04-29T12:53:03.271632 #10516] INFO -- : Merge schema file:
|
148
|
-
I, [2019-04-29T12:53:03.272166 #10516] INFO -- : Merge schema file:
|
149
|
-
I, [2019-04-29T12:53:03.272620 #10516] INFO -- : Merge schema file:
|
150
|
-
I, [2019-04-29T12:53:03.273053 #10516] INFO -- : Merge schema file:
|
151
|
-
I, [2019-04-29T12:53:03.273541 #10516] INFO -- : Merge schema file:
|
152
|
-
I, [2019-04-29T12:53:03.273562 #10516] INFO -- : [
|
153
|
-
I, [2019-04-29T12:53:03.273574 #10516] INFO -- : [
|
154
|
-
I, [2019-04-29T12:53:03.273584 #10516] INFO -- : [
|
155
|
-
I, [2019-04-29T12:53:03.274133 #10516] INFO -- : Use schema file:
|
156
|
-
I, [2019-04-29T12:53:03.274566 #10516] INFO -- : Use schema file:
|
157
|
-
I, [2019-04-29T12:53:03.275000 #10516] INFO -- : Use schema file:
|
158
|
-
I, [2019-04-29T12:53:03.275443 #10516] INFO -- : Use schema file:
|
159
|
-
I, [2019-04-29T12:53:03.276159 #10516] INFO -- : Use schema file:
|
160
|
-
I, [2019-04-29T12:53:03.277020 #10516] INFO -- : Use schema file:
|
161
|
-
I, [2019-04-29T12:53:03.277364 #10516] INFO -- : Use schema file:
|
162
|
-
I, [2019-04-29T12:53:03.278296 #10516] INFO -- : Use schema file:
|
163
|
-
I, [2019-04-29T12:53:03.278432 #10516] INFO -- : Use schema file:
|
164
|
-
I, [2019-04-29T12:53:03.278747 #10516] INFO -- : Use schema file:
|
165
|
-
I, [2019-04-29T12:53:03.278897 #10516] INFO -- : Use schema file:
|
166
|
-
I, [2019-04-29T12:53:03.279043 #10516] INFO -- : Use schema file:
|
167
|
-
I, [2019-04-29T12:53:03.279210 #10516] INFO -- : Use schema file:
|
168
|
-
I, [2019-04-29T12:53:03.279356 #10516] INFO -- : Use schema file:
|
169
|
-
I, [2019-04-29T12:53:03.279566 #10516] INFO -- : Use schema file:
|
170
|
-
I, [2019-04-29T12:53:03.279759 #10516] INFO -- : Use schema file:
|
171
|
-
I, [2019-04-29T12:53:03.279935 #10516] INFO -- : Use schema file:
|
172
|
-
I, [2019-04-29T12:53:03.280107 #10516] INFO -- : Use schema file:
|
173
|
-
I, [2019-04-29T12:53:03.280223 #10516] INFO -- : Use schema file:
|
174
|
-
I, [2019-04-29T12:53:03.301656 #10516] INFO -- : [
|
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
175
|
I, [2019-04-29T12:53:03.301698 #10516] INFO -- : [R2-OAS] end
|
176
176
|
|
177
177
|
wait for single trap ...
|
@@ -185,10 +185,10 @@ When you press `Ctrl + C` , the ui closes and the following message appears.
|
|
185
185
|
I, [2019-04-29T12:54:14.333082 #10516] INFO -- : [R2-OAS] end
|
186
186
|
```
|
187
187
|
|
188
|
-
##
|
188
|
+
## Use PATHS_FILE environment
|
189
189
|
|
190
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:
|
191
|
+
you set `PATHS_FILE` environment like this:
|
192
192
|
|
193
193
|
```bash
|
194
194
|
$ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor
|
@@ -199,55 +199,55 @@ $ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:
|
|
199
199
|
```
|
200
200
|
I, [2019-04-29T12:55:15.434226 #10698] INFO -- : [R2-OAS] start
|
201
201
|
I, [2019-04-29T12:55:15.434334 #10698] INFO -- : [R2-OAS] start
|
202
|
-
I, [2019-04-29T12:55:15.550674 #10698] INFO -- : [
|
202
|
+
I, [2019-04-29T12:55:15.550674 #10698] INFO -- : [Build OAS schema files] start
|
203
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:
|
205
|
-
I, [2019-04-29T12:55:15.551870 #10698] INFO -- : Fetch schema file:
|
206
|
-
I, [2019-04-29T12:55:15.552005 #10698] INFO -- : Fetch schema file:
|
207
|
-
I, [2019-04-29T12:55:15.552257 #10698] INFO -- : Fetch schema file:
|
208
|
-
I, [2019-04-29T12:55:15.552608 #10698] INFO -- : Fetch schema file:
|
209
|
-
I, [2019-04-29T12:55:15.552847 #10698] INFO -- : Fetch schema file:
|
210
|
-
I, [2019-04-29T12:55:15.553001 #10698] INFO -- : Fetch schema file:
|
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
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:
|
213
|
-
I, [2019-04-29T12:55:15.554101 #10698] INFO -- : Merge schema file:
|
214
|
-
I, [2019-04-29T12:55:15.555634 #10698] INFO -- : Merge schema file:
|
215
|
-
I, [2019-04-29T12:55:15.555714 #10698] INFO -- : [
|
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
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:
|
217
|
+
I, [2019-04-29T12:55:15.590112 #10698] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
|
218
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:
|
220
|
-
I, [2019-04-29T12:55:15.593567 #10698] INFO -- : Merge schema file:
|
221
|
-
I, [2019-04-29T12:55:15.595107 #10698] INFO -- : Merge schema file:
|
222
|
-
I, [2019-04-29T12:55:15.596491 #10698] INFO -- : Merge schema file:
|
223
|
-
I, [2019-04-29T12:55:15.598158 #10698] INFO -- : Merge schema file:
|
224
|
-
I, [2019-04-29T12:55:15.599531 #10698] INFO -- : Merge schema file:
|
225
|
-
I, [2019-04-29T12:55:15.602490 #10698] INFO -- : Merge schema file:
|
226
|
-
I, [2019-04-29T12:55:15.602516 #10698] INFO -- : [
|
227
|
-
I, [2019-04-29T12:55:15.602822 #10698] INFO -- : Merge schema file:
|
228
|
-
I, [2019-04-29T12:55:15.603159 #10698] INFO -- : Merge schema file:
|
229
|
-
I, [2019-04-29T12:55:15.603181 #10698] INFO -- : [
|
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
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:
|
231
|
+
I, [2019-04-29T12:55:15.670091 #10698] INFO -- : Fetch Components schema file: oas_docs/src/components/schemas/api/v1/task.yml
|
232
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:
|
234
|
-
I, [2019-04-29T12:55:15.671278 #10698] INFO -- : Merge schema file:
|
235
|
-
I, [2019-04-29T12:55:15.671796 #10698] INFO -- : Merge schema file:
|
236
|
-
I, [2019-04-29T12:55:15.672328 #10698] INFO -- : Merge schema file:
|
237
|
-
I, [2019-04-29T12:55:15.672745 #10698] INFO -- : Merge schema file:
|
238
|
-
I, [2019-04-29T12:55:15.673160 #10698] INFO -- : Merge schema file:
|
239
|
-
I, [2019-04-29T12:55:15.673729 #10698] INFO -- : Merge schema file:
|
240
|
-
I, [2019-04-29T12:55:15.673771 #10698] INFO -- : [
|
241
|
-
I, [2019-04-29T12:55:15.673785 #10698] INFO -- : [
|
242
|
-
I, [2019-04-29T12:55:15.673830 #10698] INFO -- : [
|
243
|
-
I, [2019-04-29T12:55:15.674608 #10698] INFO -- : Use schema file:
|
244
|
-
I, [2019-04-29T12:55:15.674796 #10698] INFO -- : Use schema file:
|
245
|
-
I, [2019-04-29T12:55:15.675010 #10698] INFO -- : Use schema file:
|
246
|
-
I, [2019-04-29T12:55:15.675144 #10698] INFO -- : Use schema file:
|
247
|
-
I, [2019-04-29T12:55:15.675523 #10698] INFO -- : Use schema file:
|
248
|
-
I, [2019-04-29T12:55:15.675700 #10698] INFO -- : Use schema file:
|
249
|
-
I, [2019-04-29T12:55:15.675817 #10698] INFO -- : Use schema file:
|
250
|
-
I, [2019-04-29T12:55:15.679925 #10698] INFO -- : [
|
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
251
|
I, [2019-04-29T12:55:15.679950 #10698] INFO -- : [R2-OAS] end
|
252
252
|
|
253
253
|
wait for single trap ...
|