Skip to content

Commit 6e96fd9

Browse files
committed
add some details to the readme
1 parent 2a49465 commit 6e96fd9

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,13 @@ Or by adding ```hidden: true``` on the verb method of the endpoint, such as `get
458458
get '/kittens', hidden: true do
459459
```
460460

461+
Or by using a route setting:
462+
463+
```ruby
464+
route_setting :hidden, true
465+
gem '/kittens' do
466+
```
467+
461468
Endpoints can be conditionally hidden by providing a callable object such as a lambda which evaluates to the desired
462469
state:
463470

@@ -933,6 +940,20 @@ this would generate:
933940
}
934941
```
935942

943+
- `operation` extension, by setting via route settings::
944+
```ruby
945+
route_setting :x_operation, { some: 'stuff' }
946+
```
947+
this would generate:
948+
```json
949+
"/path":{
950+
"get":{
951+
"…":"",
952+
"x-some":"stuff"
953+
}
954+
}
955+
```
956+
936957
- `path` extension, by setting via route settings:
937958
```ruby
938959
route_setting :x_path, { some: 'stuff' }

0 commit comments

Comments
 (0)