Skip to content

Commit 4bb52d7

Browse files
author
Olivier Leonard
committed
Fix api_doc generation
1 parent 356ac91 commit 4bb52d7

File tree

23 files changed

+129
-124
lines changed

23 files changed

+129
-124
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@ All URIs are relative to *{{{basePath}}}*
1515
{{#operation}}
1616
<a id="{{{operationIdLowerCase}}}"></a>
1717
# **{{{operationId}}}**
18-
> {{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}}{{^useGenericHost}}{{>NullConditionalParameter}}{{/useGenericHost}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
18+
{{#useGenericHost}}
19+
> {{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
20+
{{/useGenericHost}}
21+
{{^useGenericHost}}
22+
> {{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{^required}}Option<{{/required}}{{{dataType}}}{{>NullConditionalParameter}}{{^required}}>{{/required}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = {{>DefaultDataTypeParameter}}{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
23+
{{/useGenericHost}}
1924

2025
{{{summary}}}{{#notes}}
2126

samples/client/echo_api/csharp-restsharp/docs/BodyApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ No authorization required
103103

104104
<a id="testbodyapplicationoctetstreambinary"></a>
105105
# **TestBodyApplicationOctetstreamBinary**
106-
> string TestBodyApplicationOctetstreamBinary (System.IO.Stream body = null)
106+
> string TestBodyApplicationOctetstreamBinary (Option<System.IO.Stream> body = default(Option<System.IO.Stream>))
107107
108108
Test body parameter(s)
109109

@@ -285,7 +285,7 @@ No authorization required
285285

286286
<a id="testbodymultipartformdatasinglebinary"></a>
287287
# **TestBodyMultipartFormdataSingleBinary**
288-
> string TestBodyMultipartFormdataSingleBinary (System.IO.Stream myFile = null)
288+
> string TestBodyMultipartFormdataSingleBinary (Option<System.IO.Stream> myFile = default(Option<System.IO.Stream>))
289289
290290
Test single binary in multipart mime
291291

@@ -376,7 +376,7 @@ No authorization required
376376

377377
<a id="testechobodyallofpet"></a>
378378
# **TestEchoBodyAllOfPet**
379-
> Pet TestEchoBodyAllOfPet (Pet pet = null)
379+
> Pet TestEchoBodyAllOfPet (Option<Pet> pet = default(Option<Pet>))
380380
381381
Test body parameter(s)
382382

@@ -467,7 +467,7 @@ No authorization required
467467

468468
<a id="testechobodyfreeformobjectresponsestring"></a>
469469
# **TestEchoBodyFreeFormObjectResponseString**
470-
> string TestEchoBodyFreeFormObjectResponseString (Object body = null)
470+
> string TestEchoBodyFreeFormObjectResponseString (Option<Object> body = default(Option<Object>))
471471
472472
Test free form object
473473

@@ -558,7 +558,7 @@ No authorization required
558558

559559
<a id="testechobodypet"></a>
560560
# **TestEchoBodyPet**
561-
> Pet TestEchoBodyPet (Pet pet = null)
561+
> Pet TestEchoBodyPet (Option<Pet> pet = default(Option<Pet>))
562562
563563
Test body parameter(s)
564564

@@ -649,7 +649,7 @@ No authorization required
649649

650650
<a id="testechobodypetresponsestring"></a>
651651
# **TestEchoBodyPetResponseString**
652-
> string TestEchoBodyPetResponseString (Pet pet = null)
652+
> string TestEchoBodyPetResponseString (Option<Pet> pet = default(Option<Pet>))
653653
654654
Test empty response body
655655

@@ -740,7 +740,7 @@ No authorization required
740740

741741
<a id="testechobodystringenum"></a>
742742
# **TestEchoBodyStringEnum**
743-
> StringEnumRef TestEchoBodyStringEnum (string body = null)
743+
> StringEnumRef TestEchoBodyStringEnum (Option<string> body = default(Option<string>))
744744
745745
Test string enum response body
746746

@@ -831,7 +831,7 @@ No authorization required
831831

832832
<a id="testechobodytagresponsestring"></a>
833833
# **TestEchoBodyTagResponseString**
834-
> string TestEchoBodyTagResponseString (Tag tag = null)
834+
> string TestEchoBodyTagResponseString (Option<Tag> tag = default(Option<Tag>))
835835
836836
Test empty json (request body)
837837

samples/client/echo_api/csharp-restsharp/docs/FormApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost:3000*
1010

1111
<a id="testformintegerbooleanstring"></a>
1212
# **TestFormIntegerBooleanString**
13-
> string TestFormIntegerBooleanString (int integerForm = null, bool booleanForm = null, string stringForm = null)
13+
> string TestFormIntegerBooleanString (Option<int> integerForm = default(Option<int>), Option<bool> booleanForm = default(Option<bool>), Option<string> stringForm = default(Option<string>))
1414
1515
Test form parameter(s)
1616

@@ -196,7 +196,7 @@ No authorization required
196196

197197
<a id="testformoneof"></a>
198198
# **TestFormOneof**
199-
> string TestFormOneof (string form1 = null, int form2 = null, string form3 = null, bool form4 = null, long id = null, string name = null)
199+
> string TestFormOneof (Option<string> form1 = default(Option<string>), Option<int> form2 = default(Option<int>), Option<string> form3 = default(Option<string>), Option<bool> form4 = default(Option<bool>), Option<long> id = default(Option<long>), Option<string> name = default(Option<string>))
200200
201201
Test form parameter(s) for oneOf schema
202202

samples/client/echo_api/csharp-restsharp/docs/HeaderApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ All URIs are relative to *http://localhost:3000*
88

99
<a id="testheaderintegerbooleanstringenums"></a>
1010
# **TestHeaderIntegerBooleanStringEnums**
11-
> string TestHeaderIntegerBooleanStringEnums (int integerHeader = null, bool booleanHeader = null, string stringHeader = null, string enumNonrefStringHeader = null, StringEnumRef enumRefStringHeader = null)
11+
> string TestHeaderIntegerBooleanStringEnums (Option<int> integerHeader = default(Option<int>), Option<bool> booleanHeader = default(Option<bool>), Option<string> stringHeader = default(Option<string>), Option<string> enumNonrefStringHeader = default(Option<string>), Option<StringEnumRef> enumRefStringHeader = default(Option<StringEnumRef>))
1212
1313
Test header parameter(s)
1414

samples/client/echo_api/csharp-restsharp/docs/QueryApi.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ All URIs are relative to *http://localhost:3000*
1717

1818
<a id="testenumrefstring"></a>
1919
# **TestEnumRefString**
20-
> string TestEnumRefString (string enumNonrefStringQuery = null, StringEnumRef enumRefStringQuery = null)
20+
> string TestEnumRefString (Option<string> enumNonrefStringQuery = default(Option<string>), Option<StringEnumRef> enumRefStringQuery = default(Option<StringEnumRef>))
2121
2222
Test query parameter(s)
2323

@@ -110,7 +110,7 @@ No authorization required
110110

111111
<a id="testquerydatetimedatestring"></a>
112112
# **TestQueryDatetimeDateString**
113-
> string TestQueryDatetimeDateString (DateTime datetimeQuery = null, DateOnly dateQuery = null, string stringQuery = null)
113+
> string TestQueryDatetimeDateString (Option<DateTime> datetimeQuery = default(Option<DateTime>), Option<DateOnly> dateQuery = default(Option<DateOnly>), Option<string> stringQuery = default(Option<string>))
114114
115115
Test query parameter(s)
116116

@@ -205,7 +205,7 @@ No authorization required
205205

206206
<a id="testqueryintegerbooleanstring"></a>
207207
# **TestQueryIntegerBooleanString**
208-
> string TestQueryIntegerBooleanString (int integerQuery = null, bool booleanQuery = null, string stringQuery = null)
208+
> string TestQueryIntegerBooleanString (Option<int> integerQuery = default(Option<int>), Option<bool> booleanQuery = default(Option<bool>), Option<string> stringQuery = default(Option<string>))
209209
210210
Test query parameter(s)
211211

@@ -300,7 +300,7 @@ No authorization required
300300

301301
<a id="testquerystyledeepobjectexplodetrueobject"></a>
302302
# **TestQueryStyleDeepObjectExplodeTrueObject**
303-
> string TestQueryStyleDeepObjectExplodeTrueObject (Pet queryObject = null)
303+
> string TestQueryStyleDeepObjectExplodeTrueObject (Option<Pet> queryObject = default(Option<Pet>))
304304
305305
Test query parameter(s)
306306

@@ -391,7 +391,7 @@ No authorization required
391391

392392
<a id="testquerystyledeepobjectexplodetrueobjectallof"></a>
393393
# **TestQueryStyleDeepObjectExplodeTrueObjectAllOf**
394-
> string TestQueryStyleDeepObjectExplodeTrueObjectAllOf (TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter queryObject = null)
394+
> string TestQueryStyleDeepObjectExplodeTrueObjectAllOf (Option<TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter> queryObject = default(Option<TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter>))
395395
396396
Test query parameter(s)
397397

@@ -482,7 +482,7 @@ No authorization required
482482

483483
<a id="testquerystyleformexplodefalsearrayinteger"></a>
484484
# **TestQueryStyleFormExplodeFalseArrayInteger**
485-
> string TestQueryStyleFormExplodeFalseArrayInteger (List<int> queryObject = null)
485+
> string TestQueryStyleFormExplodeFalseArrayInteger (Option<List<int>> queryObject = default(Option<List<int>>))
486486
487487
Test query parameter(s)
488488

@@ -573,7 +573,7 @@ No authorization required
573573

574574
<a id="testquerystyleformexplodefalsearraystring"></a>
575575
# **TestQueryStyleFormExplodeFalseArrayString**
576-
> string TestQueryStyleFormExplodeFalseArrayString (List<string> queryObject = null)
576+
> string TestQueryStyleFormExplodeFalseArrayString (Option<List<string>> queryObject = default(Option<List<string>>))
577577
578578
Test query parameter(s)
579579

@@ -664,7 +664,7 @@ No authorization required
664664

665665
<a id="testquerystyleformexplodetruearraystring"></a>
666666
# **TestQueryStyleFormExplodeTrueArrayString**
667-
> string TestQueryStyleFormExplodeTrueArrayString (TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter queryObject = null)
667+
> string TestQueryStyleFormExplodeTrueArrayString (Option<TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter> queryObject = default(Option<TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter>))
668668
669669
Test query parameter(s)
670670

@@ -755,7 +755,7 @@ No authorization required
755755

756756
<a id="testquerystyleformexplodetrueobject"></a>
757757
# **TestQueryStyleFormExplodeTrueObject**
758-
> string TestQueryStyleFormExplodeTrueObject (Pet queryObject = null)
758+
> string TestQueryStyleFormExplodeTrueObject (Option<Pet> queryObject = default(Option<Pet>))
759759
760760
Test query parameter(s)
761761

@@ -846,7 +846,7 @@ No authorization required
846846

847847
<a id="testquerystyleformexplodetrueobjectallof"></a>
848848
# **TestQueryStyleFormExplodeTrueObjectAllOf**
849-
> string TestQueryStyleFormExplodeTrueObjectAllOf (DataQuery queryObject = null)
849+
> string TestQueryStyleFormExplodeTrueObjectAllOf (Option<DataQuery> queryObject = default(Option<DataQuery>))
850850
851851
Test query parameter(s)
852852

samples/client/others/csharp-complex-files/docs/MultipartApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All URIs are relative to *http://localhost*
1010

1111
<a id="multipartarray"></a>
1212
# **MultipartArray**
13-
> void MultipartArray (List<System.IO.Stream> files = null)
13+
> void MultipartArray (Option<List<System.IO.Stream>> files = default(Option<List<System.IO.Stream>>))
1414
1515

1616

@@ -95,7 +95,7 @@ No authorization required
9595

9696
<a id="multipartmixed"></a>
9797
# **MultipartMixed**
98-
> void MultipartMixed (MultipartMixedStatus status, System.IO.Stream file, MultipartMixedRequestMarker marker = null, List<MultipartMixedStatus> statusArray = null)
98+
> void MultipartMixed (MultipartMixedStatus status, System.IO.Stream file, Option<MultipartMixedRequestMarker> marker = default(Option<MultipartMixedRequestMarker>), Option<List<MultipartMixedStatus>> statusArray = default(Option<List<MultipartMixedStatus>>))
9999
100100

101101

@@ -186,7 +186,7 @@ No authorization required
186186

187187
<a id="multipartsingle"></a>
188188
# **MultipartSingle**
189-
> void MultipartSingle (System.IO.Stream file = null)
189+
> void MultipartSingle (Option<System.IO.Stream> file = default(Option<System.IO.Stream>))
190190
191191

192192

samples/client/petstore/csharp/httpclient/standard2.0/Petstore/docs/FakeApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ No authorization required
115115

116116
<a id="fakeouterbooleanserialize"></a>
117117
# **FakeOuterBooleanSerialize**
118-
> bool FakeOuterBooleanSerialize (bool body = null)
118+
> bool FakeOuterBooleanSerialize (Option<bool> body = default(Option<bool>))
119119
120120

121121

@@ -208,7 +208,7 @@ No authorization required
208208

209209
<a id="fakeoutercompositeserialize"></a>
210210
# **FakeOuterCompositeSerialize**
211-
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
211+
> OuterComposite FakeOuterCompositeSerialize (Option<OuterComposite> outerComposite = default(Option<OuterComposite>))
212212
213213

214214

@@ -301,7 +301,7 @@ No authorization required
301301

302302
<a id="fakeouternumberserialize"></a>
303303
# **FakeOuterNumberSerialize**
304-
> decimal FakeOuterNumberSerialize (decimal body = null)
304+
> decimal FakeOuterNumberSerialize (Option<decimal> body = default(Option<decimal>))
305305
306306

307307

@@ -394,7 +394,7 @@ No authorization required
394394

395395
<a id="fakeouterstringserialize"></a>
396396
# **FakeOuterStringSerialize**
397-
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
397+
> string FakeOuterStringSerialize (Guid requiredStringUuid, Option<string> body = default(Option<string>))
398398
399399

400400

@@ -1115,7 +1115,7 @@ No authorization required
11151115

11161116
<a id="testendpointparameters"></a>
11171117
# **TestEndpointParameters**
1118-
> void TestEndpointParameters (decimal number, double varDouble, string patternWithoutDelimiter, byte[] varByte, int integer = null, int int32 = null, long int64 = null, float varFloat = null, string varString = null, FileParameter binary = null, DateTime date = null, DateTime dateTime = null, string password = null, string callback = null)
1118+
> void TestEndpointParameters (decimal number, double varDouble, string patternWithoutDelimiter, byte[] varByte, Option<int> integer = default(Option<int>), Option<int> int32 = default(Option<int>), Option<long> int64 = default(Option<long>), Option<float> varFloat = default(Option<float>), Option<string> varString = default(Option<string>), Option<FileParameter> binary = default(Option<FileParameter>), Option<DateTime> date = default(Option<DateTime>), Option<DateTime> dateTime = default(Option<DateTime>), Option<string> password = default(Option<string>), Option<string> callback = default(Option<string>))
11191119
11201120
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
11211121

@@ -1237,7 +1237,7 @@ void (empty response body)
12371237

12381238
<a id="testenumparameters"></a>
12391239
# **TestEnumParameters**
1240-
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int enumQueryInteger = null, double enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
1240+
> void TestEnumParameters (Option<List<string>> enumHeaderStringArray = default(Option<List<string>>), Option<string> enumHeaderString = default(Option<string>), Option<List<string>> enumQueryStringArray = default(Option<List<string>>), Option<string> enumQueryString = default(Option<string>), Option<int> enumQueryInteger = default(Option<int>), Option<double> enumQueryDouble = default(Option<double>), Option<List<string>> enumFormStringArray = default(Option<List<string>>), Option<string> enumFormString = default(Option<string>))
12411241
12421242
To test enum parameters
12431243

@@ -1343,7 +1343,7 @@ No authorization required
13431343

13441344
<a id="testgroupparameters"></a>
13451345
# **TestGroupParameters**
1346-
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int stringGroup = null, bool booleanGroup = null, long int64Group = null)
1346+
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, Option<int> stringGroup = default(Option<int>), Option<bool> booleanGroup = default(Option<bool>), Option<long> int64Group = default(Option<long>))
13471347
13481348
Fake endpoint to test group parameters (optional)
13491349

@@ -1716,7 +1716,7 @@ No authorization required
17161716

17171717
<a id="testqueryparametercollectionformat"></a>
17181718
# **TestQueryParameterCollectionFormat**
1719-
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context, string requiredNotNullable, string requiredNullable, string notRequiredNotNullable = null, string notRequiredNullable = null)
1719+
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context, string requiredNotNullable, string requiredNullable, Option<string> notRequiredNotNullable = default(Option<string>), Option<string> notRequiredNullable = default(Option<string>))
17201720
17211721

17221722

samples/client/petstore/csharp/httpclient/standard2.0/Petstore/docs/PetApi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ void (empty response body)
108108

109109
<a id="deletepet"></a>
110110
# **DeletePet**
111-
> void DeletePet (long petId, string apiKey = null)
111+
> void DeletePet (long petId, Option<string> apiKey = default(Option<string>))
112112
113113
Deletes a pet
114114

@@ -600,7 +600,7 @@ void (empty response body)
600600

601601
<a id="updatepetwithform"></a>
602602
# **UpdatePetWithForm**
603-
> void UpdatePetWithForm (long petId, string name = null, string status = null)
603+
> void UpdatePetWithForm (long petId, Option<string> name = default(Option<string>), Option<string> status = default(Option<string>))
604604
605605
Updates a pet in the store with form data
606606

@@ -696,7 +696,7 @@ void (empty response body)
696696

697697
<a id="uploadfile"></a>
698698
# **UploadFile**
699-
> ApiResponse UploadFile (long petId, string additionalMetadata = null, FileParameter file = null)
699+
> ApiResponse UploadFile (long petId, Option<string> additionalMetadata = default(Option<string>), Option<FileParameter> file = default(Option<FileParameter>))
700700
701701
uploads an image
702702

@@ -796,7 +796,7 @@ catch (ApiException e)
796796

797797
<a id="uploadfilewithrequiredfile"></a>
798798
# **UploadFileWithRequiredFile**
799-
> ApiResponse UploadFileWithRequiredFile (long petId, FileParameter requiredFile, string additionalMetadata = null)
799+
> ApiResponse UploadFileWithRequiredFile (long petId, FileParameter requiredFile, Option<string> additionalMetadata = default(Option<string>))
800800
801801
uploads an image (required)
802802

samples/client/petstore/csharp/restsharp/net4.7/MultipleFrameworks/docs/PetApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ catch (ApiException e)
108108

109109
<a id="deletepet"></a>
110110
# **DeletePet**
111-
> void DeletePet (long petId, string apiKey = null)
111+
> void DeletePet (long petId, Option<string> apiKey = default(Option<string>))
112112
113113
Deletes a pet
114114

@@ -581,7 +581,7 @@ catch (ApiException e)
581581

582582
<a id="updatepetwithform"></a>
583583
# **UpdatePetWithForm**
584-
> void UpdatePetWithForm (long petId, string name = null, string status = null)
584+
> void UpdatePetWithForm (long petId, Option<string> name = default(Option<string>), Option<string> status = default(Option<string>))
585585
586586
Updates a pet in the store with form data
587587

@@ -673,7 +673,7 @@ void (empty response body)
673673

674674
<a id="uploadfile"></a>
675675
# **UploadFile**
676-
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
676+
> ApiResponse UploadFile (long petId, Option<string> additionalMetadata = default(Option<string>), Option<System.IO.Stream> file = default(Option<System.IO.Stream>))
677677
678678
uploads an image
679679

0 commit comments

Comments
 (0)