Skip to content

Commit 3082eda

Browse files
saigiridhar21wing328
authored andcommitted
[r][documentation]: Adding model summary to model documentation files. (#4310)
* feat(documentation): Adding model documentation * feat(documentation): Adding model documentation
1 parent eaca7b8 commit 3082eda

7 files changed

Lines changed: 8 additions & 0 deletions

File tree

modules/openapi-generator/src/main/resources/r/model_doc.mustache

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{{#models}}{{#model}}# {{packageName}}::{{classname}}
22

3+
{{#description}}{{description}}
4+
{{/description}}
35
## Properties
46
Name | Type | Description | Notes
57
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/Category.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::Category
22

3+
A category for a pet
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/ModelApiResponse.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::ModelApiResponse
22

3+
Describes the result of uploading an image resource
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/Order.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::Order
22

3+
An order for a pets from the pet store
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/Pet.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::Pet
22

3+
A pet for sale in the pet store
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/Tag.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::Tag
22

3+
A tag for a pet
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

samples/client/petstore/R/docs/User.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# petstore::User
22

3+
A User who is purchasing from the pet store
34
## Properties
45
Name | Type | Description | Notes
56
------------ | ------------- | ------------- | -------------

0 commit comments

Comments
 (0)