porcelain_package_endpoint: Find roxygen-defined endpoint

In reside-ic/porcelain: Turn a Package into an HTTP API

Find roxygen-defined endpoint

Description

Find an endpoint defined implicitly through roxygen comments (rather than explicitly via writing porcelain_endpoint.

Usage

porcelain_package_endpoint(
  package,
  method,
  path,
  state = NULL,
  validate = NULL
)

Arguments

package	The name of the package to look in, provided as a string or as a namespace
method	The HTTP method (i.e., verb), such as GET or POST, as a string
path	The path of the method (e.g., ⁠/my/path⁠)
state	A list of state to bind into the method, if your endpoint requires any
validate	Logical, indicating if the method should be created with schema validation enabled.

Value

The endpoint, a porcelain_endpoint object

reside-ic/porcelain documentation built on March 4, 2024, 11:11 p.m.