From 3082eda27eabe61201c6c81a2ecf7de1b94f2fb5 Mon Sep 17 00:00:00 2001 From: Sai Giridhar P Date: Wed, 30 Oct 2019 14:36:39 +0530 Subject: [PATCH] [r][documentation]: Adding model summary to model documentation files. (#4310) * feat(documentation): Adding model documentation * feat(documentation): Adding model documentation --- .../openapi-generator/src/main/resources/r/model_doc.mustache | 2 ++ samples/client/petstore/R/docs/Category.md | 1 + samples/client/petstore/R/docs/ModelApiResponse.md | 1 + samples/client/petstore/R/docs/Order.md | 1 + samples/client/petstore/R/docs/Pet.md | 1 + samples/client/petstore/R/docs/Tag.md | 1 + samples/client/petstore/R/docs/User.md | 1 + 7 files changed, 8 insertions(+) diff --git a/modules/openapi-generator/src/main/resources/r/model_doc.mustache b/modules/openapi-generator/src/main/resources/r/model_doc.mustache index e24917d02d7..e4b193b58ce 100644 --- a/modules/openapi-generator/src/main/resources/r/model_doc.mustache +++ b/modules/openapi-generator/src/main/resources/r/model_doc.mustache @@ -1,5 +1,7 @@ {{#models}}{{#model}}# {{packageName}}::{{classname}} +{{#description}}{{description}} +{{/description}} ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/Category.md b/samples/client/petstore/R/docs/Category.md index 700ed1c4c08..93c2a721137 100644 --- a/samples/client/petstore/R/docs/Category.md +++ b/samples/client/petstore/R/docs/Category.md @@ -1,5 +1,6 @@ # petstore::Category +A category for a pet ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/ModelApiResponse.md b/samples/client/petstore/R/docs/ModelApiResponse.md index d6ccac8474f..4b53ceb4137 100644 --- a/samples/client/petstore/R/docs/ModelApiResponse.md +++ b/samples/client/petstore/R/docs/ModelApiResponse.md @@ -1,5 +1,6 @@ # petstore::ModelApiResponse +Describes the result of uploading an image resource ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/Order.md b/samples/client/petstore/R/docs/Order.md index a72ecf21ee8..76398d1ef10 100644 --- a/samples/client/petstore/R/docs/Order.md +++ b/samples/client/petstore/R/docs/Order.md @@ -1,5 +1,6 @@ # petstore::Order +An order for a pets from the pet store ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/Pet.md b/samples/client/petstore/R/docs/Pet.md index f5a9c0dd611..92ed51c801f 100644 --- a/samples/client/petstore/R/docs/Pet.md +++ b/samples/client/petstore/R/docs/Pet.md @@ -1,5 +1,6 @@ # petstore::Pet +A pet for sale in the pet store ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/Tag.md b/samples/client/petstore/R/docs/Tag.md index 1a5a1e82c95..595279123e1 100644 --- a/samples/client/petstore/R/docs/Tag.md +++ b/samples/client/petstore/R/docs/Tag.md @@ -1,5 +1,6 @@ # petstore::Tag +A tag for a pet ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/R/docs/User.md b/samples/client/petstore/R/docs/User.md index 072efdfc2ac..8d04bdd9d34 100644 --- a/samples/client/petstore/R/docs/User.md +++ b/samples/client/petstore/R/docs/User.md @@ -1,5 +1,6 @@ # petstore::User +A User who is purchasing from the pet store ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | -------------