add documentations to r oneof, anyof (#12638)

.gitignore

@@ -222,6 +222,8 @@ samples/server/petstore/haskell-yesod/stack.yaml.lock
 .Rproj.user
 samples/client/petstore/R/**/petstore.Rcheck/
 samples/client/petstore/R/**/*.tar.gz
+samples/client/petstore/R/R.Rproj
+samples/client/petstore/R/man/
 
 # elixir
 samples/client/petstore/elixir/_build/

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

@@ -11,14 +11,31 @@
 {{classname}} <- R6::R6Class(
   '{{classname}}',
   public = list(
+    #' @field actual_instance the object stored in this instance.
     actual_instance = NULL,
+    #' @field actual_type the type of the object stored in this instance.
     actual_type = NULL,
+    #' @field any_of  a list of object types defined in the anyOf schema.
     any_of = list({{#anyOf}}"{{{.}}}"{{^-last}}, {{/-last}}{{/anyOf}}),
+    #' Initialize a new {{{classname}}}.
+    #'
+    #' @description
+    #' Initialize a new {{{classname}}}.
+    #'
+    #' @export
+    #' @md
     initialize = function(
-        {{#requiredVars}}`{{baseName}}`, {{/requiredVars}}{{#optionalVars}}`{{baseName}}`={{{defaultValue}}}{{^defaultValue}}NULL{{/defaultValue}}, {{/optionalVars}}...
     ) {
-      local_optional_var <- list(...)
     },
+    #' Deserialize JSON string into an instance of {{{classname}}}.
+    #'
+    #' @description
+    #' Deserialize JSON string into an instance of {{{classname}}}.
+    #'
+    #' @param input The input JSON.
+    #' @return An instance of {{{classname}}}.
+    #' @export
+    #' @md
     fromJSON = function(input) {
       error_messages <- list()
 
@@ -41,6 +58,14 @@
       # no match
       stop(paste("No match found when deserializing the payload into {{{classname}}} with anyOf schemas {{#anyOf}}{{{.}}}{{^-last}}, {{/-last}}{{/anyOf}}. Details: ", paste(error_messages, collapse = ', ')))
     },
+    #' Serialize {{{classname}}} to JSON string.
+    #'
+    #' @description
+    #' Serialize {{{classname}}} to JSON string.
+    #'
+    #' @return JSON string reprenation of the {{{classname}}}.
+    #' @export
+    #' @md
     toJSON = function() {
       if (!is.null(self$actual_instance)) {
         self$actual_instance$toJSONString()
@@ -48,6 +73,15 @@
         NULL
       }
     },
+    #' Validate the input JSON with respect to {{{classname}}}.
+    #'
+    #' @description
+    #' Validate the input JSON with respect to {{{classname}}} and
+    #' throw exception if invalid.
+    #'
+    #' @param input The input JSON.
+    #' @export
+    #' @md
     validateJSON = function(input) {
       # backup current values
       actual_instance_bak <- self$actual_instance

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

@@ -11,14 +11,30 @@
 {{classname}} <- R6::R6Class(
   '{{classname}}',
   public = list(
+    #' @field actual_instance the object stored in this instance.
     actual_instance = NULL,
+    #' @field actual_type the type of the object stored in this instance.
     actual_type = NULL,
+    #' @field one_of  a list of object types defined in the oneOf schema.
     one_of = list({{#oneOf}}"{{{.}}}"{{^-last}}, {{/-last}}{{/oneOf}}),
-    initialize = function(
+    #' Initialize a new {{{classname}}}.
-        {{#requiredVars}}`{{baseName}}`, {{/requiredVars}}{{#optionalVars}}`{{baseName}}`={{{defaultValue}}}{{^defaultValue}}NULL{{/defaultValue}}, {{/optionalVars}}...
+    #'
-    ) {
+    #' @description
-      local_optional_var <- list(...)
+    #' Initialize a new {{{classname}}}.
+    #'
+    #' @export
+    #' @md
+    initialize = function() {
     },
+    #' Deserialize JSON string into an instance of {{{classname}}}.
+    #'
+    #' @description
+    #' Deserialize JSON string into an instance of {{{classname}}}.
+    #'
+    #' @param input The input JSON.
+    #' @return An instance of {{{classname}}}.
+    #' @export
+    #' @md
     fromJSON = function(input) {
       matched <- 0 # match counter
       matched_schemas <- list() #names of matched schemas
@@ -56,6 +72,14 @@
 
       self
     },
+    #' Serialize {{{classname}}} to JSON string.
+    #'
+    #' @description
+    #' Serialize {{{classname}}} to JSON string.
+    #'
+    #' @return JSON string reprenation of the {{{classname}}}.
+    #' @export
+    #' @md
     toJSON = function() {
       if (!is.null(self$actual_instance)) {
         self$actual_instance$toJSONString()
@@ -63,6 +87,15 @@
         NULL
       }
     },
+    #' Validate the input JSON with respect to {{{classname}}}.
+    #'
+    #' @description
+    #' Validate the input JSON with respect to {{{classname}}} and
+    #' throw exception if invalid.
+    #'
+    #' @param input The input JSON.
+    #' @export
+    #' @md
     validateJSON = function(input) {
       # backup current values
       actual_instance_bak <- self$actual_instance

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

@@ -1,15 +1,16 @@
 {{#appName}}
-# {{{.}}}
+#' {{{.}}}
-#
+#'
 {{/appName}}
 {{#appDescription}}
-# {{{.}}}
+#' {{{.}}}
-#
+#'
 {{/appDescription}}
 {{#version}}
-# The version of the OpenAPI document: {{{.}}}
+#' The version of the OpenAPI document: {{{.}}}
 {{/version}}
 {{#infoEmail}}
-# Contact: {{{.}}}
+#' Contact: {{{.}}}
 {{/infoEmail}}
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'

samples/client/petstore/R/R/allof_tag_api_response.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title AllofTagApiResponse

samples/client/petstore/R/R/animal.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Animal

samples/client/petstore/R/R/any_of_pig.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title AnyOfPig
@@ -18,14 +19,31 @@
 AnyOfPig <- R6::R6Class(
   'AnyOfPig',
   public = list(
+    #' @field actual_instance the object stored in this instance.
     actual_instance = NULL,
+    #' @field actual_type the type of the object stored in this instance.
     actual_type = NULL,
+    #' @field any_of  a list of object types defined in the anyOf schema.
     any_of = list("BasquePig", "DanishPig"),
+    #' Initialize a new AnyOfPig.
+    #'
+    #' @description
+    #' Initialize a new AnyOfPig.
+    #'
+    #' @export
+    #' @md
     initialize = function(
-        `className`, `color`, `size`, ...
     ) {
-      local_optional_var <- list(...)
     },
+    #' Deserialize JSON string into an instance of AnyOfPig.
+    #'
+    #' @description
+    #' Deserialize JSON string into an instance of AnyOfPig.
+    #'
+    #' @param input The input JSON.
+    #' @return An instance of AnyOfPig.
+    #' @export
+    #' @md
     fromJSON = function(input) {
       error_messages <- list()
 
@@ -60,6 +78,14 @@ AnyOfPig <- R6::R6Class(
       # no match
       stop(paste("No match found when deserializing the payload into AnyOfPig with anyOf schemas BasquePig, DanishPig. Details: ", paste(error_messages, collapse = ', ')))
     },
+    #' Serialize AnyOfPig to JSON string.
+    #'
+    #' @description
+    #' Serialize AnyOfPig to JSON string.
+    #'
+    #' @return JSON string reprenation of the AnyOfPig.
+    #' @export
+    #' @md
     toJSON = function() {
       if (!is.null(self$actual_instance)) {
         self$actual_instance$toJSONString()
@@ -67,6 +93,15 @@ AnyOfPig <- R6::R6Class(
         NULL
       }
     },
+    #' Validate the input JSON with respect to AnyOfPig.
+    #'
+    #' @description
+    #' Validate the input JSON with respect to AnyOfPig and
+    #' throw exception if invalid.
+    #'
+    #' @param input The input JSON.
+    #' @export
+    #' @md
     validateJSON = function(input) {
       # backup current values
       actual_instance_bak <- self$actual_instance

samples/client/petstore/R/R/api_client.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 
 #' ApiClient Class

samples/client/petstore/R/R/basque_pig.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title BasquePig

samples/client/petstore/R/R/cat.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Cat

samples/client/petstore/R/R/cat_all_of.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title CatAllOf

samples/client/petstore/R/R/category.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Category

samples/client/petstore/R/R/danish_pig.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title DanishPig

samples/client/petstore/R/R/dog.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Dog

samples/client/petstore/R/R/dog_all_of.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title DogAllOf

samples/client/petstore/R/R/fake_api.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Fake operations

samples/client/petstore/R/R/model_api_response.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title ModelApiResponse

samples/client/petstore/R/R/order.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Order

samples/client/petstore/R/R/pet.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Pet

samples/client/petstore/R/R/pet_api.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Pet operations

samples/client/petstore/R/R/pig.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Pig
@@ -18,14 +19,30 @@
 Pig <- R6::R6Class(
   'Pig',
   public = list(
+    #' @field actual_instance the object stored in this instance.
     actual_instance = NULL,
+    #' @field actual_type the type of the object stored in this instance.
     actual_type = NULL,
+    #' @field one_of  a list of object types defined in the oneOf schema.
     one_of = list("BasquePig", "DanishPig"),
-    initialize = function(
+    #' Initialize a new Pig.
-        `className`, `color`, `size`, ...
+    #'
-    ) {
+    #' @description
-      local_optional_var <- list(...)
+    #' Initialize a new Pig.
+    #'
+    #' @export
+    #' @md
+    initialize = function() {
     },
+    #' Deserialize JSON string into an instance of Pig.
+    #'
+    #' @description
+    #' Deserialize JSON string into an instance of Pig.
+    #'
+    #' @param input The input JSON.
+    #' @return An instance of Pig.
+    #' @export
+    #' @md
     fromJSON = function(input) {
       matched <- 0 # match counter
       matched_schemas <- list() #names of matched schemas
@@ -76,6 +93,14 @@ Pig <- R6::R6Class(
 
       self
     },
+    #' Serialize Pig to JSON string.
+    #'
+    #' @description
+    #' Serialize Pig to JSON string.
+    #'
+    #' @return JSON string reprenation of the Pig.
+    #' @export
+    #' @md
     toJSON = function() {
       if (!is.null(self$actual_instance)) {
         self$actual_instance$toJSONString()
@@ -83,6 +108,15 @@ Pig <- R6::R6Class(
         NULL
       }
     },
+    #' Validate the input JSON with respect to Pig.
+    #'
+    #' @description
+    #' Validate the input JSON with respect to Pig and
+    #' throw exception if invalid.
+    #'
+    #' @param input The input JSON.
+    #' @export
+    #' @md
     validateJSON = function(input) {
       # backup current values
       actual_instance_bak <- self$actual_instance

samples/client/petstore/R/R/store_api.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Store operations

samples/client/petstore/R/R/tag.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title Tag

samples/client/petstore/R/R/update_pet_request.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title UpdatePetRequest

samples/client/petstore/R/R/user.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title User

samples/client/petstore/R/R/user_api.R

@@ -1,9 +1,10 @@
-# OpenAPI Petstore
+#' OpenAPI Petstore
-#
+#'
-# This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
+#' This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters.
-#
+#'
-# The version of the OpenAPI document: 1.0.0
+#' The version of the OpenAPI document: 1.0.0
-# Generated by: https://openapi-generator.tech
+#' Generated by: https://openapi-generator.tech
+#'
 
 #' @docType class
 #' @title User operations

samples/client/petstore/R/build_and_test.bash

@@ -17,6 +17,7 @@ Rscript -e "install.packages('R6', repos='$REPO', lib='$R_LIBS_USER')"
 Rscript -e "install.packages('base64enc', repos='$REPO', lib='$R_LIBS_USER')"
 Rscript -e "install.packages('rlang', repos='$REPO', lib='$R_LIBS_USER')"
 Rscript -e "install.packages('rjson', repos='$REPO', lib='$R_LIBS_USER')"
+Rscript -e "install.packages('devtools', repos='$REPO', lib='$R_LIBS_USER')"
 
 rm petstore_1.0.0.tar.gz || true