Skip to content

Commit 36d3beb

Browse files
ioanatiaLeFnord
authored andcommitted
Update README.md (#673)
1 parent f72d5e0 commit 36d3beb

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,7 @@ add_swagger_documentation \
402402
* [Specify endpoint details](#details)
403403
* [Overriding the route summary](#summary)
404404
* [Overriding the tags](#tags)
405+
* [Deprecating routes](#deprecating-routes)
405406
* [Defining an endpoint as an array](#array)
406407
* [Using an options hash](#options)
407408
* [Overriding parameter type](#overriding-param-type)
@@ -523,6 +524,19 @@ end
523524
```
524525

525526

527+
#### Deprecating routes <a name="deprecating-routes" />
528+
529+
To deprecate a route add `deprecated: true` after the description.
530+
531+
```ruby
532+
namespace 'order' do
533+
desc 'This is a deprecated route', deprecated: true
534+
get :order_id do
535+
...
536+
end
537+
end
538+
```
539+
526540
#### Overriding the name of the body parameter
527541

528542
By default, body parameters have a generated name based on the operation. For

0 commit comments

Comments
 (0)