Skip to content

Commit ebc98ec

Browse files
authored
[PowerShell] improve return type documentation (#9295)
* revise return type doc * revise return type doc
1 parent ef2299a commit ebc98ec

File tree

4 files changed

+31
-31
lines changed

4 files changed

+31
-31
lines changed

modules/openapi-generator/src/main/resources/powershell/api_doc.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ Name | Type | Description | Notes
7878
{{/allParams}}
7979

8080
### Return type
81-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
82-
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
81+
82+
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}[**{{{returnType}}}**]({{returnBaseType}}.md) (PSCustomObject){{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
8383

8484
### Authorization
8585

samples/client/petstore/powershell/docs/PSPetApi.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ Name | Type | Description | Notes
4646
**Pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
4747

4848
### Return type
49-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
50-
[**Pet**](Pet.md)
49+
50+
[**Pet**](Pet.md) (PSCustomObject)
5151

5252
### Authorization
5353

@@ -95,7 +95,7 @@ Name | Type | Description | Notes
9595
**ApiKey** | **String**| | [optional]
9696

9797
### Return type
98-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
98+
9999
void (empty response body)
100100

101101
### Authorization
@@ -143,8 +143,8 @@ Name | Type | Description | Notes
143143
**Status** | [**String[]**](String.md)| Status values that need to be considered for filter |
144144

145145
### Return type
146-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
147-
[**Pet[]**](Pet.md)
146+
147+
[**Pet[]**](Pet.md) (PSCustomObject)
148148

149149
### Authorization
150150

@@ -191,8 +191,8 @@ Name | Type | Description | Notes
191191
**Tags** | [**String[]**](String.md)| Tags to filter by |
192192

193193
### Return type
194-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
195-
[**Pet[]**](Pet.md)
194+
195+
[**Pet[]**](Pet.md) (PSCustomObject)
196196

197197
### Authorization
198198

@@ -241,8 +241,8 @@ Name | Type | Description | Notes
241241
**PetId** | **Int64**| ID of pet to return |
242242

243243
### Return type
244-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
245-
[**Pet**](Pet.md)
244+
245+
[**Pet**](Pet.md) (PSCustomObject)
246246

247247
### Authorization
248248

@@ -287,8 +287,8 @@ Name | Type | Description | Notes
287287
**Pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
288288

289289
### Return type
290-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
291-
[**Pet**](Pet.md)
290+
291+
[**Pet**](Pet.md) (PSCustomObject)
292292

293293
### Authorization
294294

@@ -339,7 +339,7 @@ Name | Type | Description | Notes
339339
**Status** | **String**| Updated status of the pet | [optional]
340340

341341
### Return type
342-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
342+
343343
void (empty response body)
344344

345345
### Authorization
@@ -391,8 +391,8 @@ Name | Type | Description | Notes
391391
**File** | **System.IO.FileInfo****System.IO.FileInfo**| file to upload | [optional]
392392

393393
### Return type
394-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
395-
[**ApiResponse**](ApiResponse.md)
394+
395+
[**ApiResponse**](ApiResponse.md) (PSCustomObject)
396396

397397
### Authorization
398398

samples/client/petstore/powershell/docs/PSStoreApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Name | Type | Description | Notes
3939
**OrderId** | **String**| ID of the order that needs to be deleted |
4040

4141
### Return type
42-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
42+
4343
void (empty response body)
4444

4545
### Authorization
@@ -84,7 +84,7 @@ try {
8484
This endpoint does not need any parameter.
8585

8686
### Return type
87-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
87+
8888
**System.Collections.Hashtable**
8989

9090
### Authorization
@@ -127,8 +127,8 @@ Name | Type | Description | Notes
127127
**OrderId** | **Int64**| ID of pet that needs to be fetched |
128128

129129
### Return type
130-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
131-
[**Order**](Order.md)
130+
131+
[**Order**](Order.md) (PSCustomObject)
132132

133133
### Authorization
134134

@@ -168,8 +168,8 @@ Name | Type | Description | Notes
168168
**Order** | [**Order**](Order.md)| order placed for purchasing the pet |
169169

170170
### Return type
171-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
172-
[**Order**](Order.md)
171+
172+
[**Order**](Order.md) (PSCustomObject)
173173

174174
### Authorization
175175

samples/client/petstore/powershell/docs/PSUserApi.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Name | Type | Description | Notes
5050
**User** | [**User**](User.md)| Created user object |
5151

5252
### Return type
53-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
53+
5454
void (empty response body)
5555

5656
### Authorization
@@ -98,7 +98,7 @@ Name | Type | Description | Notes
9898
**User** | [**User[]**](User.md)| List of user object |
9999

100100
### Return type
101-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
101+
102102
void (empty response body)
103103

104104
### Authorization
@@ -146,7 +146,7 @@ Name | Type | Description | Notes
146146
**User** | [**User[]**](User.md)| List of user object |
147147

148148
### Return type
149-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
149+
150150
void (empty response body)
151151

152152
### Authorization
@@ -196,7 +196,7 @@ Name | Type | Description | Notes
196196
**Username** | **String**| The name that needs to be deleted |
197197

198198
### Return type
199-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
199+
200200
void (empty response body)
201201

202202
### Authorization
@@ -237,8 +237,8 @@ Name | Type | Description | Notes
237237
**Username** | **String**| The name that needs to be fetched. Use user1 for testing. |
238238

239239
### Return type
240-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
241-
[**User**](User.md)
240+
241+
[**User**](User.md) (PSCustomObject)
242242

243243
### Authorization
244244

@@ -281,7 +281,7 @@ Name | Type | Description | Notes
281281
**Password** | **String**| The password for login in clear text |
282282

283283
### Return type
284-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
284+
285285
**String**
286286

287287
### Authorization
@@ -324,7 +324,7 @@ try {
324324
This endpoint does not need any parameter.
325325

326326
### Return type
327-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
327+
328328
void (empty response body)
329329

330330
### Authorization
@@ -377,7 +377,7 @@ Name | Type | Description | Notes
377377
**User** | [**User**](User.md)| Updated user object |
378378

379379
### Return type
380-
# cmdlet returns PSCustomObject, the return object contains the properties of below type
380+
381381
void (empty response body)
382382

383383
### Authorization

0 commit comments

Comments
 (0)