Skip to content

Commit 79f73b0

Browse files
committed
- updates test files for description
Signed-off-by: Vincent Biret <[email protected]>
1 parent 8012fb9 commit 79f73b0

12 files changed

+933
-177
lines changed

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.json

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,8 @@
130130
}
131131
},
132132
"x-ms-docs-operation-type": "operation"
133-
}
133+
},
134+
"x-description": "Provides operations to manage the collection of City entities."
134135
},
135136
"/City({Name})": {
136137
"get": {
@@ -258,7 +259,8 @@
258259
}
259260
},
260261
"x-ms-docs-operation-type": "operation"
261-
}
262+
},
263+
"x-description": "Provides operations to manage the collection of City entities."
262264
},
263265
"/City/$count": {
264266
"get": {
@@ -278,7 +280,8 @@
278280
"$ref": "#/responses/error"
279281
}
280282
}
281-
}
283+
},
284+
"x-description": "Provides operations to count the resources in the collection."
282285
},
283286
"/CountryOrRegion": {
284287
"get": {
@@ -400,7 +403,8 @@
400403
}
401404
},
402405
"x-ms-docs-operation-type": "operation"
403-
}
406+
},
407+
"x-description": "Provides operations to manage the collection of CountryOrRegion entities."
404408
},
405409
"/CountryOrRegion({Name})": {
406410
"get": {
@@ -528,7 +532,8 @@
528532
}
529533
},
530534
"x-ms-docs-operation-type": "operation"
531-
}
535+
},
536+
"x-description": "Provides operations to manage the collection of CountryOrRegion entities."
532537
},
533538
"/CountryOrRegion/$count": {
534539
"get": {
@@ -548,7 +553,8 @@
548553
"$ref": "#/responses/error"
549554
}
550555
}
551-
}
556+
},
557+
"x-description": "Provides operations to count the resources in the collection."
552558
},
553559
"/Me": {
554560
"get": {
@@ -631,7 +637,8 @@
631637
}
632638
},
633639
"x-ms-docs-operation-type": "operation"
634-
}
640+
},
641+
"x-description": "Provides operations to manage the Person singleton."
635642
},
636643
"/People": {
637644
"get": {
@@ -764,7 +771,8 @@
764771
}
765772
},
766773
"x-ms-docs-operation-type": "operation"
767-
}
774+
},
775+
"x-description": "Provides operations to manage the collection of Person entities."
768776
},
769777
"/People({UserName})": {
770778
"get": {
@@ -895,7 +903,8 @@
895903
}
896904
},
897905
"x-ms-docs-operation-type": "operation"
898-
}
906+
},
907+
"x-description": "Provides operations to manage the collection of Person entities."
899908
},
900909
"/People/$count": {
901910
"get": {
@@ -915,7 +924,8 @@
915924
"$ref": "#/responses/error"
916925
}
917926
}
918-
}
927+
},
928+
"x-description": "Provides operations to count the resources in the collection."
919929
}
920930
},
921931
"definitions": {

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.V2.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ paths:
8383
default:
8484
$ref: '#/responses/error'
8585
x-ms-docs-operation-type: operation
86+
x-description: Provides operations to manage the collection of City entities.
8687
'/City({Name})':
8788
get:
8889
tags:
@@ -170,6 +171,7 @@ paths:
170171
default:
171172
$ref: '#/responses/error'
172173
x-ms-docs-operation-type: operation
174+
x-description: Provides operations to manage the collection of City entities.
173175
/City/$count:
174176
get:
175177
summary: Get the number of the resource
@@ -183,6 +185,7 @@ paths:
183185
$ref: '#/definitions/ODataCountResponse'
184186
default:
185187
$ref: '#/responses/error'
188+
x-description: Provides operations to count the resources in the collection.
186189
/CountryOrRegion:
187190
get:
188191
tags:
@@ -259,6 +262,7 @@ paths:
259262
default:
260263
$ref: '#/responses/error'
261264
x-ms-docs-operation-type: operation
265+
x-description: Provides operations to manage the collection of CountryOrRegion entities.
262266
'/CountryOrRegion({Name})':
263267
get:
264268
tags:
@@ -346,6 +350,7 @@ paths:
346350
default:
347351
$ref: '#/responses/error'
348352
x-ms-docs-operation-type: operation
353+
x-description: Provides operations to manage the collection of CountryOrRegion entities.
349354
/CountryOrRegion/$count:
350355
get:
351356
summary: Get the number of the resource
@@ -359,6 +364,7 @@ paths:
359364
$ref: '#/definitions/ODataCountResponse'
360365
default:
361366
$ref: '#/responses/error'
367+
x-description: Provides operations to count the resources in the collection.
362368
/Me:
363369
get:
364370
tags:
@@ -415,6 +421,7 @@ paths:
415421
default:
416422
$ref: '#/responses/error'
417423
x-ms-docs-operation-type: operation
424+
x-description: Provides operations to manage the Person singleton.
418425
/People:
419426
get:
420427
tags:
@@ -502,6 +509,7 @@ paths:
502509
default:
503510
$ref: '#/responses/error'
504511
x-ms-docs-operation-type: operation
512+
x-description: Provides operations to manage the collection of Person entities.
505513
'/People({UserName})':
506514
get:
507515
tags:
@@ -592,6 +600,7 @@ paths:
592600
default:
593601
$ref: '#/responses/error'
594602
x-ms-docs-operation-type: operation
603+
x-description: Provides operations to manage the collection of Person entities.
595604
/People/$count:
596605
get:
597606
summary: Get the number of the resource
@@ -605,6 +614,7 @@ paths:
605614
$ref: '#/definitions/ODataCountResponse'
606615
default:
607616
$ref: '#/responses/error'
617+
x-description: Provides operations to count the resources in the collection.
608618
definitions:
609619
DefaultNs.Color:
610620
title: Color

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
],
1313
"paths": {
1414
"/City": {
15+
"description": "Provides operations to manage the collection of City entities.",
1516
"get": {
1617
"tags": [
1718
"City.City"
@@ -148,6 +149,7 @@
148149
}
149150
},
150151
"/City({Name})": {
152+
"description": "Provides operations to manage the collection of City entities.",
151153
"get": {
152154
"tags": [
153155
"City.City"
@@ -294,6 +296,7 @@
294296
}
295297
},
296298
"/City/$count": {
299+
"description": "Provides operations to count the resources in the collection.",
297300
"get": {
298301
"summary": "Get the number of the resource",
299302
"operationId": "Get.Count.City-8728",
@@ -315,6 +318,7 @@
315318
}
316319
},
317320
"/CountryOrRegion": {
321+
"description": "Provides operations to manage the collection of CountryOrRegion entities.",
318322
"get": {
319323
"tags": [
320324
"CountryOrRegion.CountryOrRegion"
@@ -451,6 +455,7 @@
451455
}
452456
},
453457
"/CountryOrRegion({Name})": {
458+
"description": "Provides operations to manage the collection of CountryOrRegion entities.",
454459
"get": {
455460
"tags": [
456461
"CountryOrRegion.CountryOrRegion"
@@ -597,6 +602,7 @@
597602
}
598603
},
599604
"/CountryOrRegion/$count": {
605+
"description": "Provides operations to count the resources in the collection.",
600606
"get": {
601607
"summary": "Get the number of the resource",
602608
"operationId": "Get.Count.CountryOrRegion-daf5",
@@ -618,6 +624,7 @@
618624
}
619625
},
620626
"/Me": {
627+
"description": "Provides operations to manage the Person singleton.",
621628
"get": {
622629
"tags": [
623630
"Me.Person"
@@ -709,6 +716,7 @@
709716
}
710717
},
711718
"/People": {
719+
"description": "Provides operations to manage the collection of Person entities.",
712720
"get": {
713721
"tags": [
714722
"People.Person"
@@ -856,6 +864,7 @@
856864
}
857865
},
858866
"/People({UserName})": {
867+
"description": "Provides operations to manage the collection of Person entities.",
859868
"get": {
860869
"tags": [
861870
"People.Person"
@@ -1005,6 +1014,7 @@
10051014
}
10061015
},
10071016
"/People/$count": {
1017+
"description": "Provides operations to count the resources in the collection.",
10081018
"get": {
10091019
"summary": "Get the number of the resource",
10101020
"operationId": "Get.Count.People-dd8d",

test/Microsoft.OpenAPI.OData.Reader.Tests/Resources/Basic.OpenApi.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ servers:
77
- url: http://localhost
88
paths:
99
/City:
10+
description: Provides operations to manage the collection of City entities.
1011
get:
1112
tags:
1213
- City.City
@@ -93,6 +94,7 @@ paths:
9394
$ref: '#/components/responses/error'
9495
x-ms-docs-operation-type: operation
9596
'/City({Name})':
97+
description: Provides operations to manage the collection of City entities.
9698
get:
9799
tags:
98100
- City.City
@@ -191,6 +193,7 @@ paths:
191193
$ref: '#/components/responses/error'
192194
x-ms-docs-operation-type: operation
193195
/City/$count:
196+
description: Provides operations to count the resources in the collection.
194197
get:
195198
summary: Get the number of the resource
196199
operationId: Get.Count.City-8728
@@ -204,6 +207,7 @@ paths:
204207
default:
205208
$ref: '#/components/responses/error'
206209
/CountryOrRegion:
210+
description: Provides operations to manage the collection of CountryOrRegion entities.
207211
get:
208212
tags:
209213
- CountryOrRegion.CountryOrRegion
@@ -290,6 +294,7 @@ paths:
290294
$ref: '#/components/responses/error'
291295
x-ms-docs-operation-type: operation
292296
'/CountryOrRegion({Name})':
297+
description: Provides operations to manage the collection of CountryOrRegion entities.
293298
get:
294299
tags:
295300
- CountryOrRegion.CountryOrRegion
@@ -388,6 +393,7 @@ paths:
388393
$ref: '#/components/responses/error'
389394
x-ms-docs-operation-type: operation
390395
/CountryOrRegion/$count:
396+
description: Provides operations to count the resources in the collection.
391397
get:
392398
summary: Get the number of the resource
393399
operationId: Get.Count.CountryOrRegion-daf5
@@ -401,6 +407,7 @@ paths:
401407
default:
402408
$ref: '#/components/responses/error'
403409
/Me:
410+
description: Provides operations to manage the Person singleton.
404411
get:
405412
tags:
406413
- Me.Person
@@ -463,6 +470,7 @@ paths:
463470
$ref: '#/components/responses/error'
464471
x-ms-docs-operation-type: operation
465472
/People:
473+
description: Provides operations to manage the collection of Person entities.
466474
get:
467475
tags:
468476
- People.Person
@@ -560,6 +568,7 @@ paths:
560568
$ref: '#/components/responses/error'
561569
x-ms-docs-operation-type: operation
562570
'/People({UserName})':
571+
description: Provides operations to manage the collection of Person entities.
563572
get:
564573
tags:
565574
- People.Person
@@ -661,6 +670,7 @@ paths:
661670
$ref: '#/components/responses/error'
662671
x-ms-docs-operation-type: operation
663672
/People/$count:
673+
description: Provides operations to count the resources in the collection.
664674
get:
665675
summary: Get the number of the resource
666676
operationId: Get.Count.People-dd8d

0 commit comments

Comments
 (0)