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/trableshouting/runtime_error.md ADDED
@@ -0,0 +1,44 @@
1
+ # Selenium::WebDriver::Error::SessionNotCreatedError
2
+
3
+ If you get the following error when running `oas:docs:editor`, the chromedriver may be old
4
+
5
+ ```bash
6
+ rake aborted!
7
+ Selenium::WebDriver::Error::SessionNotCreatedError: session not created: This version of ChromeDriver only supports Chrome version 81
8
+ (Driver info: chromedriver=81.0.4044.69 (6813546031a4bc83f717a2ef7cd4ac6ec1199132-refs/branch-heads/4044@{#776}),platform=Mac OS X 10.14.3 x86_64)
9
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/response.rb:72:in `assert_ok'
10
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/response.rb:34:in `initialize'
11
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/http/common.rb:88:in `new'
12
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/http/common.rb:88:in `create_response'
13
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/http/default.rb:114:in `request'
14
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/http/common.rb:64:in `call'
15
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/bridge.rb:167:in `execute'
16
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/bridge.rb:102:in `create_session'
17
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/remote/bridge.rb:56:in `handshake'
18
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/chrome/driver.rb:43:in `initialize'
19
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/common/driver.rb:46:in `new'
20
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver/common/driver.rb:46:in `for'
21
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/selenium-webdriver-3.142.4/lib/selenium/webdriver.rb:88:in `for'
22
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/watir-6.16.5/lib/watir/browser.rb:46:in `initialize'
23
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/editor.rb:110:in `new'
24
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/editor.rb:110:in `open_browser_and_set_schema'
25
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/editor.rb:37:in `block in start'
26
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/eventmachine-1.2.7/lib/eventmachine.rb:195:in `run_machine'
27
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/eventmachine-1.2.7/lib/eventmachine.rb:195:in `run'
28
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/schema/editor.rb:35:in `start'
29
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/tasks/main.rake:53:in `block (4 levels) in <top (required)>'
30
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/task_logging.rb:25:in `start'
31
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/tasks/main.rake:45:in `block (3 levels) in <top (required)>'
32
+ /Users/yukihirop/RubyProjects/r2-oas/lib/r2-oas/task_logging.rb:11:in `block in task'
33
+ /Users/yukihirop/RubyProjects/r2-oas/example-600/vendor/bundle/ruby/2.5.0/gems/rake-12.3.3/exe/rake:27:in `<top (required)>'
34
+ /Users/yukihirop/.rbenv/versions/2.5.3/bin/bundle:23:in `load'
35
+ /Users/yukihirop/.rbenv/versions/2.5.3/bin/bundle:23:in `<main>'
36
+ Tasks: TOP => routes:oas:editor
37
+ (See full trace by running task with --trace)
38
+ ```
39
+
40
+ The solution is as follows
41
+
42
+ ```bash
43
+ brew cask upgrade chromedriver
44
+ ```
data/docs/{HOW_TO_ANALYZE_DOCS.md → usage/analyze_docs.md} RENAMED
@@ -1,17 +1,17 @@
1
- ## Basic Usage
1
+ # Analyze 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
  $ OAS_FILE="~/Desktop/swagger_file.yml" bundle exec rake routes:oas:analyze
17
17
  ```
@@ -792,50 +792,50 @@ servers:
792
792
  ```
793
793
  $ 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
- I, [2019-05-05T15:00:40.756046 #18669] INFO -- : [Analyze Swagger file] start
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
804
- I, [2019-05-05T15:00:40.787615 #18669] INFO -- : [Analyze Swagger file (paths)] end
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
807
- I, [2019-05-05T15:00:40.788972 #18669] INFO -- : [Analyze Swagger file (tags)] end
808
- I, [2019-05-05T15:00:40.788985 #18669] INFO -- : [Analyze Swagger file (components)] start
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
815
- I, [2019-05-05T15:00:40.792515 #18669] INFO -- : [Analyze Swagger file (components/schemas)] end
816
- I, [2019-05-05T15:00:40.792526 #18669] INFO -- : [Analyze Swagger file (components)] end
817
- I, [2019-05-05T15:00:40.793238 #18669] INFO -- : [Analyze Swagger file] end
818
- I, [2019-05-05T15:00:40.848054 #18669] INFO -- : [Generate Swagger schema files] start
819
- I, [2019-05-05T15:00:40.848102 #18669] INFO -- : [Generate Swagger schema files] end
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
838
- I, [2019-05-05T15:00:40.872235 #18669] INFO -- : [Generate Swagger docs from schema files] end
795
+ I, [2019-05-05T15:00:40.756046 #18669] INFO -- : [Analyze OAS file] start
796
+ I, [2019-05-05T15:00:40.758453 #18669] INFO -- : [Analyze OAS file (paths)] start
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
+ I, [2019-05-05T15:00:40.787615 #18669] INFO -- : [Analyze OAS file (paths)] end
805
+ I, [2019-05-05T15:00:40.788014 #18669] INFO -- : [Analyze OAS file (tags)] start
806
+ I, [2019-05-05T15:00:40.788948 #18669] INFO -- : Write schema file: oas_docs/src/tags.yml
807
+ I, [2019-05-05T15:00:40.788972 #18669] INFO -- : [Analyze OAS file (tags)] end
808
+ I, [2019-05-05T15:00:40.788985 #18669] INFO -- : [Analyze OAS file (components)] start
809
+ I, [2019-05-05T15:00:40.788999 #18669] INFO -- : [Analyze OAS file (components/schemas)] start
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
+ I, [2019-05-05T15:00:40.792515 #18669] INFO -- : [Analyze OAS file (components/schemas)] end
816
+ I, [2019-05-05T15:00:40.792526 #18669] INFO -- : [Analyze OAS file (components)] end
817
+ I, [2019-05-05T15:00:40.793238 #18669] INFO -- : [Analyze OAS file] end
818
+ I, [2019-05-05T15:00:40.848054 #18669] INFO -- : [Build OAS schema files] start
819
+ I, [2019-05-05T15:00:40.848102 #18669] INFO -- : [Build OAS schema files] end
820
+ I, [2019-05-05T15:00:40.848115 #18669] INFO -- : [Build OAS docs from schema files] start
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
+ I, [2019-05-05T15:00:40.872235 #18669] INFO -- : [Build OAS docs from schema files] end
839
839
  I, [2019-05-05T15:00:40.872286 #18669] INFO -- : [R2-OAS] end
840
840
  ```
841
841
 
data/docs/usage/clean_docs.md ADDED
@@ -0,0 +1,19 @@
1
+ # Clean docs
2
+
3
+ Delete `components/schemas` and `components/requestBodies` files not in use.
4
+
5
+ ## Prepare
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ group :development do
11
+ gem 'r2-oas'
12
+ end
13
+ ```
14
+
15
+ ## Command
16
+
17
+ ```bash
18
+ $ bundle exec rake routes:oas:clean
19
+ ```
data/docs/{HOW_TO_DEPLOY_SWAGGER_DOC.md → usage/deploy_docs.md} RENAMED
@@ -1,17 +1,17 @@
1
- ## Basic Usage
1
+ # Deploy 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:deploy
17
17
  ```
@@ -791,27 +791,27 @@ servers:
791
791
  ```
792
792
  $ be rake routes:oas:deploy
793
793
  I, [2019-05-06T19:32:52.014417 #22431] INFO -- : [R2-OAS] start
794
- I, [2019-05-06T19:32:52.075691 #22431] INFO -- : [Generate Swagger schema files] start
795
- I, [2019-05-06T19:32:52.075731 #22431] INFO -- : [Generate Swagger schema files] end
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
814
- I, [2019-05-06T19:32:52.100673 #22431] INFO -- : [Generate Swagger docs from schema files] end
794
+ I, [2019-05-06T19:32:52.075691 #22431] INFO -- : [Build OAS schema files] start
795
+ I, [2019-05-06T19:32:52.075731 #22431] INFO -- : [Build OAS schema files] end
796
+ I, [2019-05-06T19:32:52.075743 #22431] INFO -- : [Build OAS docs from schema files] start
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
+ I, [2019-05-06T19:32:52.100673 #22431] INFO -- : [Build OAS docs from schema files] end
815
815
  I, [2019-05-06T19:32:52.133732 #22431] INFO -- : [R2-OAS] end
816
816
  ```
817
817
 
data/docs/usage/display_paths_list.md ADDED
@@ -0,0 +1,35 @@
1
+
2
+ # Display paths list
3
+
4
+ ## Prepare
5
+
6
+ Add this line to your application's Gemfile:
7
+
8
+ ```ruby
9
+ group :development do
10
+ gem 'r2-oas'
11
+ end
12
+ ```
13
+
14
+ ## Comamnd
15
+
16
+ ```
17
+ $ bundle exec rake routes:oas:paths_ls
18
+ ```
19
+
20
+ ## Example
21
+
22
+ ```bash
23
+ $ bundle exec rake routes:oas:paths_ls
24
+ oas_docs/src/paths/user.yml
25
+ oas_docs/src/paths/api/v1/account_user_role.yml
26
+ oas_docs/src/paths/api/v1/user.yml
27
+ oas_docs/src/paths/api/v1/account.yml
28
+ oas_docs/src/paths/api/v1/task.yml
29
+ oas_docs/src/paths/api/v1/post.yml
30
+ oas_docs/src/paths/api/v2/custom_post.yml
31
+ oas_docs/src/paths/api/v2/post.yml
32
+ oas_docs/src/paths/task.yml
33
+ oas_docs/src/paths/rails_admin/engine.yml
34
+ oas_docs/src/paths/rails_admin/main.yml
35
+ ```
data/docs/{HOW_TO_DISPLAY_PATHS_STATS.md → usage/display_paths_stats.md} RENAMED
@@ -1,24 +1,25 @@
1
- ## Basic Usage
2
1
 
3
- ```ruby
2
+ # Display paths stats
4
3
 
5
- require 'r2-oas'
4
+ ## Prepare
6
5
 
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"
6
+ Add this line to your application's Gemfile:
12
7
 
13
- config.tool.paths_stats.configure do |paths_stats|
14
- paths_stats.month_to_turn_to_warning_color = 3
15
- paths_stats.warning_color = :red
16
- paths_stats.table_title_color = :yellow
17
- paths_stats.heading_color = :yellow
18
- end
8
+ ```ruby
9
+ group :development do
10
+ gem 'r2-oas'
19
11
  end
20
12
  ```
21
13
 
14
+ ## Command
15
+
16
+ ```bash
17
+ $ bundle exec rake routes:oas:paths_stats
18
+ ```
19
+
20
+ ## Example
21
+
22
+
22
23
  ```bash
23
24
  $ bundle exec rake routes:oas:paths_stats
24
25
  +----+--------------------------------------------------------+---------------------------+---------------------------+
data/docs/{HOW_TO_START_SWAGGER_EDITOR.md → usage/edit_docs.md} RENAMED
@@ -1,17 +1,17 @@
1
- ## Basic Usage
1
+ # Edit 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:editor
17
17
  ```
@@ -87,59 +87,59 @@ The editor starts up with the schema set.
87
87
  ```
88
88
  I, [2019-04-07T19:24:44.832837 #33139] INFO -- : [R2-OAS] start
89
89
  I, [2019-04-07T19:24:44.832980 #33139] INFO -- : [R2-OAS] start
90
- I, [2019-04-07T19:24:44.941617 #33139] INFO -- : [Generate Swagger schema files] start
90
+ I, [2019-04-07T19:24:44.941617 #33139] INFO -- : [Build OAS schema files] start
91
91
  I, [2019-04-07T19:24:44.941859 #33139] INFO -- : <From schema files>
92
- I, [2019-04-07T19:24:44.943345 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
93
- I, [2019-04-07T19:24:44.944161 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
94
- I, [2019-04-07T19:24:44.944934 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
95
- I, [2019-04-07T19:24:44.945433 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
96
- I, [2019-04-07T19:24:44.946134 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
97
- I, [2019-04-07T19:24:44.946595 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
98
- I, [2019-04-07T19:24:44.947051 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
99
- I, [2019-04-07T19:24:44.947883 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
100
- I, [2019-04-07T19:24:44.948154 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
101
- I, [2019-04-07T19:24:44.948699 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
102
- I, [2019-04-07T19:24:44.949193 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
103
- I, [2019-04-07T19:24:44.949423 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
92
+ I, [2019-04-07T19:24:44.943345 #33139] INFO -- : Fetch schema file: oas_docs/src/openapi.yml
93
+ I, [2019-04-07T19:24:44.944161 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
94
+ I, [2019-04-07T19:24:44.944934 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
95
+ I, [2019-04-07T19:24:44.945433 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/post.yml
96
+ I, [2019-04-07T19:24:44.946134 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v2/post.yml
97
+ I, [2019-04-07T19:24:44.946595 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/task.yml
98
+ I, [2019-04-07T19:24:44.947051 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/engine.yml
99
+ I, [2019-04-07T19:24:44.947883 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/main.yml
100
+ I, [2019-04-07T19:24:44.948154 #33139] INFO -- : Fetch schema file: oas_docs/src/externalDocs.yml
101
+ I, [2019-04-07T19:24:44.948699 #33139] INFO -- : Fetch schema file: oas_docs/src/tags.yml
102
+ I, [2019-04-07T19:24:44.949193 #33139] INFO -- : Fetch schema file: oas_docs/src/info.yml
103
+ I, [2019-04-07T19:24:44.949423 #33139] INFO -- : Fetch schema file: oas_docs/src/servers.yml
104
104
  I, [2019-04-07T19:24:44.949694 #33139] INFO -- : <Update schema files>
105
- I, [2019-04-07T19:24:44.950397 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
106
- I, [2019-04-07T19:24:44.950846 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
107
- I, [2019-04-07T19:24:44.951710 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
108
- I, [2019-04-07T19:24:44.951779 #33139] INFO -- : [Generate Swagger schema files (paths)] start
105
+ I, [2019-04-07T19:24:44.950397 #33139] INFO -- : Merge schema file: oas_docs/src/openapi.yml
106
+ I, [2019-04-07T19:24:44.950846 #33139] INFO -- : Merge schema file: oas_docs/src/info.yml
107
+ I, [2019-04-07T19:24:44.951710 #33139] INFO -- : Merge schema file: oas_docs/src/tags.yml
108
+ I, [2019-04-07T19:24:44.951779 #33139] INFO -- : [Build OAS schema files (paths)] start
109
109
  I, [2019-04-07T19:24:44.980847 #33139] INFO -- : <From schema files>
110
- I, [2019-04-07T19:24:44.981390 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
111
- I, [2019-04-07T19:24:44.981742 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
112
- I, [2019-04-07T19:24:44.982088 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
113
- I, [2019-04-07T19:24:44.982510 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
114
- I, [2019-04-07T19:24:44.982843 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
115
- I, [2019-04-07T19:24:44.983202 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
116
- I, [2019-04-07T19:24:44.984177 #33139] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
110
+ I, [2019-04-07T19:24:44.981390 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/user.yml
111
+ I, [2019-04-07T19:24:44.981742 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
112
+ I, [2019-04-07T19:24:44.982088 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/post.yml
113
+ I, [2019-04-07T19:24:44.982510 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/api/v2/post.yml
114
+ I, [2019-04-07T19:24:44.982843 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/task.yml
115
+ I, [2019-04-07T19:24:44.983202 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/engine.yml
116
+ I, [2019-04-07T19:24:44.984177 #33139] INFO -- : Fetch schema file: oas_docs/src/paths/rails_admin/main.yml
117
117
  I, [2019-04-07T19:24:44.984565 #33139] INFO -- : <Update schema files (paths)>
118
- I, [2019-04-07T19:24:44.985294 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
119
- I, [2019-04-07T19:24:44.986665 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
120
- I, [2019-04-07T19:24:44.987585 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
121
- I, [2019-04-07T19:24:44.988493 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
122
- I, [2019-04-07T19:24:44.989595 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
123
- I, [2019-04-07T19:24:44.990660 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
124
- I, [2019-04-07T19:24:44.992520 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
125
- I, [2019-04-07T19:24:44.992553 #33139] INFO -- : [Generate Swagger schema files (paths)] end
126
- I, [2019-04-07T19:24:44.992863 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
127
- I, [2019-04-07T19:24:44.993229 #33139] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
128
- I, [2019-04-07T19:24:44.993272 #33139] INFO -- : [Generate Swagger schema files] end
129
- I, [2019-04-07T19:24:44.993311 #33139] INFO -- : [Generate Swagger docs from schema files] start
130
- I, [2019-04-07T19:24:44.993774 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
131
- I, [2019-04-07T19:24:44.994197 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
132
- I, [2019-04-07T19:24:44.994627 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
133
- I, [2019-04-07T19:24:44.994967 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
134
- I, [2019-04-07T19:24:44.995438 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
135
- I, [2019-04-07T19:24:44.995860 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
136
- I, [2019-04-07T19:24:44.996097 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
137
- I, [2019-04-07T19:24:44.996770 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
138
- I, [2019-04-07T19:24:44.996885 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
139
- I, [2019-04-07T19:24:44.997187 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
140
- I, [2019-04-07T19:24:44.997401 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
141
- I, [2019-04-07T19:24:44.997522 #33139] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
142
- I, [2019-04-07T19:24:45.003195 #33139] INFO -- : [Generate Swagger docs from schema files] end
118
+ I, [2019-04-07T19:24:44.985294 #33139] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/engine.yml
119
+ I, [2019-04-07T19:24:44.986665 #33139] INFO -- : Merge schema file: oas_docs/src/paths/api/v2/post.yml
120
+ I, [2019-04-07T19:24:44.987585 #33139] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/post.yml
121
+ I, [2019-04-07T19:24:44.988493 #33139] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/task.yml
122
+ I, [2019-04-07T19:24:44.989595 #33139] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
123
+ I, [2019-04-07T19:24:44.990660 #33139] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
124
+ I, [2019-04-07T19:24:44.992520 #33139] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
125
+ I, [2019-04-07T19:24:44.992553 #33139] INFO -- : [Build OAS schema files (paths)] end
126
+ I, [2019-04-07T19:24:44.992863 #33139] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
127
+ I, [2019-04-07T19:24:44.993229 #33139] INFO -- : Merge schema file: oas_docs/src/servers.yml
128
+ I, [2019-04-07T19:24:44.993272 #33139] INFO -- : [Build OAS schema files] end
129
+ I, [2019-04-07T19:24:44.993311 #33139] INFO -- : [Build OAS docs from schema files] start
130
+ I, [2019-04-07T19:24:44.993774 #33139] INFO -- : Use schema file: oas_docs/src/openapi.yml
131
+ I, [2019-04-07T19:24:44.994197 #33139] INFO -- : Use schema file: oas_docs/src/paths/user.yml
132
+ I, [2019-04-07T19:24:44.994627 #33139] INFO -- : Use schema file: oas_docs/src/paths/api/v1/task.yml
133
+ I, [2019-04-07T19:24:44.994967 #33139] INFO -- : Use schema file: oas_docs/src/paths/api/v1/post.yml
134
+ I, [2019-04-07T19:24:44.995438 #33139] INFO -- : Use schema file: oas_docs/src/paths/api/v2/post.yml
135
+ I, [2019-04-07T19:24:44.995860 #33139] INFO -- : Use schema file: oas_docs/src/paths/task.yml
136
+ I, [2019-04-07T19:24:44.996097 #33139] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/engine.yml
137
+ I, [2019-04-07T19:24:44.996770 #33139] INFO -- : Use schema file: oas_docs/src/paths/rails_admin/main.yml
138
+ I, [2019-04-07T19:24:44.996885 #33139] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
139
+ I, [2019-04-07T19:24:44.997187 #33139] INFO -- : Use schema file: oas_docs/src/tags.yml
140
+ I, [2019-04-07T19:24:44.997401 #33139] INFO -- : Use schema file: oas_docs/src/info.yml
141
+ I, [2019-04-07T19:24:44.997522 #33139] INFO -- : Use schema file: oas_docs/src/servers.yml
142
+ I, [2019-04-07T19:24:45.003195 #33139] INFO -- : [Build OAS docs from schema files] end
143
143
  I, [2019-04-07T19:24:45.003223 #33139] INFO -- : [R2-OAS] end
144
144
 
145
145
  wait for single trap ...
@@ -155,10 +155,10 @@ container id: 1a9752d2702045b2fde587dda3ce064233a735165f9b70bc6f86e603abfe3a39 r
155
155
  I, [2019-04-07T19:43:53.666565 #33493] INFO -- : [R2-OAS] end
156
156
  ```
157
157
 
158
- ## Advanced Usage
158
+ ## Use PATHS_FILE environment
159
159
 
160
160
  If you want to generate docs by squeezing unit paths (For example, `api/v1/task.yml`),
161
- you set PATHS_FILE environment like this:
161
+ you set `PATHS_FILE` environment like this:
162
162
 
163
163
  ```bash
164
164
  $ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:oas:editor
@@ -167,41 +167,41 @@ $ PATHS_FILE="../oas_docs/schema/paths/api/v1/task.yml" bundle exec rake routes:
167
167
  ```
168
168
  I, [2019-04-07T19:48:40.140872 #34907] INFO -- : [R2-OAS] start
169
169
  I, [2019-04-07T19:48:40.140990 #34907] INFO -- : [R2-OAS] start
170
- I, [2019-04-07T19:48:40.252636 #34907] INFO -- : [Generate Swagger schema files] start
170
+ I, [2019-04-07T19:48:40.252636 #34907] INFO -- : [Build OAS schema files] start
171
171
  I, [2019-04-07T19:48:40.252835 #34907] INFO -- : <From schema files>
172
172
  I, [2019-04-07T19:48:40.253463 #34907] INFO -- : Fetch schema file: ../oas_docs/schema/paths/api/v1/task.yml
173
- I, [2019-04-07T19:48:40.253587 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
174
- I, [2019-04-07T19:48:40.253707 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
175
- I, [2019-04-07T19:48:40.254045 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
176
- I, [2019-04-07T19:48:40.254276 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
177
- I, [2019-04-07T19:48:40.254430 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
173
+ I, [2019-04-07T19:48:40.253587 #34907] INFO -- : Fetch schema file: oas_docs/src/openapi.yml
174
+ I, [2019-04-07T19:48:40.253707 #34907] INFO -- : Fetch schema file: oas_docs/src/externalDocs.yml
175
+ I, [2019-04-07T19:48:40.254045 #34907] INFO -- : Fetch schema file: oas_docs/src/tags.yml
176
+ I, [2019-04-07T19:48:40.254276 #34907] INFO -- : Fetch schema file: oas_docs/src/info.yml
177
+ I, [2019-04-07T19:48:40.254430 #34907] INFO -- : Fetch schema file: oas_docs/src/servers.yml
178
178
  I, [2019-04-07T19:48:40.254522 #34907] INFO -- : <Update schema files>
179
- I, [2019-04-07T19:48:40.255059 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
180
- I, [2019-04-07T19:48:40.255565 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
181
- I, [2019-04-07T19:48:40.256410 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
182
- I, [2019-04-07T19:48:40.256433 #34907] INFO -- : [Generate Swagger schema files (paths)] start
179
+ I, [2019-04-07T19:48:40.255059 #34907] INFO -- : Merge schema file: oas_docs/src/openapi.yml
180
+ I, [2019-04-07T19:48:40.255565 #34907] INFO -- : Merge schema file: oas_docs/src/info.yml
181
+ I, [2019-04-07T19:48:40.256410 #34907] INFO -- : Merge schema file: oas_docs/src/tags.yml
182
+ I, [2019-04-07T19:48:40.256433 #34907] INFO -- : [Build OAS schema files (paths)] start
183
183
  I, [2019-04-07T19:48:40.287252 #34907] INFO -- : <From schema files>
184
- I, [2019-04-07T19:48:40.288195 #34907] INFO -- : Fetch schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
184
+ I, [2019-04-07T19:48:40.288195 #34907] INFO -- : Fetch schema file: oas_docs/src/paths/api/v1/task.yml
185
185
  I, [2019-04-07T19:48:40.288253 #34907] INFO -- : <Update schema files (paths)>
186
- I, [2019-04-07T19:48:40.289027 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/engine.yml
187
- I, [2019-04-07T19:48:40.290245 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v2/post.yml
188
- I, [2019-04-07T19:48:40.291226 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/post.yml
189
- I, [2019-04-07T19:48:40.292277 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/api/v1/task.yml
190
- I, [2019-04-07T19:48:40.293109 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/task.yml
191
- I, [2019-04-07T19:48:40.294190 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/user.yml
192
- I, [2019-04-07T19:48:40.296321 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/paths/rails_admin/main.yml
193
- I, [2019-04-07T19:48:40.296357 #34907] INFO -- : [Generate Swagger schema files (paths)] end
194
- I, [2019-04-07T19:48:40.296651 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
195
- I, [2019-04-07T19:48:40.297043 #34907] INFO -- : Merge schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
196
- I, [2019-04-07T19:48:40.297068 #34907] INFO -- : [Generate Swagger schema files] end
197
- I, [2019-04-07T19:48:40.297093 #34907] INFO -- : [Generate Swagger docs from schema files] start
186
+ I, [2019-04-07T19:48:40.289027 #34907] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/engine.yml
187
+ I, [2019-04-07T19:48:40.290245 #34907] INFO -- : Merge schema file: oas_docs/src/paths/api/v2/post.yml
188
+ I, [2019-04-07T19:48:40.291226 #34907] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/post.yml
189
+ I, [2019-04-07T19:48:40.292277 #34907] INFO -- : Merge schema file: oas_docs/src/paths/api/v1/task.yml
190
+ I, [2019-04-07T19:48:40.293109 #34907] INFO -- : Merge schema file: oas_docs/src/paths/task.yml
191
+ I, [2019-04-07T19:48:40.294190 #34907] INFO -- : Merge schema file: oas_docs/src/paths/user.yml
192
+ I, [2019-04-07T19:48:40.296321 #34907] INFO -- : Merge schema file: oas_docs/src/paths/rails_admin/main.yml
193
+ I, [2019-04-07T19:48:40.296357 #34907] INFO -- : [Build OAS schema files (paths)] end
194
+ I, [2019-04-07T19:48:40.296651 #34907] INFO -- : Merge schema file: oas_docs/src/externalDocs.yml
195
+ I, [2019-04-07T19:48:40.297043 #34907] INFO -- : Merge schema file: oas_docs/src/servers.yml
196
+ I, [2019-04-07T19:48:40.297068 #34907] INFO -- : [Build OAS schema files] end
197
+ I, [2019-04-07T19:48:40.297093 #34907] INFO -- : [Build OAS docs from schema files] start
198
198
  I, [2019-04-07T19:48:40.297631 #34907] INFO -- : Use schema file: ../oas_docs/schema/paths/api/v1/task.yml
199
- I, [2019-04-07T19:48:40.297797 #34907] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/openapi.yml
200
- I, [2019-04-07T19:48:40.297956 #34907] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/externalDocs.yml
201
- I, [2019-04-07T19:48:40.298421 #34907] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/tags.yml
202
- I, [2019-04-07T19:48:40.298720 #34907] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/info.yml
203
- I, [2019-04-07T19:48:40.298994 #34907] INFO -- : Use schema file: /Users/yukihirop/RubyProjects/r2-oas/oas_docs/src/servers.yml
204
- I, [2019-04-07T19:48:40.302896 #34907] INFO -- : [Generate Swagger docs from schema files] end
199
+ I, [2019-04-07T19:48:40.297797 #34907] INFO -- : Use schema file: oas_docs/src/openapi.yml
200
+ I, [2019-04-07T19:48:40.297956 #34907] INFO -- : Use schema file: oas_docs/src/externalDocs.yml
201
+ I, [2019-04-07T19:48:40.298421 #34907] INFO -- : Use schema file: oas_docs/src/tags.yml
202
+ I, [2019-04-07T19:48:40.298720 #34907] INFO -- : Use schema file: oas_docs/src/info.yml
203
+ I, [2019-04-07T19:48:40.298994 #34907] INFO -- : Use schema file: oas_docs/src/servers.yml
204
+ I, [2019-04-07T19:48:40.302896 #34907] INFO -- : [Build OAS docs from schema files] end
205
205
  I, [2019-04-07T19:48:40.302938 #34907] INFO -- : [R2-OAS] end
206
206
 
207
207
  wait for single trap ...