getMethodsInfo: getMethodsInfo

In agpknitweardesign/festotuAPIs:

Description

Get information of the methods of some API

Usage

getMethodsInfo(
  pattern = ".",
  http_method = ".",
  visibility = ".",
  attributes = NULL,
  api = "etsy",
  ...
)

Arguments

pattern	Character string containing a regular expression to be matched in the methods names of api.
http_method	Character string. Optional parameter to filter response to certain http methods (eg: GET). Regular expression.
visibility	Character string. Optional parameter to filter response to public/private methods.
attributes	Character vector, names of the attributes to return. If NULL (default), return only method names. ALL returns all available attributes. For example, the following attributes are available for the Etsy API: description uri params defaults type visibility http_method
api	Name of the API to explore
...	Additional parameters to be passed to grepl for matching argument pattern to methods names.

Value

Data frame containing the methods names matchning pattern, and the attributes requested.

Examples

getMethodsInfo()
getMethodsInfo("listings", ignore.case = TRUE)
getMethodsInfo("findAllFeaturedListings", attributes = "ALL")
getMethodsInfo("findAllFeaturedListings", attributes = c("description", "params"))
getMethodsInfo("Listings", http_method = "GET", visibility = "public")

agpknitweardesign/festotuAPIs documentation built on Feb. 2, 2020, 12:20 p.m.