Skip to content

Commit fc9a18c

Browse files
remveeLeFnord
andauthored
Syntax errors in README.md examples (#843)
Co-authored-by: peter scholz <[email protected]>
1 parent 013d2da commit fc9a18c

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@ The example parameter will populate the Swagger UI with the example value, and c
817817
```ruby
818818
params do
819819
requires :id, type: Integer, documentation: { example: 123 }
820-
optional :name, type String, documentation: { example: 'Buddy Guy' }
820+
optional :name, type: String, documentation: { example: 'Buddy Guy' }
821821
end
822822
```
823823

@@ -843,7 +843,7 @@ namespace 'store/order', desc: 'Order operations within a store', swagger: { nes
843843
get :order_id do
844844
...
845845
end
846-
namespace 'actions', desc: 'Order actions' do, nested: false
846+
namespace 'actions', desc: 'Order actions', nested: false do
847847
get 'evaluate' do
848848
...
849849
end
@@ -1265,7 +1265,7 @@ end
12651265

12661266
The result will look like following:
12671267

1268-
```
1268+
```json
12691269
"responses": {
12701270
"200": {
12711271
"description": "Get a kitten",
@@ -1292,7 +1292,7 @@ end
12921292

12931293
The result will look like following:
12941294

1295-
```
1295+
```json
12961296
"responses": {
12971297
"200": {
12981298
"description": "Get kittens",
@@ -1319,7 +1319,7 @@ get '/things' do
13191319
end
13201320
```
13211321
The result will look like following:
1322-
```
1322+
```json
13231323
"responses": {
13241324
"200": {
13251325
"description": "Multiple response",
@@ -1351,7 +1351,7 @@ get '/things' do
13511351
end
13521352
```
13531353
The result will look like following:
1354-
```
1354+
```json
13551355
"responses": {
13561356
"200": {
13571357
"description": "Multiple response with array",
@@ -1525,7 +1525,7 @@ end
15251525
```
15261526

15271527
Should generate this definitions:
1528-
```JSON
1528+
```json
15291529
{
15301530
"definitions": {
15311531
"Pet": {

0 commit comments

Comments
 (0)