From 57da84d05504c00b21b94a38cb59b9fc63345f9c Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Fri, 4 Oct 2019 14:52:47 +0100 Subject: [PATCH 1/6] add options and trace --- rswag-specs/lib/rswag/specs/example_group_helpers.rb | 2 +- rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/rswag-specs/lib/rswag/specs/example_group_helpers.rb b/rswag-specs/lib/rswag/specs/example_group_helpers.rb index c293c63..4939abb 100644 --- a/rswag-specs/lib/rswag/specs/example_group_helpers.rb +++ b/rswag-specs/lib/rswag/specs/example_group_helpers.rb @@ -7,7 +7,7 @@ module Rswag describe(template, metadata, &block) end - [ :get, :post, :patch, :put, :delete, :head ].each do |verb| + [ :get, :post, :patch, :put, :delete, :head, :options, :trace ].each do |verb| define_method(verb) do |summary, &block| api_metadata = { operation: { verb: verb, summary: summary } } describe(verb, api_metadata, &block) diff --git a/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb b/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb index 619a8d7..c870bfc 100644 --- a/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb +++ b/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb @@ -24,7 +24,7 @@ module Rswag end end - describe '#get|post|patch|put|delete|head(verb, summary)' do + describe '#get|post|patch|put|delete|head|options|trace(verb, summary)' do before { subject.post('Creates a blog') } it "delegates to 'describe' with 'operation' metadata" do From 1d5ed8345f12a101795c2ad4aa05689531f89d5e Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Thu, 17 Oct 2019 13:37:36 +0100 Subject: [PATCH 2/6] add a PR template --- .github/pull_request_template.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..3eda872 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,12 @@ +## Problem + +## Solution + +### Related Issues + +### Checklist +- [ ] Added tests +- [ ] Changelog updated + +### Steps to Test or Reproduce +Outline the steps to test or reproduce the PR here. \ No newline at end of file From 29becf98f8a131295352f015ad915fe131b6f5bc Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Thu, 17 Oct 2019 14:16:46 +0100 Subject: [PATCH 3/6] add issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 14 ++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 11 +++++++++++ .../pull_request_template.md | 0 3 files changed, 25 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md rename .github/{ => PULL_REQUEST_TEMPLATE}/pull_request_template.md (100%) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..7a24179 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,14 @@ +## Describe the bug +A clear and concise description of what the bug is. + +## Steps to Test or Reproduce +Steps to reproduce the behavior: + +## Expected behavior +A clear and concise description of what you expected to happen. + +## Screenshots +If applicable, add screenshots to help explain your problem. + +## Additional context +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bde1cd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,11 @@ +## Is your feature request related to a problem? Please describe. +A clear and concise description of what the problem is. + +## Describe the solution you'd like +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md similarity index 100% rename from .github/pull_request_template.md rename to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md From 5b1dde772a38ff03fbc9861d4d8a3f730b69113a Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Thu, 17 Oct 2019 14:27:07 +0100 Subject: [PATCH 4/6] Update pr template --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 3eda872..4fc530f 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -1,8 +1,11 @@ ## Problem +A clear and concise description of what the problem is. ## Solution +A clear and concise description of the solution. ### Related Issues +Links to any related issues. ### Checklist - [ ] Added tests From a18d9e51633fca68d376dbb1280b11b648e373e3 Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Thu, 17 Oct 2019 14:36:25 +0100 Subject: [PATCH 5/6] update copy --- .github/PULL_REQUEST_TEMPLATE/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index 4fc530f..73c44a1 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -2,7 +2,7 @@ A clear and concise description of what the problem is. ## Solution -A clear and concise description of the solution. +A clear and concise description of what the solution is. ### Related Issues Links to any related issues. From 8d7385fcac86def49e0e989d9ae9f925bc660aeb Mon Sep 17 00:00:00 2001 From: Laura Watson Date: Thu, 17 Oct 2019 16:22:12 +0100 Subject: [PATCH 6/6] update copy --- .github/ISSUE_TEMPLATE/bug_report.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7a24179..57df306 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,7 +2,7 @@ A clear and concise description of what the bug is. ## Steps to Test or Reproduce -Steps to reproduce the behavior: +Please provide an example repo or the steps to reproduce the behavior. ## Expected behavior A clear and concise description of what you expected to happen. @@ -12,3 +12,6 @@ If applicable, add screenshots to help explain your problem. ## Additional context Add any other context about the problem here. + +## Rswag Version +The version of rswag are you using.