Skip to content

Commit de2753d

Browse files
authored
[markdown] Fix broken links when generating markdown (#5569)
* [markdown] Fix broken links when generating markdown The `api.mustache` file generates links to the markdown model files. These links were previously brokeen. Additionally, the defaultPackage for markdown is "/Models", so this looked pretty in the heading for model files. So this prefix has been stripped from the header in `model.mustache`. * Re-generate Petstore samples for markdown
1 parent b1aecad commit de2753d

File tree

11 files changed

+25
-25
lines changed

11 files changed

+25
-25
lines changed

modules/openapi-generator/src/main/resources/markdown-documentation/README.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Class | Method | HTTP request | Description
1717
## Documentation for Models
1818

1919
{{#modelPackage}}
20-
{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
20+
{{#models}}{{#model}} - [{{{classname}}}](./{{{modelPackage}}}/{{modelDocPath}}{{{classname}}}.md)
2121
{{/model}}{{/models}}
2222
{{/modelPackage}}
2323
{{^modelPackage}}

modules/openapi-generator/src/main/resources/markdown-documentation/api.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ Method | HTTP request | Description
2222
{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
2323
Name | Type | Description | Notes
2424
------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
25-
{{#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}}
25+
{{#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}}
2626
{{/allParams}}
2727

2828
### Return type
2929

30-
{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{modelPackage}}/{{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
30+
{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**](../{{modelPackage}}/{{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
3131

3232
### Authorization
3333

modules/openapi-generator/src/main/resources/markdown-documentation/model.mustache

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{{#models}}
22
{{#model}}
3-
# {{{packageName}}}.{{modelPackage}}.{{{classname}}}
3+
# {{{classname}}}
44
## Properties
55

66
Name | Type | Description | Notes
@@ -16,4 +16,4 @@ Name | Type | Description | Notes
1616
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1717

1818
{{/model}}
19-
{{/models}}
19+
{{/models}}

samples/documentation/markdown/Apis/PetApi.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Add a new pet to the store
2424

2525
Name | Type | Description | Notes
2626
------------- | ------------- | ------------- | -------------
27-
**body** | [**Pet**](/Models/Pet.md)| Pet object that needs to be added to the store |
27+
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
2828

2929
### Return type
3030

@@ -77,11 +77,11 @@ Finds Pets by status
7777

7878
Name | Type | Description | Notes
7979
------------- | ------------- | ------------- | -------------
80-
**status** | [**List**](/Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold]
80+
**status** | [**List**](..//Models/String.md)| Status values that need to be considered for filter | [default to null] [enum: available, pending, sold]
8181

8282
### Return type
8383

84-
[**List**](/Models/Pet.md)
84+
[**List**](..//Models/Pet.md)
8585

8686
### Authorization
8787

@@ -104,11 +104,11 @@ Finds Pets by tags
104104

105105
Name | Type | Description | Notes
106106
------------- | ------------- | ------------- | -------------
107-
**tags** | [**List**](/Models/String.md)| Tags to filter by | [default to null]
107+
**tags** | [**List**](..//Models/String.md)| Tags to filter by | [default to null]
108108

109109
### Return type
110110

111-
[**List**](/Models/Pet.md)
111+
[**List**](..//Models/Pet.md)
112112

113113
### Authorization
114114

@@ -135,7 +135,7 @@ Name | Type | Description | Notes
135135

136136
### Return type
137137

138-
[**Pet**](/Models/Pet.md)
138+
[**Pet**](..//Models/Pet.md)
139139

140140
### Authorization
141141

@@ -156,7 +156,7 @@ Update an existing pet
156156

157157
Name | Type | Description | Notes
158158
------------- | ------------- | ------------- | -------------
159-
**body** | [**Pet**](/Models/Pet.md)| Pet object that needs to be added to the store |
159+
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
160160

161161
### Return type
162162

@@ -214,7 +214,7 @@ Name | Type | Description | Notes
214214

215215
### Return type
216216

217-
[**ApiResponse**](/Models/ApiResponse.md)
217+
[**ApiResponse**](..//Models/ApiResponse.md)
218218

219219
### Authorization
220220

samples/documentation/markdown/Models/ApiResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.ApiResponse
1+
# ApiResponse
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/Models/Category.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.Category
1+
# Category
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/Models/Order.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.Order
1+
# Order
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/Models/Pet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.Pet
1+
# Pet
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/Models/Tag.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.Tag
1+
# Tag
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/Models/User.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ./Models.User
1+
# User
22
## Properties
33

44
Name | Type | Description | Notes

samples/documentation/markdown/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Class | Method | HTTP request | Description
3232
<a name="documentation-for-models"></a>
3333
## Documentation for Models
3434

35-
- [/Models.ApiResponse](Models/ApiResponse.md)
36-
- [/Models.Category](Models/Category.md)
37-
- [/Models.Order](Models/Order.md)
38-
- [/Models.Pet](Models/Pet.md)
39-
- [/Models.Tag](Models/Tag.md)
40-
- [/Models.User](Models/User.md)
35+
- [ApiResponse](.//Models/ApiResponse.md)
36+
- [Category](.//Models/Category.md)
37+
- [Order](.//Models/Order.md)
38+
- [Pet](.//Models/Pet.md)
39+
- [Tag](.//Models/Tag.md)
40+
- [User](.//Models/User.md)
4141

4242

4343
<a name="documentation-for-authorization"></a>

0 commit comments

Comments
 (0)