Skip to content

Commit

Permalink
Merge pull request #24 from bergant/cran_updates
Browse files Browse the repository at this point in the history
resolve NOTES for CRAN
  • Loading branch information
bergant authored Apr 23, 2024
2 parents a14947c + 9afbfa4 commit 623003d
Show file tree
Hide file tree
Showing 13 changed files with 49 additions and 26 deletions.
14 changes: 9 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,24 @@ Package: rapiclient
Type: Package
Title: Dynamic OpenAPI/Swagger Client
Version: 0.1.3
Authors@R: person("Darko", "Bergant", email = "[email protected]",
role = c("aut", "cre"))
Authors@R: c(
person("Darko", "Bergant", , "[email protected]", c("aut", "cre")),
person("Marcel", "Ramos", , , "ctb"),
person("Sean", "Davis", , , "ctb"),
person("Martin", "Morgan", , , "ctb")
)
URL: https://github.com/bergant/rapiclient
BugReports: https://github.com/bergant/rapiclient/issues
Description: Access services specified in OpenAPI (formerly Swagger) format.
It is not a code generator. Client is generated dynamically as a list of R
functions.
Depends:
R (>= 3.3)
R (>= 3.3.0)
License: MIT + file LICENSE
Imports:
jsonlite,
httr,
yaml
LazyData: TRUE
RoxygenNote: 6.1.1
Encoding: UTF-8
RoxygenNote: 7.3.1
Suggests: testthat
5 changes: 2 additions & 3 deletions R/operations.R
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ get_api <- function(url, config = NULL) {
#' Operations are parsed from `paths`` element for every path and every action
#' inside path. Operation name is set to `operationId` from each action.
#'
#' See also specification \url{http://swagger.io/specification/#operationObject}
#' See also specification \url{https://swagger.io/specification/#operationObject}
#'
#' @param api API object
#' @param path (optional) filter by path
Expand All @@ -123,7 +123,7 @@ get_operation_definitions <- function(api, path = NULL) {

# parameters can be defined on path level and overridden on operation
# level
#
#
# Note that parameters is often a list() rather than NULL, so deal
# that situation as well.
if(is.null(operation$parameters) || length(operation$parameters)==0) {
Expand Down Expand Up @@ -480,7 +480,6 @@ build_op_url <- function(api, scheme, host, base_path, op_def, par_values) {
#' Extract all parameters from parameters definition as a list
#' In case of reference to schema, use the schema.
#' @param api API definition
#' @param parameters_def A parameters from API operations definition
#' @keywords internal
get_parameters <- function(api, api_parameters) {
parameters <- get_parameters_definition(api, api_parameters)
Expand Down
6 changes: 3 additions & 3 deletions R/print.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ print_wrap <- function(text, ...) {
#' Print API object
#'
#' @param x API object
#' @param ...further arguments passed to or from other methods
#' @param ... further arguments passed to or from other methods
#' @export
#' @keywords internal
print.rapi_api <- function(x, ...) {
Expand All @@ -34,7 +34,7 @@ print.rapi_api <- function(x, ...) {
#' Print Operation
#'
#' @param x Operation
#' @param ...further arguments passed to or from other methods
#' @param ... further arguments passed to or from other methods
#' @export
#' @keywords internal
print.rapi_operation <- function(x, ...) {
Expand Down Expand Up @@ -111,7 +111,7 @@ print.rapi_operation <- function(x, ...) {
#' Print Operation
#'
#' @param x Operation
#' @param ...further arguments passed to or from other methods
#' @param ... further arguments passed to or from other methods
#' @export
#' @keywords internal
print.rapi_schema_function <- function(x, ...) {
Expand Down
3 changes: 1 addition & 2 deletions R/rapiclient.R
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,9 @@
#'
#' Please use \url{https://github.com/bergant/rapiclient/issues} for issues
#'
#' @docType package
#' @name rapiclient-package
#' @aliases rapiclient
NULL
"_PACKAGE"



2 changes: 1 addition & 1 deletion man/get_operation_definitions.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions man/get_operations.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions man/get_parameters.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions man/get_schema_graphviz_dot.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/print.rapi_api.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/print.rapi_operation.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/print.rapi_schema_function.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions man/rapiclient-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions man/result_handlers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 623003d

Please sign in to comment.