From 3693d608403c2bf5c01d2a25db2da4b26e2e78b8 Mon Sep 17 00:00:00 2001 From: Hippolyte HENRY Date: Tue, 15 Oct 2019 08:46:45 +0200 Subject: [PATCH] Add newline between function signature of operation and summary of operation (#4112) * Add newline after function signature * update Petstore * [go] Add newline after function signature * update petstore --- .../resources/go-experimental/api_doc.mustache | 1 + .../src/main/resources/go/api_doc.mustache | 1 + .../go-petstore/docs/AnotherFakeApi.md | 1 + .../go-experimental/go-petstore/docs/FakeApi.md | 14 ++++++++++++++ .../go-petstore/docs/FakeClassnameTags123Api.md | 1 + .../go-experimental/go-petstore/docs/PetApi.md | 9 +++++++++ .../go-experimental/go-petstore/docs/StoreApi.md | 4 ++++ .../go-experimental/go-petstore/docs/UserApi.md | 8 ++++++++ .../petstore/go/go-petstore/docs/AnotherFakeApi.md | 1 + .../client/petstore/go/go-petstore/docs/FakeApi.md | 14 ++++++++++++++ .../go/go-petstore/docs/FakeClassnameTags123Api.md | 1 + .../client/petstore/go/go-petstore/docs/PetApi.md | 9 +++++++++ .../petstore/go/go-petstore/docs/StoreApi.md | 4 ++++ .../client/petstore/go/go-petstore/docs/UserApi.md | 8 ++++++++ .../go-petstore/docs/AnotherFakeApi.md | 1 + .../go-experimental/go-petstore/docs/DefaultApi.md | 1 + .../go-experimental/go-petstore/docs/FakeApi.md | 14 ++++++++++++++ .../go-petstore/docs/FakeClassnameTags123Api.md | 1 + .../go-experimental/go-petstore/docs/PetApi.md | 9 +++++++++ .../go-experimental/go-petstore/docs/StoreApi.md | 4 ++++ .../go-experimental/go-petstore/docs/UserApi.md | 8 ++++++++ .../petstore/go/go-petstore/docs/AnotherFakeApi.md | 1 + .../petstore/go/go-petstore/docs/DefaultApi.md | 1 + .../client/petstore/go/go-petstore/docs/FakeApi.md | 14 ++++++++++++++ .../go/go-petstore/docs/FakeClassnameTags123Api.md | 1 + .../client/petstore/go/go-petstore/docs/PetApi.md | 9 +++++++++ .../petstore/go/go-petstore/docs/StoreApi.md | 4 ++++ .../client/petstore/go/go-petstore/docs/UserApi.md | 8 ++++++++ 28 files changed, 152 insertions(+) diff --git a/modules/openapi-generator/src/main/resources/go-experimental/api_doc.mustache b/modules/openapi-generator/src/main/resources/go-experimental/api_doc.mustache index 2ac67bb2221..d7eda37d714 100644 --- a/modules/openapi-generator/src/main/resources/go-experimental/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/go-experimental/api_doc.mustache @@ -15,6 +15,7 @@ Method | HTTP request | Description ## {{{operationId}}} > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}(ctx, {{#allParams}}{{#required}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/required}}{{/allParams}}{{#hasOptionalParams}}optional{{/hasOptionalParams}}) + {{{summary}}}{{#notes}} {{{notes}}}{{/notes}} diff --git a/modules/openapi-generator/src/main/resources/go/api_doc.mustache b/modules/openapi-generator/src/main/resources/go/api_doc.mustache index 2ac67bb2221..d7eda37d714 100644 --- a/modules/openapi-generator/src/main/resources/go/api_doc.mustache +++ b/modules/openapi-generator/src/main/resources/go/api_doc.mustache @@ -15,6 +15,7 @@ Method | HTTP request | Description ## {{{operationId}}} > {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}(ctx, {{#allParams}}{{#required}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/required}}{{/allParams}}{{#hasOptionalParams}}optional{{/hasOptionalParams}}) + {{{summary}}}{{#notes}} {{{notes}}}{{/notes}} diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md b/samples/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md index 0b9deb0c58a..2c22f8f1b30 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## Call123TestSpecialTags > Client Call123TestSpecialTags(ctx, body) + To test special tags To test special tags and operation ID starting with number diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/FakeApi.md b/samples/client/petstore/go-experimental/go-petstore/docs/FakeApi.md index 9aaf2e63a96..1d85fdf9d31 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/FakeApi.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/FakeApi.md @@ -24,6 +24,7 @@ Method | HTTP request | Description ## CreateXmlItem > CreateXmlItem(ctx, xmlItem) + creates an XmlItem this route creates an XmlItem @@ -59,6 +60,7 @@ No authorization required > bool FakeOuterBooleanSerialize(ctx, optional) + Test serialization of outer boolean types ### Required Parameters @@ -101,6 +103,7 @@ No authorization required > OuterComposite FakeOuterCompositeSerialize(ctx, optional) + Test serialization of object with outer number type ### Required Parameters @@ -143,6 +146,7 @@ No authorization required > float32 FakeOuterNumberSerialize(ctx, optional) + Test serialization of outer number types ### Required Parameters @@ -185,6 +189,7 @@ No authorization required > string FakeOuterStringSerialize(ctx, optional) + Test serialization of outer string types ### Required Parameters @@ -227,6 +232,7 @@ No authorization required > TestBodyWithFileSchema(ctx, body) + For this test, the body for this request much reference a schema named `File`. ### Required Parameters @@ -260,6 +266,7 @@ No authorization required > TestBodyWithQueryParams(ctx, query, body) + ### Required Parameters @@ -290,6 +297,7 @@ No authorization required ## TestClientModel > Client TestClientModel(ctx, body) + To test \"client\" model To test \"client\" model @@ -323,6 +331,7 @@ No authorization required ## TestEndpointParameters > TestEndpointParameters(ctx, number, double, patternWithoutDelimiter, byte_, optional) + Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -382,6 +391,7 @@ Name | Type | Description | Notes ## TestEnumParameters > TestEnumParameters(ctx, optional) + To test enum parameters To test enum parameters @@ -431,6 +441,7 @@ No authorization required ## TestGroupParameters > TestGroupParameters(ctx, requiredStringGroup, requiredBooleanGroup, requiredInt64Group, optional) + Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) @@ -481,6 +492,7 @@ No authorization required ## TestInlineAdditionalProperties > TestInlineAdditionalProperties(ctx, param) + test inline additionalProperties ### Required Parameters @@ -512,6 +524,7 @@ No authorization required ## TestJsonFormData > TestJsonFormData(ctx, param, param2) + test json serialization of form data ### Required Parameters @@ -546,6 +559,7 @@ No authorization required > TestQueryParameterCollectionFormat(ctx, pipe, ioutil, http, url, context) + To test the collection format in query parameters ### Required Parameters diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md b/samples/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md index b3cbcc2c06e..224542b7051 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## TestClassname > Client TestClassname(ctx, body) + To test class name in snake case To test class name in snake case diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/PetApi.md b/samples/client/petstore/go-experimental/go-petstore/docs/PetApi.md index de48d4b6763..6ee9afef754 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/PetApi.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/PetApi.md @@ -19,6 +19,7 @@ Method | HTTP request | Description ## AddPet > AddPet(ctx, body) + Add a new pet to the store ### Required Parameters @@ -50,6 +51,7 @@ Name | Type | Description | Notes ## DeletePet > DeletePet(ctx, petId, optional) + Deletes a pet ### Required Parameters @@ -92,6 +94,7 @@ Name | Type | Description | Notes ## FindPetsByStatus > []Pet FindPetsByStatus(ctx, status) + Finds Pets by status Multiple status values can be provided with comma separated strings @@ -125,6 +128,7 @@ Name | Type | Description | Notes ## FindPetsByTags > []Pet FindPetsByTags(ctx, tags) + Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. @@ -158,6 +162,7 @@ Name | Type | Description | Notes ## GetPetById > Pet GetPetById(ctx, petId) + Find pet by ID Returns a single pet @@ -191,6 +196,7 @@ Name | Type | Description | Notes ## UpdatePet > UpdatePet(ctx, body) + Update an existing pet ### Required Parameters @@ -222,6 +228,7 @@ Name | Type | Description | Notes ## UpdatePetWithForm > UpdatePetWithForm(ctx, petId, optional) + Updates a pet in the store with form data ### Required Parameters @@ -265,6 +272,7 @@ Name | Type | Description | Notes ## UploadFile > ApiResponse UploadFile(ctx, petId, optional) + uploads an image ### Required Parameters @@ -308,6 +316,7 @@ Name | Type | Description | Notes ## UploadFileWithRequiredFile > ApiResponse UploadFileWithRequiredFile(ctx, petId, requiredFile, optional) + uploads an image (required) ### Required Parameters diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/StoreApi.md b/samples/client/petstore/go-experimental/go-petstore/docs/StoreApi.md index 083ed777590..531ab09ff68 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/StoreApi.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/StoreApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description ## DeleteOrder > DeleteOrder(ctx, orderId) + Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors @@ -47,6 +48,7 @@ No authorization required ## GetInventory > map[string]int32 GetInventory(ctx, ) + Returns pet inventories by status Returns a map of status codes to quantities @@ -76,6 +78,7 @@ This endpoint does not need any parameter. ## GetOrderById > Order GetOrderById(ctx, orderId) + Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions @@ -109,6 +112,7 @@ No authorization required ## PlaceOrder > Order PlaceOrder(ctx, body) + Place an order for a pet ### Required Parameters diff --git a/samples/client/petstore/go-experimental/go-petstore/docs/UserApi.md b/samples/client/petstore/go-experimental/go-petstore/docs/UserApi.md index 3201e1771dc..d9f16bb5fb0 100644 --- a/samples/client/petstore/go-experimental/go-petstore/docs/UserApi.md +++ b/samples/client/petstore/go-experimental/go-petstore/docs/UserApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description ## CreateUser > CreateUser(ctx, body) + Create user This can only be done by the logged in user. @@ -51,6 +52,7 @@ No authorization required ## CreateUsersWithArrayInput > CreateUsersWithArrayInput(ctx, body) + Creates list of users with given input array ### Required Parameters @@ -82,6 +84,7 @@ No authorization required ## CreateUsersWithListInput > CreateUsersWithListInput(ctx, body) + Creates list of users with given input array ### Required Parameters @@ -113,6 +116,7 @@ No authorization required ## DeleteUser > DeleteUser(ctx, username) + Delete user This can only be done by the logged in user. @@ -146,6 +150,7 @@ No authorization required ## GetUserByName > User GetUserByName(ctx, username) + Get user by user name ### Required Parameters @@ -177,6 +182,7 @@ No authorization required ## LoginUser > string LoginUser(ctx, username, password) + Logs user into the system ### Required Parameters @@ -209,6 +215,7 @@ No authorization required ## LogoutUser > LogoutUser(ctx, ) + Logs out current logged in user session ### Required Parameters @@ -236,6 +243,7 @@ No authorization required ## UpdateUser > UpdateUser(ctx, username, body) + Updated user This can only be done by the logged in user. diff --git a/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md b/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md index 0b9deb0c58a..2c22f8f1b30 100644 --- a/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md +++ b/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## Call123TestSpecialTags > Client Call123TestSpecialTags(ctx, body) + To test special tags To test special tags and operation ID starting with number diff --git a/samples/client/petstore/go/go-petstore/docs/FakeApi.md b/samples/client/petstore/go/go-petstore/docs/FakeApi.md index 9aaf2e63a96..1d85fdf9d31 100644 --- a/samples/client/petstore/go/go-petstore/docs/FakeApi.md +++ b/samples/client/petstore/go/go-petstore/docs/FakeApi.md @@ -24,6 +24,7 @@ Method | HTTP request | Description ## CreateXmlItem > CreateXmlItem(ctx, xmlItem) + creates an XmlItem this route creates an XmlItem @@ -59,6 +60,7 @@ No authorization required > bool FakeOuterBooleanSerialize(ctx, optional) + Test serialization of outer boolean types ### Required Parameters @@ -101,6 +103,7 @@ No authorization required > OuterComposite FakeOuterCompositeSerialize(ctx, optional) + Test serialization of object with outer number type ### Required Parameters @@ -143,6 +146,7 @@ No authorization required > float32 FakeOuterNumberSerialize(ctx, optional) + Test serialization of outer number types ### Required Parameters @@ -185,6 +189,7 @@ No authorization required > string FakeOuterStringSerialize(ctx, optional) + Test serialization of outer string types ### Required Parameters @@ -227,6 +232,7 @@ No authorization required > TestBodyWithFileSchema(ctx, body) + For this test, the body for this request much reference a schema named `File`. ### Required Parameters @@ -260,6 +266,7 @@ No authorization required > TestBodyWithQueryParams(ctx, query, body) + ### Required Parameters @@ -290,6 +297,7 @@ No authorization required ## TestClientModel > Client TestClientModel(ctx, body) + To test \"client\" model To test \"client\" model @@ -323,6 +331,7 @@ No authorization required ## TestEndpointParameters > TestEndpointParameters(ctx, number, double, patternWithoutDelimiter, byte_, optional) + Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -382,6 +391,7 @@ Name | Type | Description | Notes ## TestEnumParameters > TestEnumParameters(ctx, optional) + To test enum parameters To test enum parameters @@ -431,6 +441,7 @@ No authorization required ## TestGroupParameters > TestGroupParameters(ctx, requiredStringGroup, requiredBooleanGroup, requiredInt64Group, optional) + Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) @@ -481,6 +492,7 @@ No authorization required ## TestInlineAdditionalProperties > TestInlineAdditionalProperties(ctx, param) + test inline additionalProperties ### Required Parameters @@ -512,6 +524,7 @@ No authorization required ## TestJsonFormData > TestJsonFormData(ctx, param, param2) + test json serialization of form data ### Required Parameters @@ -546,6 +559,7 @@ No authorization required > TestQueryParameterCollectionFormat(ctx, pipe, ioutil, http, url, context) + To test the collection format in query parameters ### Required Parameters diff --git a/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md b/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md index b3cbcc2c06e..224542b7051 100644 --- a/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## TestClassname > Client TestClassname(ctx, body) + To test class name in snake case To test class name in snake case diff --git a/samples/client/petstore/go/go-petstore/docs/PetApi.md b/samples/client/petstore/go/go-petstore/docs/PetApi.md index de48d4b6763..6ee9afef754 100644 --- a/samples/client/petstore/go/go-petstore/docs/PetApi.md +++ b/samples/client/petstore/go/go-petstore/docs/PetApi.md @@ -19,6 +19,7 @@ Method | HTTP request | Description ## AddPet > AddPet(ctx, body) + Add a new pet to the store ### Required Parameters @@ -50,6 +51,7 @@ Name | Type | Description | Notes ## DeletePet > DeletePet(ctx, petId, optional) + Deletes a pet ### Required Parameters @@ -92,6 +94,7 @@ Name | Type | Description | Notes ## FindPetsByStatus > []Pet FindPetsByStatus(ctx, status) + Finds Pets by status Multiple status values can be provided with comma separated strings @@ -125,6 +128,7 @@ Name | Type | Description | Notes ## FindPetsByTags > []Pet FindPetsByTags(ctx, tags) + Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. @@ -158,6 +162,7 @@ Name | Type | Description | Notes ## GetPetById > Pet GetPetById(ctx, petId) + Find pet by ID Returns a single pet @@ -191,6 +196,7 @@ Name | Type | Description | Notes ## UpdatePet > UpdatePet(ctx, body) + Update an existing pet ### Required Parameters @@ -222,6 +228,7 @@ Name | Type | Description | Notes ## UpdatePetWithForm > UpdatePetWithForm(ctx, petId, optional) + Updates a pet in the store with form data ### Required Parameters @@ -265,6 +272,7 @@ Name | Type | Description | Notes ## UploadFile > ApiResponse UploadFile(ctx, petId, optional) + uploads an image ### Required Parameters @@ -308,6 +316,7 @@ Name | Type | Description | Notes ## UploadFileWithRequiredFile > ApiResponse UploadFileWithRequiredFile(ctx, petId, requiredFile, optional) + uploads an image (required) ### Required Parameters diff --git a/samples/client/petstore/go/go-petstore/docs/StoreApi.md b/samples/client/petstore/go/go-petstore/docs/StoreApi.md index 083ed777590..531ab09ff68 100644 --- a/samples/client/petstore/go/go-petstore/docs/StoreApi.md +++ b/samples/client/petstore/go/go-petstore/docs/StoreApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description ## DeleteOrder > DeleteOrder(ctx, orderId) + Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors @@ -47,6 +48,7 @@ No authorization required ## GetInventory > map[string]int32 GetInventory(ctx, ) + Returns pet inventories by status Returns a map of status codes to quantities @@ -76,6 +78,7 @@ This endpoint does not need any parameter. ## GetOrderById > Order GetOrderById(ctx, orderId) + Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions @@ -109,6 +112,7 @@ No authorization required ## PlaceOrder > Order PlaceOrder(ctx, body) + Place an order for a pet ### Required Parameters diff --git a/samples/client/petstore/go/go-petstore/docs/UserApi.md b/samples/client/petstore/go/go-petstore/docs/UserApi.md index 3201e1771dc..d9f16bb5fb0 100644 --- a/samples/client/petstore/go/go-petstore/docs/UserApi.md +++ b/samples/client/petstore/go/go-petstore/docs/UserApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description ## CreateUser > CreateUser(ctx, body) + Create user This can only be done by the logged in user. @@ -51,6 +52,7 @@ No authorization required ## CreateUsersWithArrayInput > CreateUsersWithArrayInput(ctx, body) + Creates list of users with given input array ### Required Parameters @@ -82,6 +84,7 @@ No authorization required ## CreateUsersWithListInput > CreateUsersWithListInput(ctx, body) + Creates list of users with given input array ### Required Parameters @@ -113,6 +116,7 @@ No authorization required ## DeleteUser > DeleteUser(ctx, username) + Delete user This can only be done by the logged in user. @@ -146,6 +150,7 @@ No authorization required ## GetUserByName > User GetUserByName(ctx, username) + Get user by user name ### Required Parameters @@ -177,6 +182,7 @@ No authorization required ## LoginUser > string LoginUser(ctx, username, password) + Logs user into the system ### Required Parameters @@ -209,6 +215,7 @@ No authorization required ## LogoutUser > LogoutUser(ctx, ) + Logs out current logged in user session ### Required Parameters @@ -236,6 +243,7 @@ No authorization required ## UpdateUser > UpdateUser(ctx, username, body) + Updated user This can only be done by the logged in user. diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md index 9c6ce64e293..fb674f202e1 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/AnotherFakeApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## Call123TestSpecialTags > Client Call123TestSpecialTags(ctx, client) + To test special tags To test special tags and operation ID starting with number diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/DefaultApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/DefaultApi.md index 4fd0ab98720..daf779c8e3e 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/DefaultApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/DefaultApi.md @@ -13,6 +13,7 @@ Method | HTTP request | Description > InlineResponseDefault FooGet(ctx, ) + ### Required Parameters This endpoint does not need any parameter. diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeApi.md index 0c11da8d772..3634a8771e2 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeApi.md @@ -24,6 +24,7 @@ Method | HTTP request | Description ## FakeHealthGet > HealthCheckResult FakeHealthGet(ctx, ) + Health check endpoint ### Required Parameters @@ -53,6 +54,7 @@ No authorization required > bool FakeOuterBooleanSerialize(ctx, optional) + Test serialization of outer boolean types ### Required Parameters @@ -95,6 +97,7 @@ No authorization required > OuterComposite FakeOuterCompositeSerialize(ctx, optional) + Test serialization of object with outer number type ### Required Parameters @@ -137,6 +140,7 @@ No authorization required > float32 FakeOuterNumberSerialize(ctx, optional) + Test serialization of outer number types ### Required Parameters @@ -179,6 +183,7 @@ No authorization required > string FakeOuterStringSerialize(ctx, optional) + Test serialization of outer string types ### Required Parameters @@ -221,6 +226,7 @@ No authorization required > TestBodyWithFileSchema(ctx, fileSchemaTestClass) + For this test, the body for this request much reference a schema named `File`. ### Required Parameters @@ -254,6 +260,7 @@ No authorization required > TestBodyWithQueryParams(ctx, query, user) + ### Required Parameters @@ -284,6 +291,7 @@ No authorization required ## TestClientModel > Client TestClientModel(ctx, client) + To test \"client\" model To test \"client\" model @@ -317,6 +325,7 @@ No authorization required ## TestEndpointParameters > TestEndpointParameters(ctx, number, double, patternWithoutDelimiter, byte_, optional) + Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -376,6 +385,7 @@ Name | Type | Description | Notes ## TestEnumParameters > TestEnumParameters(ctx, optional) + To test enum parameters To test enum parameters @@ -425,6 +435,7 @@ No authorization required ## TestGroupParameters > TestGroupParameters(ctx, requiredStringGroup, requiredBooleanGroup, requiredInt64Group, optional) + Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) @@ -475,6 +486,7 @@ Name | Type | Description | Notes ## TestInlineAdditionalProperties > TestInlineAdditionalProperties(ctx, requestBody) + test inline additionalProperties ### Required Parameters @@ -506,6 +518,7 @@ No authorization required ## TestJsonFormData > TestJsonFormData(ctx, param, param2) + test json serialization of form data ### Required Parameters @@ -540,6 +553,7 @@ No authorization required > TestQueryParameterCollectionFormat(ctx, pipe, ioutil, http, url, context) + To test the collection format in query parameters ### Required Parameters diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md index 5bf7b3bcc99..b070326cc32 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/FakeClassnameTags123Api.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## TestClassname > Client TestClassname(ctx, client) + To test class name in snake case To test class name in snake case diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/PetApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/PetApi.md index c4f37589f0c..8118df7009b 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/PetApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/PetApi.md @@ -19,6 +19,7 @@ Method | HTTP request | Description ## AddPet > AddPet(ctx, pet) + Add a new pet to the store ### Required Parameters @@ -50,6 +51,7 @@ Name | Type | Description | Notes ## DeletePet > DeletePet(ctx, petId, optional) + Deletes a pet ### Required Parameters @@ -92,6 +94,7 @@ Name | Type | Description | Notes ## FindPetsByStatus > []Pet FindPetsByStatus(ctx, status) + Finds Pets by status Multiple status values can be provided with comma separated strings @@ -125,6 +128,7 @@ Name | Type | Description | Notes ## FindPetsByTags > []Pet FindPetsByTags(ctx, tags) + Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. @@ -158,6 +162,7 @@ Name | Type | Description | Notes ## GetPetById > Pet GetPetById(ctx, petId) + Find pet by ID Returns a single pet @@ -191,6 +196,7 @@ Name | Type | Description | Notes ## UpdatePet > UpdatePet(ctx, pet) + Update an existing pet ### Required Parameters @@ -222,6 +228,7 @@ Name | Type | Description | Notes ## UpdatePetWithForm > UpdatePetWithForm(ctx, petId, optional) + Updates a pet in the store with form data ### Required Parameters @@ -265,6 +272,7 @@ Name | Type | Description | Notes ## UploadFile > ApiResponse UploadFile(ctx, petId, optional) + uploads an image ### Required Parameters @@ -308,6 +316,7 @@ Name | Type | Description | Notes ## UploadFileWithRequiredFile > ApiResponse UploadFileWithRequiredFile(ctx, petId, requiredFile, optional) + uploads an image (required) ### Required Parameters diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/StoreApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/StoreApi.md index c7f9bbcee08..c24d87bbfd6 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/StoreApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description ## DeleteOrder > DeleteOrder(ctx, orderId) + Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors @@ -47,6 +48,7 @@ No authorization required ## GetInventory > map[string]int32 GetInventory(ctx, ) + Returns pet inventories by status Returns a map of status codes to quantities @@ -76,6 +78,7 @@ This endpoint does not need any parameter. ## GetOrderById > Order GetOrderById(ctx, orderId) + Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions @@ -109,6 +112,7 @@ No authorization required ## PlaceOrder > Order PlaceOrder(ctx, order) + Place an order for a pet ### Required Parameters diff --git a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/UserApi.md b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/UserApi.md index 6c443592e53..01d05d555cf 100644 --- a/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/UserApi.md +++ b/samples/openapi3/client/petstore/go-experimental/go-petstore/docs/UserApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description ## CreateUser > CreateUser(ctx, user) + Create user This can only be done by the logged in user. @@ -51,6 +52,7 @@ No authorization required ## CreateUsersWithArrayInput > CreateUsersWithArrayInput(ctx, user) + Creates list of users with given input array ### Required Parameters @@ -82,6 +84,7 @@ No authorization required ## CreateUsersWithListInput > CreateUsersWithListInput(ctx, user) + Creates list of users with given input array ### Required Parameters @@ -113,6 +116,7 @@ No authorization required ## DeleteUser > DeleteUser(ctx, username) + Delete user This can only be done by the logged in user. @@ -146,6 +150,7 @@ No authorization required ## GetUserByName > User GetUserByName(ctx, username) + Get user by user name ### Required Parameters @@ -177,6 +182,7 @@ No authorization required ## LoginUser > string LoginUser(ctx, username, password) + Logs user into the system ### Required Parameters @@ -209,6 +215,7 @@ No authorization required ## LogoutUser > LogoutUser(ctx, ) + Logs out current logged in user session ### Required Parameters @@ -236,6 +243,7 @@ No authorization required ## UpdateUser > UpdateUser(ctx, username, user) + Updated user This can only be done by the logged in user. diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/AnotherFakeApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/AnotherFakeApi.md index 9c6ce64e293..fb674f202e1 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/AnotherFakeApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/AnotherFakeApi.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## Call123TestSpecialTags > Client Call123TestSpecialTags(ctx, client) + To test special tags To test special tags and operation ID starting with number diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/DefaultApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/DefaultApi.md index 4fd0ab98720..daf779c8e3e 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/DefaultApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/DefaultApi.md @@ -13,6 +13,7 @@ Method | HTTP request | Description > InlineResponseDefault FooGet(ctx, ) + ### Required Parameters This endpoint does not need any parameter. diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md index 0c11da8d772..3634a8771e2 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md @@ -24,6 +24,7 @@ Method | HTTP request | Description ## FakeHealthGet > HealthCheckResult FakeHealthGet(ctx, ) + Health check endpoint ### Required Parameters @@ -53,6 +54,7 @@ No authorization required > bool FakeOuterBooleanSerialize(ctx, optional) + Test serialization of outer boolean types ### Required Parameters @@ -95,6 +97,7 @@ No authorization required > OuterComposite FakeOuterCompositeSerialize(ctx, optional) + Test serialization of object with outer number type ### Required Parameters @@ -137,6 +140,7 @@ No authorization required > float32 FakeOuterNumberSerialize(ctx, optional) + Test serialization of outer number types ### Required Parameters @@ -179,6 +183,7 @@ No authorization required > string FakeOuterStringSerialize(ctx, optional) + Test serialization of outer string types ### Required Parameters @@ -221,6 +226,7 @@ No authorization required > TestBodyWithFileSchema(ctx, fileSchemaTestClass) + For this test, the body for this request much reference a schema named `File`. ### Required Parameters @@ -254,6 +260,7 @@ No authorization required > TestBodyWithQueryParams(ctx, query, user) + ### Required Parameters @@ -284,6 +291,7 @@ No authorization required ## TestClientModel > Client TestClientModel(ctx, client) + To test \"client\" model To test \"client\" model @@ -317,6 +325,7 @@ No authorization required ## TestEndpointParameters > TestEndpointParameters(ctx, number, double, patternWithoutDelimiter, byte_, optional) + Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -376,6 +385,7 @@ Name | Type | Description | Notes ## TestEnumParameters > TestEnumParameters(ctx, optional) + To test enum parameters To test enum parameters @@ -425,6 +435,7 @@ No authorization required ## TestGroupParameters > TestGroupParameters(ctx, requiredStringGroup, requiredBooleanGroup, requiredInt64Group, optional) + Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) @@ -475,6 +486,7 @@ Name | Type | Description | Notes ## TestInlineAdditionalProperties > TestInlineAdditionalProperties(ctx, requestBody) + test inline additionalProperties ### Required Parameters @@ -506,6 +518,7 @@ No authorization required ## TestJsonFormData > TestJsonFormData(ctx, param, param2) + test json serialization of form data ### Required Parameters @@ -540,6 +553,7 @@ No authorization required > TestQueryParameterCollectionFormat(ctx, pipe, ioutil, http, url, context) + To test the collection format in query parameters ### Required Parameters diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md index 5bf7b3bcc99..b070326cc32 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md @@ -11,6 +11,7 @@ Method | HTTP request | Description ## TestClassname > Client TestClassname(ctx, client) + To test class name in snake case To test class name in snake case diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md index c4f37589f0c..8118df7009b 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md @@ -19,6 +19,7 @@ Method | HTTP request | Description ## AddPet > AddPet(ctx, pet) + Add a new pet to the store ### Required Parameters @@ -50,6 +51,7 @@ Name | Type | Description | Notes ## DeletePet > DeletePet(ctx, petId, optional) + Deletes a pet ### Required Parameters @@ -92,6 +94,7 @@ Name | Type | Description | Notes ## FindPetsByStatus > []Pet FindPetsByStatus(ctx, status) + Finds Pets by status Multiple status values can be provided with comma separated strings @@ -125,6 +128,7 @@ Name | Type | Description | Notes ## FindPetsByTags > []Pet FindPetsByTags(ctx, tags) + Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. @@ -158,6 +162,7 @@ Name | Type | Description | Notes ## GetPetById > Pet GetPetById(ctx, petId) + Find pet by ID Returns a single pet @@ -191,6 +196,7 @@ Name | Type | Description | Notes ## UpdatePet > UpdatePet(ctx, pet) + Update an existing pet ### Required Parameters @@ -222,6 +228,7 @@ Name | Type | Description | Notes ## UpdatePetWithForm > UpdatePetWithForm(ctx, petId, optional) + Updates a pet in the store with form data ### Required Parameters @@ -265,6 +272,7 @@ Name | Type | Description | Notes ## UploadFile > ApiResponse UploadFile(ctx, petId, optional) + uploads an image ### Required Parameters @@ -308,6 +316,7 @@ Name | Type | Description | Notes ## UploadFileWithRequiredFile > ApiResponse UploadFileWithRequiredFile(ctx, petId, requiredFile, optional) + uploads an image (required) ### Required Parameters diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md index c7f9bbcee08..c24d87bbfd6 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md @@ -14,6 +14,7 @@ Method | HTTP request | Description ## DeleteOrder > DeleteOrder(ctx, orderId) + Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors @@ -47,6 +48,7 @@ No authorization required ## GetInventory > map[string]int32 GetInventory(ctx, ) + Returns pet inventories by status Returns a map of status codes to quantities @@ -76,6 +78,7 @@ This endpoint does not need any parameter. ## GetOrderById > Order GetOrderById(ctx, orderId) + Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions @@ -109,6 +112,7 @@ No authorization required ## PlaceOrder > Order PlaceOrder(ctx, order) + Place an order for a pet ### Required Parameters diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md index 6c443592e53..01d05d555cf 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description ## CreateUser > CreateUser(ctx, user) + Create user This can only be done by the logged in user. @@ -51,6 +52,7 @@ No authorization required ## CreateUsersWithArrayInput > CreateUsersWithArrayInput(ctx, user) + Creates list of users with given input array ### Required Parameters @@ -82,6 +84,7 @@ No authorization required ## CreateUsersWithListInput > CreateUsersWithListInput(ctx, user) + Creates list of users with given input array ### Required Parameters @@ -113,6 +116,7 @@ No authorization required ## DeleteUser > DeleteUser(ctx, username) + Delete user This can only be done by the logged in user. @@ -146,6 +150,7 @@ No authorization required ## GetUserByName > User GetUserByName(ctx, username) + Get user by user name ### Required Parameters @@ -177,6 +182,7 @@ No authorization required ## LoginUser > string LoginUser(ctx, username, password) + Logs user into the system ### Required Parameters @@ -209,6 +215,7 @@ No authorization required ## LogoutUser > LogoutUser(ctx, ) + Logs out current logged in user session ### Required Parameters @@ -236,6 +243,7 @@ No authorization required ## UpdateUser > UpdateUser(ctx, username, user) + Updated user This can only be done by the logged in user.