File tree 1 file changed +14
-0
lines changed
1 file changed +14
-0
lines changed Original file line number Diff line number Diff line change @@ -402,6 +402,7 @@ add_swagger_documentation \
402
402
* [ Specify endpoint details] ( #details )
403
403
* [ Overriding the route summary] ( #summary )
404
404
* [ Overriding the tags] ( #tags )
405
+ * [ Deprecating routes] ( #deprecating-routes )
405
406
* [ Defining an endpoint as an array] ( #array )
406
407
* [ Using an options hash] ( #options )
407
408
* [ Overriding parameter type] ( #overriding-param-type )
523
524
```
524
525
525
526
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
+
526
540
#### Overriding the name of the body parameter
527
541
528
542
By default, body parameters have a generated name based on the operation. For
You can’t perform that action at this time.
0 commit comments