Skip to content

Commit b9db447

Browse files
committed
End default swagger response desc with period (grpc-ecosystem#1663)
1 parent eaf8b76 commit b9db447

File tree

13 files changed

+104
-104
lines changed

13 files changed

+104
-104
lines changed

examples/internal/clients/abe/api/swagger.yaml

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ paths:
6060
schema:
6161
$ref: "#/definitions/examplepbNumericEnum"
6262
default:
63-
description: "An unexpected error response"
63+
description: "An unexpected error response."
6464
schema:
6565
$ref: "#/definitions/rpcStatus"
6666
/v1/example/a_bit_of_everything/echo/{value}:
@@ -102,7 +102,7 @@ paths:
102102
schema: {}
103103
x-number: 100
104104
default:
105-
description: "An unexpected error response"
105+
description: "An unexpected error response."
106106
schema:
107107
$ref: "#/definitions/rpcStatus"
108108
externalDocs:
@@ -392,7 +392,7 @@ paths:
392392
schema:
393393
$ref: "#/definitions/examplepbNumericEnum"
394394
default:
395-
description: "An unexpected error response"
395+
description: "An unexpected error response."
396396
schema:
397397
$ref: "#/definitions/rpcStatus"
398398
/v1/example/a_bit_of_everything/params/get/{singleNested.name}:
@@ -686,7 +686,7 @@ paths:
686686
schema:
687687
$ref: "#/definitions/examplepbNumericEnum"
688688
default:
689-
description: "An unexpected error response"
689+
description: "An unexpected error response."
690690
schema:
691691
$ref: "#/definitions/rpcStatus"
692692
/v1/example/a_bit_of_everything/params/post/{stringValue}:
@@ -967,7 +967,7 @@ paths:
967967
schema:
968968
$ref: "#/definitions/examplepbNumericEnum"
969969
default:
970-
description: "An unexpected error response"
970+
description: "An unexpected error response."
971971
schema:
972972
$ref: "#/definitions/rpcStatus"
973973
/v1/example/a_bit_of_everything/query/{uuid}:
@@ -1267,7 +1267,7 @@ paths:
12671267
schema:
12681268
$ref: "#/definitions/examplepbNumericEnum"
12691269
default:
1270-
description: "An unexpected error response"
1270+
description: "An unexpected error response."
12711271
schema:
12721272
$ref: "#/definitions/rpcStatus"
12731273
security: []
@@ -1424,7 +1424,7 @@ paths:
14241424
schema:
14251425
$ref: "#/definitions/examplepbNumericEnum"
14261426
default:
1427-
description: "An unexpected error response"
1427+
description: "An unexpected error response."
14281428
schema:
14291429
$ref: "#/definitions/rpcStatus"
14301430
/v1/example/a_bit_of_everything/{uuid}:
@@ -1457,7 +1457,7 @@ paths:
14571457
schema:
14581458
$ref: "#/definitions/examplepbNumericEnum"
14591459
default:
1460-
description: "An unexpected error response"
1460+
description: "An unexpected error response."
14611461
schema:
14621462
$ref: "#/definitions/rpcStatus"
14631463
put:
@@ -1494,7 +1494,7 @@ paths:
14941494
schema:
14951495
$ref: "#/definitions/examplepbNumericEnum"
14961496
default:
1497-
description: "An unexpected error response"
1497+
description: "An unexpected error response."
14981498
schema:
14991499
$ref: "#/definitions/rpcStatus"
15001500
delete:
@@ -1525,7 +1525,7 @@ paths:
15251525
schema:
15261526
$ref: "#/definitions/examplepbNumericEnum"
15271527
default:
1528-
description: "An unexpected error response"
1528+
description: "An unexpected error response."
15291529
schema:
15301530
$ref: "#/definitions/rpcStatus"
15311531
security:
@@ -1721,7 +1721,7 @@ paths:
17211721
schema:
17221722
$ref: "#/definitions/examplepbNumericEnum"
17231723
default:
1724-
description: "An unexpected error response"
1724+
description: "An unexpected error response."
17251725
schema:
17261726
$ref: "#/definitions/rpcStatus"
17271727
/v1/example/deep_path/{singleNested.name}:
@@ -1761,7 +1761,7 @@ paths:
17611761
schema:
17621762
$ref: "#/definitions/examplepbNumericEnum"
17631763
default:
1764-
description: "An unexpected error response"
1764+
description: "An unexpected error response."
17651765
schema:
17661766
$ref: "#/definitions/rpcStatus"
17671767
/v1/{parent=publishers/*}/books:
@@ -1812,7 +1812,7 @@ paths:
18121812
schema:
18131813
$ref: "#/definitions/examplepbNumericEnum"
18141814
default:
1815-
description: "An unexpected error response"
1815+
description: "An unexpected error response."
18161816
schema:
18171817
$ref: "#/definitions/rpcStatus"
18181818
/v2/example/a_bit_of_everything/{abe.uuid}:
@@ -1859,7 +1859,7 @@ paths:
18591859
schema:
18601860
$ref: "#/definitions/examplepbNumericEnum"
18611861
default:
1862-
description: "An unexpected error response"
1862+
description: "An unexpected error response."
18631863
schema:
18641864
$ref: "#/definitions/rpcStatus"
18651865
patch:
@@ -1905,7 +1905,7 @@ paths:
19051905
schema:
19061906
$ref: "#/definitions/examplepbNumericEnum"
19071907
default:
1908-
description: "An unexpected error response"
1908+
description: "An unexpected error response."
19091909
schema:
19101910
$ref: "#/definitions/rpcStatus"
19111911
/v2/example/echo:
@@ -1948,7 +1948,7 @@ paths:
19481948
schema: {}
19491949
x-number: 100
19501950
default:
1951-
description: "An unexpected error response"
1951+
description: "An unexpected error response."
19521952
schema:
19531953
$ref: "#/definitions/rpcStatus"
19541954
externalDocs:
@@ -1993,7 +1993,7 @@ paths:
19931993
schema: {}
19941994
x-number: 100
19951995
default:
1996-
description: "An unexpected error response"
1996+
description: "An unexpected error response."
19971997
schema:
19981998
$ref: "#/definitions/rpcStatus"
19991999
externalDocs:
@@ -2023,7 +2023,7 @@ paths:
20232023
schema:
20242024
$ref: "#/definitions/examplepbNumericEnum"
20252025
default:
2026-
description: "An unexpected error response"
2026+
description: "An unexpected error response."
20272027
schema:
20282028
$ref: "#/definitions/rpcStatus"
20292029
/v2/example/errorwithdetails:
@@ -2050,7 +2050,7 @@ paths:
20502050
schema:
20512051
$ref: "#/definitions/examplepbNumericEnum"
20522052
default:
2053-
description: "An unexpected error response"
2053+
description: "An unexpected error response."
20542054
schema:
20552055
$ref: "#/definitions/rpcStatus"
20562056
/v2/example/overwriteresponsecontenttype:
@@ -2080,7 +2080,7 @@ paths:
20802080
schema:
20812081
$ref: "#/definitions/examplepbNumericEnum"
20822082
default:
2083-
description: "An unexpected error response"
2083+
description: "An unexpected error response."
20842084
schema:
20852085
$ref: "#/definitions/rpcStatus"
20862086
/v2/example/postwithemptybody/{name}:
@@ -2118,7 +2118,7 @@ paths:
21182118
schema:
21192119
$ref: "#/definitions/examplepbNumericEnum"
21202120
default:
2121-
description: "An unexpected error response"
2121+
description: "An unexpected error response."
21222122
schema:
21232123
$ref: "#/definitions/rpcStatus"
21242124
/v2/example/timeout:
@@ -2145,7 +2145,7 @@ paths:
21452145
schema:
21462146
$ref: "#/definitions/examplepbNumericEnum"
21472147
default:
2148-
description: "An unexpected error response"
2148+
description: "An unexpected error response."
21492149
schema:
21502150
$ref: "#/definitions/rpcStatus"
21512151
/v2/example/withbody/{id}:
@@ -2183,7 +2183,7 @@ paths:
21832183
schema:
21842184
$ref: "#/definitions/examplepbNumericEnum"
21852185
default:
2186-
description: "An unexpected error response"
2186+
description: "An unexpected error response."
21872187
schema:
21882188
$ref: "#/definitions/rpcStatus"
21892189
/v2a/example/a_bit_of_everything/{abe.uuid}:
@@ -2221,7 +2221,7 @@ paths:
22212221
schema:
22222222
$ref: "#/definitions/examplepbNumericEnum"
22232223
default:
2224-
description: "An unexpected error response"
2224+
description: "An unexpected error response."
22252225
schema:
22262226
$ref: "#/definitions/rpcStatus"
22272227
securityDefinitions:

examples/internal/clients/echo/api/swagger.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ paths:
2929
schema:
3030
$ref: "#/definitions/examplepbSimpleMessage"
3131
default:
32-
description: "An unexpected error response"
32+
description: "An unexpected error response."
3333
schema:
3434
$ref: "#/definitions/rpcStatus"
3535
/v1/example/echo/{id}/{num}:
@@ -104,7 +104,7 @@ paths:
104104
schema:
105105
$ref: "#/definitions/examplepbSimpleMessage"
106106
default:
107-
description: "An unexpected error response"
107+
description: "An unexpected error response."
108108
schema:
109109
$ref: "#/definitions/rpcStatus"
110110
/v1/example/echo/{id}/{num}/{lang}:
@@ -178,7 +178,7 @@ paths:
178178
schema:
179179
$ref: "#/definitions/examplepbSimpleMessage"
180180
default:
181-
description: "An unexpected error response"
181+
description: "An unexpected error response."
182182
schema:
183183
$ref: "#/definitions/rpcStatus"
184184
/v1/example/echo1/{id}/{lineNum}/{status.note}:
@@ -246,7 +246,7 @@ paths:
246246
schema:
247247
$ref: "#/definitions/examplepbSimpleMessage"
248248
default:
249-
description: "An unexpected error response"
249+
description: "An unexpected error response."
250250
schema:
251251
$ref: "#/definitions/rpcStatus"
252252
/v1/example/echo2/{no.note}:
@@ -316,7 +316,7 @@ paths:
316316
schema:
317317
$ref: "#/definitions/examplepbSimpleMessage"
318318
default:
319-
description: "An unexpected error response"
319+
description: "An unexpected error response."
320320
schema:
321321
$ref: "#/definitions/rpcStatus"
322322
/v1/example/echo_body:
@@ -338,7 +338,7 @@ paths:
338338
schema:
339339
$ref: "#/definitions/examplepbSimpleMessage"
340340
default:
341-
description: "An unexpected error response"
341+
description: "An unexpected error response."
342342
schema:
343343
$ref: "#/definitions/rpcStatus"
344344
/v1/example/echo_delete:
@@ -414,7 +414,7 @@ paths:
414414
schema:
415415
$ref: "#/definitions/examplepbSimpleMessage"
416416
default:
417-
description: "An unexpected error response"
417+
description: "An unexpected error response."
418418
schema:
419419
$ref: "#/definitions/rpcStatus"
420420
/v1/example/echo_patch:
@@ -444,7 +444,7 @@ paths:
444444
schema:
445445
$ref: "#/definitions/examplepbDynamicMessageUpdate"
446446
default:
447-
description: "An unexpected error response"
447+
description: "An unexpected error response."
448448
schema:
449449
$ref: "#/definitions/rpcStatus"
450450
definitions:

examples/internal/clients/responsebody/api/swagger.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ paths:
2727
items:
2828
$ref: "#/definitions/examplepbRepeatedResponseBodyOutResponse"
2929
default:
30-
description: "An unexpected error response"
30+
description: "An unexpected error response."
3131
schema:
3232
$ref: "#/definitions/rpcStatus"
3333
/responsebody/stream/{data}:
@@ -53,7 +53,7 @@ paths:
5353
$ref: "#/definitions/rpcStatus"
5454
title: "Stream result of examplepbResponseBodyOut"
5555
default:
56-
description: "An unexpected error response"
56+
description: "An unexpected error response."
5757
schema:
5858
$ref: "#/definitions/rpcStatus"
5959
/responsebody/{data}:
@@ -73,7 +73,7 @@ paths:
7373
schema:
7474
$ref: "#/definitions/examplepbResponseBodyOutResponse"
7575
default:
76-
description: "An unexpected error response"
76+
description: "An unexpected error response."
7777
schema:
7878
$ref: "#/definitions/rpcStatus"
7979
/responsestrings/{data}:
@@ -95,7 +95,7 @@ paths:
9595
items:
9696
type: "string"
9797
default:
98-
description: "An unexpected error response"
98+
description: "An unexpected error response."
9999
schema:
100100
$ref: "#/definitions/rpcStatus"
101101
definitions:

examples/internal/clients/unannotatedecho/api/swagger.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ paths:
3232
schema:
3333
$ref: "#/definitions/examplepbUnannotatedSimpleMessage"
3434
default:
35-
description: "An unexpected error response"
35+
description: "An unexpected error response."
3636
schema:
3737
$ref: "#/definitions/rpcStatus"
3838
/v1/example/echo/{id}/{num}:
@@ -113,7 +113,7 @@ paths:
113113
schema:
114114
$ref: "#/definitions/examplepbUnannotatedSimpleMessage"
115115
default:
116-
description: "An unexpected error response"
116+
description: "An unexpected error response."
117117
schema:
118118
$ref: "#/definitions/rpcStatus"
119119
/v1/example/echo_body:
@@ -135,7 +135,7 @@ paths:
135135
schema:
136136
$ref: "#/definitions/examplepbUnannotatedSimpleMessage"
137137
default:
138-
description: "An unexpected error response"
138+
description: "An unexpected error response."
139139
schema:
140140
$ref: "#/definitions/rpcStatus"
141141
/v1/example/echo_delete:
@@ -217,7 +217,7 @@ paths:
217217
schema:
218218
$ref: "#/definitions/examplepbUnannotatedSimpleMessage"
219219
default:
220-
description: "An unexpected error response"
220+
description: "An unexpected error response."
221221
schema:
222222
$ref: "#/definitions/rpcStatus"
223223
definitions:

0 commit comments

Comments
 (0)