diff --git a/modules/openapi-generator/src/main/resources/markdown-documentation/README.mustache b/modules/openapi-generator/src/main/resources/markdown-documentation/README.mustache index 365e5e84fd2..221d4925576 100644 --- a/modules/openapi-generator/src/main/resources/markdown-documentation/README.mustache +++ b/modules/openapi-generator/src/main/resources/markdown-documentation/README.mustache @@ -17,7 +17,7 @@ Class | Method | HTTP request | Description ## Documentation for Models {{#modelPackage}} -{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md) +{{#models}}{{#model}} - [{{{classname}}}](./{{{modelPackage}}}/{{modelDocPath}}{{{classname}}}.md) {{/model}}{{/models}} {{/modelPackage}} {{^modelPackage}} diff --git a/modules/openapi-generator/src/main/resources/markdown-documentation/api.mustache b/modules/openapi-generator/src/main/resources/markdown-documentation/api.mustache index 725f3fd5688..3e245d37da4 100644 --- a/modules/openapi-generator/src/main/resources/markdown-documentation/api.mustache +++ b/modules/openapi-generator/src/main/resources/markdown-documentation/api.mustache @@ -22,12 +22,12 @@ Method | HTTP request | Description {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}} Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}} -{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{modelPackage}}/{{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}} +{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**](../{{modelPackage}}/{{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}} {{/allParams}} ### Return type -{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{modelPackage}}/{{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}} +{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**](../{{modelPackage}}/{{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}} ### Authorization diff --git a/modules/openapi-generator/src/main/resources/markdown-documentation/model.mustache b/modules/openapi-generator/src/main/resources/markdown-documentation/model.mustache index cee30af8aef..bffd1508f62 100644 --- a/modules/openapi-generator/src/main/resources/markdown-documentation/model.mustache +++ b/modules/openapi-generator/src/main/resources/markdown-documentation/model.mustache @@ -1,6 +1,6 @@ {{#models}} {{#model}} -# {{{packageName}}}.{{modelPackage}}.{{{classname}}} +# {{{classname}}} ## Properties Name | Type | Description | Notes @@ -16,4 +16,4 @@ Name | Type | Description | Notes [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) {{/model}} -{{/models}} \ No newline at end of file +{{/models}} diff --git a/samples/documentation/markdown/Apis/PetApi.md b/samples/documentation/markdown/Apis/PetApi.md index aef17fbd12f..591d7c0d312 100644 --- a/samples/documentation/markdown/Apis/PetApi.md +++ b/samples/documentation/markdown/Apis/PetApi.md @@ -24,7 +24,7 @@ Add a new pet to the store Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](/Models/Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store | ### Return type @@ -77,11 +77,11 @@ Finds Pets by status Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **status** | [**List**](/Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold] + **status** | [**List**](..//Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold] ### Return type -[**List**](/Models/Pet.md) +[**List**](..//Models/Pet.md) ### Authorization @@ -104,11 +104,11 @@ Finds Pets by tags Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tags** | [**List**](/Models/String.md)| Tags to filter by | [default to null] + **tags** | [**List**](..//Models/String.md)| Tags to filter by | [default to null] ### Return type -[**List**](/Models/Pet.md) +[**List**](..//Models/Pet.md) ### Authorization @@ -135,7 +135,7 @@ Name | Type | Description | Notes ### Return type -[**Pet**](/Models/Pet.md) +[**Pet**](..//Models/Pet.md) ### Authorization @@ -156,7 +156,7 @@ Update an existing pet Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **body** | [**Pet**](/Models/Pet.md)| Pet object that needs to be added to the store | + **body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store | ### Return type @@ -214,7 +214,7 @@ Name | Type | Description | Notes ### Return type -[**ApiResponse**](/Models/ApiResponse.md) +[**ApiResponse**](..//Models/ApiResponse.md) ### Authorization diff --git a/samples/documentation/markdown/Models/ApiResponse.md b/samples/documentation/markdown/Models/ApiResponse.md index 1fc3546ce76..b71399acbfd 100644 --- a/samples/documentation/markdown/Models/ApiResponse.md +++ b/samples/documentation/markdown/Models/ApiResponse.md @@ -1,4 +1,4 @@ -# ./Models.ApiResponse +# ApiResponse ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/Models/Category.md b/samples/documentation/markdown/Models/Category.md index 7dfffafdfc6..4c5a23ddc6d 100644 --- a/samples/documentation/markdown/Models/Category.md +++ b/samples/documentation/markdown/Models/Category.md @@ -1,4 +1,4 @@ -# ./Models.Category +# Category ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/Models/Order.md b/samples/documentation/markdown/Models/Order.md index 1b982b995ea..1aa5a35d84d 100644 --- a/samples/documentation/markdown/Models/Order.md +++ b/samples/documentation/markdown/Models/Order.md @@ -1,4 +1,4 @@ -# ./Models.Order +# Order ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/Models/Pet.md b/samples/documentation/markdown/Models/Pet.md index 88378fd5169..d00d70ef39e 100644 --- a/samples/documentation/markdown/Models/Pet.md +++ b/samples/documentation/markdown/Models/Pet.md @@ -1,4 +1,4 @@ -# ./Models.Pet +# Pet ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/Models/Tag.md b/samples/documentation/markdown/Models/Tag.md index d13aa870a5a..07bd207ed3f 100644 --- a/samples/documentation/markdown/Models/Tag.md +++ b/samples/documentation/markdown/Models/Tag.md @@ -1,4 +1,4 @@ -# ./Models.Tag +# Tag ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/Models/User.md b/samples/documentation/markdown/Models/User.md index 5af4e8e1724..8fe2d5041cb 100644 --- a/samples/documentation/markdown/Models/User.md +++ b/samples/documentation/markdown/Models/User.md @@ -1,4 +1,4 @@ -# ./Models.User +# User ## Properties Name | Type | Description | Notes diff --git a/samples/documentation/markdown/README.md b/samples/documentation/markdown/README.md index 2e0854ed92a..980ad226ca0 100644 --- a/samples/documentation/markdown/README.md +++ b/samples/documentation/markdown/README.md @@ -32,12 +32,12 @@ Class | Method | HTTP request | Description ## Documentation for Models - - [/Models.ApiResponse](Models/ApiResponse.md) - - [/Models.Category](Models/Category.md) - - [/Models.Order](Models/Order.md) - - [/Models.Pet](Models/Pet.md) - - [/Models.Tag](Models/Tag.md) - - [/Models.User](Models/User.md) + - [ApiResponse](.//Models/ApiResponse.md) + - [Category](.//Models/Category.md) + - [Order](.//Models/Order.md) + - [Pet](.//Models/Pet.md) + - [Tag](.//Models/Tag.md) + - [User](.//Models/User.md)