r2-oas 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop_todo.yml +4 -0
  3. data/CHANGELOG.md +13 -0
  4. data/Gemfile.lock +2 -2
  5. data/README.ja.md +10 -0
  6. data/README.md +10 -0
  7. data/docs/README.md +13 -166
  8. data/docs/_sidebar.md +2 -1
  9. data/docs/attention/if_clash.md +19 -0
  10. data/docs/usage/analyze_docs.md +30 -30
  11. data/docs/usage/deploy_docs.md +17 -17
  12. data/docs/usage/display_paths_list.md +11 -11
  13. data/docs/usage/edit_docs.md +66 -66
  14. data/docs/usage/generate_docs.md +90 -90
  15. data/docs/usage/monitor_docs.md +46 -46
  16. data/docs/usage/use_hook_to_generate_docs.md +34 -34
  17. data/docs/usage/view_docs.md +106 -106
  18. data/lib/r2-oas/schema/editor.rb +21 -6
  19. data/lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb +1 -1
  20. data/lib/r2-oas/schema/v3/analyzer/path_analyzer.rb +1 -1
  21. data/lib/r2-oas/schema/v3/analyzer/tag_analyzer.rb +1 -1
  22. data/lib/r2-oas/schema/v3/cleaner/base_cleaner.rb +1 -1
  23. data/lib/r2-oas/schema/v3/generator/components/object_generator.rb +1 -1
  24. data/lib/r2-oas/schema/v3/generator/components/request_body_generator.rb +1 -1
  25. data/lib/r2-oas/schema/v3/generator/doc_generator.rb +2 -1
  26. data/lib/r2-oas/schema/v3/generator/path_generator.rb +1 -1
  27. data/lib/r2-oas/schema/v3/generator/schema_generator.rb +1 -1
  28. data/lib/r2-oas/schema/v3/manager/file/base_file_manager.rb +9 -2
  29. data/lib/r2-oas/tool/paths/ls.rb +1 -1
  30. data/lib/r2-oas/version.rb +1 -1
  31. data/r2-oas.gemspec +2 -2
  32. metadata +7 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9eec703f732ad44e2cd37ad10c80bc2a2335a139d2d1e49fb16a8e5a2f74c768
4
- data.tar.gz: 18757357c5b9958d68e5cbba48e098788f5182d5942b532eb56554204c2df66a
3
+ metadata.gz: 3673e3e4a1376d86692711d0a88fd44596b4d2eb87ce310fc66a0e3592ac7a7f
4
+ data.tar.gz: 6d53bb9ad83f03fb64933598fe554217d897ba1ff4e47a5f61bab08cb318b039
5
5
  SHA512:
6
- metadata.gz: ed60f8a51749c1989332104c4282fb95e1c85cd842893335437d29666ac17217035dd8fcd7db6fbfd7406b3da5e24aa2fc1110e0dd86a6c59fb167163dd23b6b
7
- data.tar.gz: c2e023025e03f76944a3a9b8459acfd2a18d1c8ca89cbc4a3753d60bc5cc713afabd1a7087e2dddea6ca01fe8b28c644ff1dcf8f477d553332931b7861111a89
6
+ metadata.gz: 8bf25f08bd2df3572cd6153c913cc6ef994dc500e6b82eea4a8122ae8be4120ffd07034bb32e5bd7ac824fd6fd4a2d75cd322bfc6f947b60f3ae847e515a4a2a
7
+ data.tar.gz: b7507f2daf1f745e89be35b431ba4ba4aa1d0f8695fe8e26bee4004e3ea66945d786bf4cbbfd2a10a36890cc7350026097c4ea062b31ef38c0e3c5907856ea9f
data/.rubocop_todo.yml CHANGED
@@ -222,3 +222,7 @@ Style/ClassAndModuleChildren:
222
222
  Lint/RequireParentheses:
223
223
  Exclude:
224
224
  - "spec/r2-oas/schema/v3/object/components/schema_object_spec.rb"
225
+
226
+ Style/IfUnlessModifier:
227
+ Exclude:
228
+ - "lib/r2-oas/schema/editor.rb"
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # Change Log
2
2
 
3
+ ## v0.1.3
4
+
5
+ 2020-04-27
6
+
7
+ - [`FixBugs`] Fix clash when edit ([906d068](https://github.com/yukihirop/r2-oas/pull/109))
8
+ - [`Feature`] Change log display to relative path ([c735d22](https://github.com/yukihirop/r2-oas/pull/111))
9
+
10
+ ## v0.1.2
11
+
12
+ 2020-04-22
13
+
14
+ - No Change
15
+
3
16
  ## v0.1.1
4
17
 
5
18
  2020-04-22
data/Gemfile.lock CHANGED
@@ -1,14 +1,14 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- r2-oas (0.1.2)
4
+ r2-oas (0.1.3)
5
5
  docker-api (~> 1.34.2)
6
6
  easy_diff (~> 1.0.0)
7
7
  eventmachine (~> 1.2.0)
8
8
  paint
9
9
  rails (>= 4.2.5)
10
10
  terminal-table (~> 1.6.0)
11
- watir (~> 6.0)
11
+ watir (~> 6.16.5)
12
12
 
13
13
  GEM
14
14
  remote: https://rubygems.org/
data/README.ja.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # R2-OAS
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/r2-oas)
3
4
  [![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
4
5
  [![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
5
6
  [![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
@@ -52,6 +53,15 @@ bundle exec routes:oas:docs
52
53
  bundle exec routes:oas:editor
53
54
  ```
54
55
 
56
+ #### Generate docs
57
+
58
+ ![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
59
+
60
+
61
+ #### Edit docs
62
+
63
+ ![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
64
+
55
65
  ## 📚 Documents
56
66
 
57
67
  公式ドキュメントはこちら => https://yukihirop.github.io/r2-oas
data/README.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # R2-OAS
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/r2-oas)
3
4
  [![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
4
5
  [![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
5
6
  [![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
@@ -62,6 +63,15 @@ bundle exec routes:oas:docs
62
63
  bundle exec routes:oas:editor
63
64
  ```
64
65
 
66
+ #### Generate docs
67
+
68
+ ![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
69
+
70
+
71
+ #### Edit docs
72
+
73
+ ![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
74
+
65
75
  ## Usage
66
76
 
67
77
  You can execute the following command in the root directory of rails.
data/docs/README.md CHANGED
@@ -1,5 +1,6 @@
1
1
  # R2-OAS
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/r2-oas.svg)](https://badge.fury.io/rb/r2-oas)
3
4
  [![Build Status](https://travis-ci.org/yukihirop/r2-oas.svg?branch=master)](https://travis-ci.org/yukihirop/r2-oas)
4
5
  [![Coverage Status](https://coveralls.io/repos/github/yukihirop/r2-oas/badge.svg)](https://coveralls.io/github/yukihirop/r2-oas)
5
6
  [![Maintainability](https://api.codeclimate.com/v1/badges/f8c3846f350bb412fd63/maintainability)](https://codeclimate.com/github/yukihirop/r2-oas/maintainability)
@@ -62,105 +63,33 @@ bundle exec routes:oas:docs
62
63
  bundle exec routes:oas:editor
63
64
  ```
64
65
 
65
- ## 📖 Usage
66
+ #### Generate docs
66
67
 
67
- All settings are optional. The initial value is as follows.
68
+ ![oas_docs](https://user-images.githubusercontent.com/11146767/80364449-e678db80-88c0-11ea-8920-d757717ec610.gif)
68
69
 
69
- In your rails project, Write `config/environments/development.rb` like that:
70
70
 
71
- ```ruby
72
- # default setting
73
- R2OAS.configure do |config|
74
- config.version = :v3
75
- config.root_dir_path = "./oas_docs"
76
- config.schema_save_dir_name = "src"
77
- config.doc_save_file_name = "oas_doc.yml"
78
- config.force_update_schema = false
79
- config.use_tag_namespace = true
80
- config.use_schema_namespace = false
81
- config.interval_to_save_edited_tmp_schema = 15
82
- # :dot or :underbar
83
- config.namespace_type = :underbar
84
- config.deploy_dir_path = "./deploy_docs"
85
-
86
- config.server.data = [
87
- {
88
- url: "http://localhost:3000",
89
- description: "localhost"
90
- }
91
- ]
92
-
93
- config.swagger.configure do |swagger|
94
- swagger.ui.image = "swaggerapi/swagger-ui"
95
- swagger.ui.port = "8080"
96
- swagger.ui.exposed_port = "8080/tcp"
97
- swagger.ui.volume = "/app/swagger.json"
98
- swagger.editor.image = "swaggerapi/swagger-editor"
99
- swagger.editor.port = "81"
100
- swagger.editor.exposed_port = "8080/tcp"
101
- end
71
+ #### Edit docs
72
+
73
+ ![oas_editor](https://user-images.githubusercontent.com/11146767/80364657-4079a100-88c1-11ea-8f56-c9af78829d68.gif)
74
+
75
+ ## 📖 Usage
102
76
 
103
- config.use_object_classes = {
104
- info_object: R2OAS::Schema::V3::InfoObject,
105
- paths_object: R2OAS::Schema::V3::PathsObject,
106
- path_item_object: R2OAS::Schema::V3::PathItemObject,
107
- external_document_object: R2OAS::Schema::V3::ExternalDocumentObject,
108
- components_object: R2OAS::Schema::V3::ComponentsObject,
109
- components_schema_object: R2OAS::Schema::V3::Components::SchemaObject,
110
- components_request_body_object: R2OAS::Schema::V3::Components::RequestBodyObject
111
- }
112
-
113
- config.http_statuses_when_http_method = {
114
- get: {
115
- default: %w(200 422),
116
- path_parameter: %w(200 404 422)
117
- },
118
- post: {
119
- default: %w(201 422),
120
- path_parameter: %w(201 404 422)
121
- },
122
- patch: {
123
- default: %w(204 422),
124
- path_parameter: %w(204 404 422)
125
- },
126
- put: {
127
- default: %w(204 422),
128
- path_parameter: %w(204 404 422)
129
- },
130
- delete: {
131
- default: %w(200 422),
132
- path_parameter: %w(200 404 422)
133
- }
134
- }
135
-
136
- config.http_methods_when_generate_request_body = %w[post patch put]
137
- config.ignored_http_statuses_when_generate_component_schema = %w[204 404]
138
-
139
- config.tool.paths_stats.configure do |paths_stats|
140
- paths_stats.month_to_turn_to_warning_color = 3
141
- paths_stats.warning_color = :red
142
- paths_stats.table_title_color = :yellow
143
- paths_stats.heading_color = :yellow
144
- paths_stats.highlight_color = :magenta
145
- end
146
- end
147
- ```
148
77
 
149
78
  You can execute the following command in the root directory of rails.
150
79
 
151
80
  ```bash
152
81
  $ # Generate docs
153
- $ bundle exec rake routes:oas:docs # Generate docs
82
+ $ bundle exec rake routes:oas:docs # Generate docs
154
83
  $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:docs # Generate docs by specify unit paths
155
84
 
156
85
  $ # Start swagger editor
157
- $ bundle exec rake routes:oas:editor # Start swagger editor
86
+ $ bundle exec rake routes:oas:editor # Start swagger editor
158
87
  $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor # Start swagger editor by specify unit paths
159
88
  $ # Start swagger ui
160
- $ bundle exec rake routes:oas:ui # Start swagger ui
89
+ $ bundle exec rake routes:oas:ui # Start swagger ui
161
90
  $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:ui # Start swagger ui by specify unit paths
162
91
  $ # Monitor swagger document
163
- $ bundle exec rake routes:oas:monitor # Monitor swagger document
92
+ $ bundle exec rake routes:oas:monitor # Monitor swagger document
164
93
  $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:monitor # Monitor swagger by specify unit paths
165
94
 
166
95
  $ # Analyze docs
@@ -173,7 +102,7 @@ $ # Distribute swagger document
173
102
  $ bundle exec rake routes:oas:dist
174
103
  $ # Distribute swagger document
175
104
  $ PATHS_FILE="oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:dist # Distribute swagger document by specify unit paths
176
-
105
+
177
106
  # Display paths list
178
107
  $ bundle exec rake routes:oas:paths_ls
179
108
  # Display paths stats
@@ -208,88 +137,6 @@ $ bundle exec rake routes:oas:paths_stats
208
137
  - `.` is supposed to be used to express `namespace`.
209
138
  - format is `namespace1.namespace2.Model`.
210
139
 
211
- ## ⚙ Configure
212
-
213
- we explain the options that can be set.
214
-
215
- #### basic
216
-
217
- |option|description|default|
218
- |------|-----------|---|
219
- |version|OpenAPI schema version| `:v3` |
220
- |root_dir_path|Root directory for storing products.| `"./oas_docs"` |
221
- |schema_save_dir_name|Directory name for storing swagger schemas|`"src"`|
222
- |doc_save_file_name|File name for storing swagger doc|`"oas_doc.yml"`|
223
- |force_update_schema|Force update schema from routes data|`false`|
224
- |use_tag_namespace|Use namespace for tag name|`true`|
225
- |use_schema_namespace|Use namespace for schema name|`true`|
226
- |interval_to_save_edited_tmp_schema|Interval(sec) to save edited tmp schema|`15`|
227
- |http_statuses_when_http_method|Determine the response to support for each HTTP method|omission...|
228
- |http_methods_when_generate_request_body|HTTP methods when generate requestBody|`[post put patch]`|
229
- |ignored_http_statuses_when_generate_component_schema|Ignore HTTP statuses when generate component schema|`[204 404]`|
230
- |namespace_type|namespace for components(schemas/requestBodies) name| `underbar` |
231
- |deploy_dir_path|deploy directory.|`"./deploy_docs"`|
232
-
233
- #### server
234
-
235
- |option|children option|description|default|
236
- |------|---------------|-----------|-------|
237
- |server|data|Server data (url, description) |[{ url: `http://localhost:3000`, description: `localhost` }] |
238
-
239
- #### swagger
240
-
241
- |option|children option|grandchild option|description|default|
242
- |------|---------------|-----------------|-----------|-------|
243
- |swagger|ui|image|Swagger UI Docker Image|`"swaggerapi/swagger-ui"`|
244
- |swagger|ui|port|Swagger UI Port|`"8080"`|
245
- |swagger|ui|exposed_port|Swagger UI Exposed Port|`"8080/tcp"`|
246
- |swagger|ui|volume|Swagger UI Volume|`"/app/swagger.json"`|
247
- |swagger|editor|image|Swagger Editor Docker Image|`"swaggerapi/swagger-editor"`|
248
- |swagger|editor|port|Swagger Editor Port|`"8080"`|
249
- |swagger|editor|exposed_port|Swagger Editor Exposed Port|`"8080/tcp"`|
250
-
251
- #### hook
252
-
253
- |option|description|default|
254
- |------|-----------|-------|
255
- |use_object_classes|Object class(hook class) to generate Openapi document|{ info_object: `R2OAS::Schema::V3::InfoObject`,<br>paths_object: `R2OAS::Schema::V3::PathsObject`,<br>path_item_object: `R2OAS::Schema::V3::PathItemObject`, external_document_object: `R2OAS::Schema::V3::ExternalDocumentObject`,<br> components_object: `R2OAS::Schema::V3::ComponentsObject`,<br> components_schema_object: `R2OAS::Schema::V3::Components::SchemaObject`, <br> components_request_body_object:`R2OAS::Schema::V3::Components::RequestBodyObject` }|
256
-
257
- #### tool
258
-
259
- |option|children option|grandchild option|description|default|
260
- |------|---------------|-----------------|-----------|-------|
261
- |tool|paths_stats|month_to_turn_to_warning_color|Elapsed month to issue a warning|`3`|
262
- |tool|paths_stats|warning_color|Warning Color|`:red`|
263
- |tool|paths_stats|table_title_color|Table Title Color|`:yellow`|
264
- |tool|paths_stats|heading_color|Heading Color|`:yellow`|
265
- |tool|paths_stats|highlight_color|Highlight Color|`:magenta`|
266
-
267
- Please refer to [here](https://github.com/janlelis/paint) for the color.
268
-
269
- ## Environment variables
270
-
271
- We explain the environment variables that can be set.
272
-
273
- |variable|description|default|
274
- |--------|-----------|-------|
275
- |PATHS_FILE|Specify one paths file path|`""`|
276
- |OAS_FILE|Specify swagger file path to analyze|`""`|
277
-
278
-
279
- ## .paths
280
-
281
- Writing file paths in .paths will only read them.
282
- You can comment out with `#`
283
-
284
- `oas_docs/.paths`
285
-
286
- ```
287
- #account_user_role.yml # ignore
288
- account.yml
289
- account.yml # ignore
290
- account.yml # ignore
291
- ```
292
-
293
140
  ## 🔩 CORS
294
141
 
295
142
  Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.
data/docs/_sidebar.md CHANGED
@@ -1,5 +1,6 @@
1
1
  <!-- docs/_sidebar.md -->
2
-
2
+ * **Attention**
3
+ * [If Clash](/attention/if_clash)
3
4
  * **Usage**
4
5
  * [Generate Docs](/usage/generate_docs)
5
6
  * [Edit docs](/usage/edit_docs)
data/docs/attention/if_clash.md ADDED
@@ -0,0 +1,19 @@
1
+ # If clash
2
+
3
+ Unfortunately, if you do the paste operation with Swagger Editor running, it may occasionally crash.
4
+
5
+ f you crash while Swagger Editor is running, you can execute the following command to reflect the editing status up to a few seconds before in the local file.
6
+
7
+ ```bash
8
+ bundle exec rake routes:oas:analyze
9
+ ```
10
+
11
+ It is a file generated by parsing the generated file oas_doc.yml and dividing it into each file.
12
+
13
+ ## Attention
14
+
15
+ Please be aware that if you execute the following command immediately after the crash, the change history will be `lost`.
16
+
17
+ ```bash
18
+ bundle exec rake routes:oas:editor
19
+ ```
data/docs/usage/analyze_docs.md CHANGED
@@ -794,47 +794,47 @@ $ OAS_FILE=~/Desktop/swagger_file.yml be rake routes:oas:analyze
794
794
  I, [2019-05-05T15:00:40.716815 #18669] INFO -- : [R2-OAS] start
795
795
  I, [2019-05-05T15:00:40.756046 #18669] INFO -- : [Analyze Swagger file] start
796
796
  I, [2019-05-05T15:00:40.758453 #18669] INFO -- : [Analyze Swagger file (paths)] start
797
- I, [2019-05-05T15:00:40.763028 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
798
- I, [2019-05-05T15:00:40.775377 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
799
- I, [2019-05-05T15:00:40.776937 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
800
- I, [2019-05-05T15:00:40.778774 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
801
- I, [2019-05-05T15:00:40.780856 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
802
- I, [2019-05-05T15:00:40.782192 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
803
- I, [2019-05-05T15:00:40.787576 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
797
+ I, [2019-05-05T15:00:40.763028 #18669] INFO -- : Write schema file: oas_docs/src/paths/user.yml
798
+ I, [2019-05-05T15:00:40.775377 #18669] INFO -- : Write schema file: oas_docs/src/paths/api/v1/task.yml
799
+ I, [2019-05-05T15:00:40.776937 #18669] INFO -- : Write schema file: oas_docs/src/paths/api/v1/post.yml
800
+ I, [2019-05-05T15:00:40.778774 #18669] INFO -- : Write schema file: oas_docs/src/paths/api/v2/post.yml
801
+ I, [2019-05-05T15:00:40.780856 #18669] INFO -- : Write schema file: oas_docs/src/paths/task.yml
802
+ I, [2019-05-05T15:00:40.782192 #18669] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/engine.yml
803
+ I, [2019-05-05T15:00:40.787576 #18669] INFO -- : Write schema file: oas_docs/src/paths/rails_admin/main.yml
804
804
  I, [2019-05-05T15:00:40.787615 #18669] INFO -- : [Analyze Swagger file (paths)] end
805
805
  I, [2019-05-05T15:00:40.788014 #18669] INFO -- : [Analyze Swagger file (tags)] start
806
- I, [2019-05-05T15:00:40.788948 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
806
+ I, [2019-05-05T15:00:40.788948 #18669] INFO -- : Write schema file: oas_docs/src/tags.yml
807
807
  I, [2019-05-05T15:00:40.788972 #18669] INFO -- : [Analyze Swagger file (tags)] end
808
808
  I, [2019-05-05T15:00:40.788985 #18669] INFO -- : [Analyze Swagger file (components)] start
809
809
  I, [2019-05-05T15:00:40.788999 #18669] INFO -- : [Analyze Swagger file (components/schemas)] start
810
- I, [2019-05-05T15:00:40.790696 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user.yml
811
- I, [2019-05-05T15:00:40.791151 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/task.yml
812
- I, [2019-05-05T15:00:40.791635 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/engine.yml
813
- I, [2019-05-05T15:00:40.792107 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/main.yml
814
- I, [2019-05-05T15:00:40.792495 #18669] INFO -- : Write schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/post.yml
810
+ I, [2019-05-05T15:00:40.790696 #18669] INFO -- : Write schema file: oas_docs/src/components/schemas/user.yml
811
+ I, [2019-05-05T15:00:40.791151 #18669] INFO -- : Write schema file: oas_docs/src/components/schemas/task.yml
812
+ I, [2019-05-05T15:00:40.791635 #18669] INFO -- : Write schema file: oas_docs/src/components/schemas/engine.yml
813
+ I, [2019-05-05T15:00:40.792107 #18669] INFO -- : Write schema file: oas_docs/src/components/schemas/main.yml
814
+ I, [2019-05-05T15:00:40.792495 #18669] INFO -- : Write schema file: oas_docs/src/components/schemas/post.yml
815
815
  I, [2019-05-05T15:00:40.792515 #18669] INFO -- : [Analyze Swagger file (components/schemas)] end
816
816
  I, [2019-05-05T15:00:40.792526 #18669] INFO -- : [Analyze Swagger file (components)] end
817
817
  I, [2019-05-05T15:00:40.793238 #18669] INFO -- : [Analyze Swagger file] end
818
818
  I, [2019-05-05T15:00:40.848054 #18669] INFO -- : [Generate Swagger schema files] start
819
819
  I, [2019-05-05T15:00:40.848102 #18669] INFO -- : [Generate Swagger schema files] end
820
820
  I, [2019-05-05T15:00:40.848115 #18669] INFO -- : [Generate Swagger docs from schema files] start
821
- I, [2019-05-05T15:00:40.848612 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
822
- I, [2019-05-05T15:00:40.849247 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
823
- I, [2019-05-05T15:00:40.850005 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
824
- I, [2019-05-05T15:00:40.850882 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
825
- I, [2019-05-05T15:00:40.851566 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
826
- I, [2019-05-05T15:00:40.852122 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
827
- I, [2019-05-05T15:00:40.852441 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
828
- I, [2019-05-05T15:00:40.853853 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
829
- I, [2019-05-05T15:00:40.853983 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
830
- I, [2019-05-05T15:00:40.854312 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
831
- I, [2019-05-05T15:00:40.854465 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user.yml
832
- I, [2019-05-05T15:00:40.854613 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/task.yml
833
- I, [2019-05-05T15:00:40.854796 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/engine.yml
834
- I, [2019-05-05T15:00:40.854978 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/main.yml
835
- I, [2019-05-05T15:00:40.855185 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/post.yml
836
- I, [2019-05-05T15:00:40.855543 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
837
- I, [2019-05-05T15:00:40.855888 #18669] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
821
+ I, [2019-05-05T15:00:40.848612 #18669] INFO -- : Use schema file: oas_docs/src/openapi.yml
822
+ I, [2019-05-05T15:00:40.849247 #18669] INFO -- : Use schema file: oas_docs/src/paths/user.yml
823
+ I, [2019-05-05T15:00:40.850005 #18669] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
824
+ I, [2019-05-05T15:00:40.850882 #18669] INFO -- : Use schema file: oas_docs/src/paths/api/v1/post.yml
825
+ I, [2019-05-05T15:00:40.851566 #18669] INFO -- : Use schema file: oas_docs/src/paths/api/v2/post.yml
826
+ I, [2019-05-05T15:00:40.852122 #18669] INFO -- : Use schema file: oas_docs/src/paths/task.yml
827
+ I, [2019-05-05T15:00:40.852441 #18669] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/engine.yml
828
+ I, [2019-05-05T15:00:40.853853 #18669] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/main.yml
829
+ I, [2019-05-05T15:00:40.853983 #18669] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
830
+ I, [2019-05-05T15:00:40.854312 #18669] INFO -- : Use schema file: oas_docs/src/tags.yml
831
+ I, [2019-05-05T15:00:40.854465 #18669] INFO -- : Use schema file: oas_docs/src/components/schemas/user.yml
832
+ I, [2019-05-05T15:00:40.854613 #18669] INFO -- : Use schema file: oas_docs/src/components/schemas/task.yml
833
+ I, [2019-05-05T15:00:40.854796 #18669] INFO -- : Use schema file: oas_docs/src/components/schemas/engine.yml
834
+ I, [2019-05-05T15:00:40.854978 #18669] INFO -- : Use schema file: oas_docs/src/components/schemas/main.yml
835
+ I, [2019-05-05T15:00:40.855185 #18669] INFO -- : Use schema file: oas_docs/src/components/schemas/post.yml
836
+ I, [2019-05-05T15:00:40.855543 #18669] INFO -- : Use schema file: oas_docs/src/info.yml
837
+ I, [2019-05-05T15:00:40.855888 #18669] INFO -- : Use schema file: oas_docs/src/servers.yml
838
838
  I, [2019-05-05T15:00:40.872235 #18669] INFO -- : [Generate Swagger docs from schema files] end
839
839
  I, [2019-05-05T15:00:40.872286 #18669] INFO -- : [R2-OAS] end
840
840
  ```
data/docs/usage/deploy_docs.md CHANGED
@@ -794,23 +794,23 @@ I, [2019-05-06T19:32:52.014417 #22431] INFO -- : [R2-OAS] start
794
794
  I, [2019-05-06T19:32:52.075691 #22431] INFO -- : [Generate Swagger schema files] start
795
795
  I, [2019-05-06T19:32:52.075731 #22431] INFO -- : [Generate Swagger schema files] end
796
796
  I, [2019-05-06T19:32:52.075743 #22431] INFO -- : [Generate Swagger docs from schema files] start
797
- I, [2019-05-06T19:32:52.079267 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
798
- I, [2019-05-06T19:32:52.080334 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
799
- I, [2019-05-06T19:32:52.081189 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
800
- I, [2019-05-06T19:32:52.081944 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
801
- I, [2019-05-06T19:32:52.082838 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
802
- I, [2019-05-06T19:32:52.083719 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
803
- I, [2019-05-06T19:32:52.084185 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
804
- I, [2019-05-06T19:32:52.085796 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
805
- I, [2019-05-06T19:32:52.086063 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
806
- I, [2019-05-06T19:32:52.086555 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
807
- I, [2019-05-06T19:32:52.087145 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/user.yml
808
- I, [2019-05-06T19:32:52.087667 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/task.yml
809
- I, [2019-05-06T19:32:52.087955 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/engine.yml
810
- I, [2019-05-06T19:32:52.088281 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/main.yml
811
- I, [2019-05-06T19:32:52.088567 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/components/schemas/post.yml
812
- I, [2019-05-06T19:32:52.088867 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
813
- I, [2019-05-06T19:32:52.089136 #22431] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
797
+ I, [2019-05-06T19:32:52.079267 #22431] INFO -- : Use schema file: oas_docs/src/openapi.yml
798
+ I, [2019-05-06T19:32:52.080334 #22431] INFO -- : Use schema file: oas_docs/src/paths/user.yml
799
+ I, [2019-05-06T19:32:52.081189 #22431] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
800
+ I, [2019-05-06T19:32:52.081944 #22431] INFO -- : Use schema file: oas_docs/src/paths/api/v1/post.yml
801
+ I, [2019-05-06T19:32:52.082838 #22431] INFO -- : Use schema file: oas_docs/src/paths/api/v2/post.yml
802
+ I, [2019-05-06T19:32:52.083719 #22431] INFO -- : Use schema file: oas_docs/src/paths/task.yml
803
+ I, [2019-05-06T19:32:52.084185 #22431] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/engine.yml
804
+ I, [2019-05-06T19:32:52.085796 #22431] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/main.yml
805
+ I, [2019-05-06T19:32:52.086063 #22431] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
806
+ I, [2019-05-06T19:32:52.086555 #22431] INFO -- : Use schema file: oas_docs/src/tags.yml
807
+ I, [2019-05-06T19:32:52.087145 #22431] INFO -- : Use schema file: oas_docs/src/components/schemas/user.yml
808
+ I, [2019-05-06T19:32:52.087667 #22431] INFO -- : Use schema file: oas_docs/src/components/schemas/task.yml
809
+ I, [2019-05-06T19:32:52.087955 #22431] INFO -- : Use schema file: oas_docs/src/components/schemas/engine.yml
810
+ I, [2019-05-06T19:32:52.088281 #22431] INFO -- : Use schema file: oas_docs/src/components/schemas/main.yml
811
+ I, [2019-05-06T19:32:52.088567 #22431] INFO -- : Use schema file: oas_docs/src/components/schemas/post.yml
812
+ I, [2019-05-06T19:32:52.088867 #22431] INFO -- : Use schema file: oas_docs/src/info.yml
813
+ I, [2019-05-06T19:32:52.089136 #22431] INFO -- : Use schema file: oas_docs/src/servers.yml
814
814
  I, [2019-05-06T19:32:52.100673 #22431] INFO -- : [Generate Swagger docs from schema files] end
815
815
  I, [2019-05-06T19:32:52.133732 #22431] INFO -- : [R2-OAS] end
816
816
  ```