Skip to content

Commit 522a909

Browse files
author
Chris Drane
committed
Annotate the Sample App section of the REAMDE
to indicated that it uses the :open_api format
1 parent eb9079c commit 522a909

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ For both raddocs and apitome, start rails server. Then
8383

8484
## Sample App
8585

86-
See the `example` folder for a sample Rails app that has been documented.
86+
See the `example` folder for a sample Rails app that has been documented. The sample app demonstrates the :open_api format.
8787

8888

8989
## Configuration options
@@ -323,7 +323,9 @@ paths:
323323
## Example of acceptance spec file
324324

325325
```ruby
326-
# spec/acceptance/orders_spec.rb
326+
# spec/acceptance/orders_spec.rb
327+
require 'rails_helper'
328+
require 'rspec_api_documentation/dsl'
327329
resource 'Orders' do
328330
explanation "Orders resource"
329331

0 commit comments

Comments
 (0)