loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-07-08 16:40:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

[BUG][MARKDOWN] Extra (back)slashes added to links from Api to Model #6095 (#6834)

Browse Source 
Co-authored-by: Jim Schubert <james.schubert@gmail.com>
This commit is contained in:
Mohamed EL HABIB 2020-08-24 06:13:17 +02:00 committed by GitHub
parent 029fd669e5
commit c893b92775
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/MarkdownDocumentationCodegen.java
View File

@ -16,7 +16,7 @@ import static org.openapitools.codegen.utils.StringUtils.escape;
public class MarkdownDocumentationCodegen extends DefaultCodegen implements CodegenConfig {
public static final String PROJECT_NAME = "projectName";
static Logger LOGGER = LoggerFactory.getLogger(MarkdownDocumentationCodegen.class);
private static final Logger LOGGER = LoggerFactory.getLogger(MarkdownDocumentationCodegen.class);
public CodegenType getTag() {
return CodegenType.DOCUMENTATION;
@ -42,7 +42,7 @@ public class MarkdownDocumentationCodegen extends DefaultCodegen implements Code
apiTemplateFiles.put("api.mustache", ".md");
embeddedTemplateDir = templateDir = "markdown-documentation";
apiPackage = File.separator + "Apis";
modelPackage = File.separator + "Models";
modelPackage = "Models";
supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
// TODO: Fill this out.
}

20
samples/documentation/markdown/Apis/PetApi.md
View File

@ -24,11 +24,11 @@ Add a new pet to the store
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
[**Pet**](..//Models/Pet.md)
[**Pet**](../Models/Pet.md)
### Authorization
@ -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,11 +156,11 @@ Update an existing pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**Pet** | [**Pet**](../Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
[**Pet**](..//Models/Pet.md)
[**Pet**](../Models/Pet.md)
### Authorization
@ -214,7 +214,7 @@ Name | Type | Description | Notes
### Return type
[**ApiResponse**](..//Models/ApiResponse.md)
[**ApiResponse**](../Models/ApiResponse.md)
### Authorization

8
samples/documentation/markdown/Apis/StoreApi.md
View File

@ -50,7 +50,7 @@ This endpoint does not need any parameter.
### Return type
[**Map**](..//Models/integer.md)
[**Map**](../Models/integer.md)
### Authorization
@ -77,7 +77,7 @@ Name | Type | Description | Notes
### Return type
[**Order**](..//Models/Order.md)
[**Order**](../Models/Order.md)
### Authorization
@ -98,11 +98,11 @@ Place an order for a pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**Order** | [**Order**](..//Models/Order.md)| order placed for purchasing the pet |
**Order** | [**Order**](../Models/Order.md)| order placed for purchasing the pet |
### Return type
[**Order**](..//Models/Order.md)
[**Order**](../Models/Order.md)
### Authorization

12
samples/documentation/markdown/Apis/UserApi.md
View File

@ -26,7 +26,7 @@ Create user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**User**](..//Models/User.md)| Created user object |
**User** | [**User**](../Models/User.md)| Created user object |
### Return type
@ -51,7 +51,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**List**](..//Models/User.md)| List of user object |
**User** | [**List**](../Models/User.md)| List of user object |
### Return type
@ -76,7 +76,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**User** | [**List**](..//Models/User.md)| List of user object |
**User** | [**List**](../Models/User.md)| List of user object |
### Return type
@ -132,7 +132,7 @@ Name | Type | Description | Notes
### Return type
[**User**](..//Models/User.md)
[**User**](../Models/User.md)
### Authorization
@ -158,7 +158,7 @@ Name | Type | Description | Notes
### Return type
[**String**](..//Models/string.md)
[**String**](../Models/string.md)
### Authorization
@ -204,7 +204,7 @@ Updated user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted | [default to null]
**User** | [**User**](..//Models/User.md)| Updated user object |
**User** | [**User**](../Models/User.md)| Updated user object |
### Return type

16
samples/documentation/markdown/README.md
View File

@ -32,14 +32,14 @@ Class | Method | HTTP request | Description
<a name="documentation-for-models"></a>
## Documentation for Models
- [ApiResponse](.//Models/ApiResponse.md)
- [Category](.//Models/Category.md)
- [InlineObject](.//Models/InlineObject.md)
- [InlineObject1](.//Models/InlineObject1.md)
- [Order](.//Models/Order.md)
- [Pet](.//Models/Pet.md)
- [Tag](.//Models/Tag.md)
- [User](.//Models/User.md)
- [ApiResponse](./Models/ApiResponse.md)
- [Category](./Models/Category.md)
- [InlineObject](./Models/InlineObject.md)
- [InlineObject1](./Models/InlineObject1.md)
- [Order](./Models/Order.md)
- [Pet](./Models/Pet.md)
- [Tag](./Models/Tag.md)
- [User](./Models/User.md)
<a name="documentation-for-authorization"></a>