as_reference() turns an existing object into a reference. This is in
contrast with class_reference(), which builds a reference from individual
properties.
Usage
as_reference(x, ..., arg = caller_arg(x), call = caller_env())Arguments
- x
The object to coerce. Must be empty or have names "type", "nullable", "description", and/or "format", or names that can be coerced to those names via
snakecase::to_snake_case(). Extra names are ignored. This object should describe a single reference.- ...
These dots are for future extensions and must be empty.
- arg
An argument name as a string. This argument will be mentioned in error messages as the input that is at the origin of a problem.
- call
The execution environment of a currently running function, e.g.
caller_env(). The function will be mentioned in error messages as the source of the error. See thecallargument ofabort()for more information.
Value
A reference as returned by class_reference().
See also
reference objects
class_reference()
components object
as_api_key_security_scheme(),
as_components(),
as_oauth2_authorization_code_flow(),
as_oauth2_implicit_flow(),
as_oauth2_security_scheme(),
as_oauth2_token_flow(),
as_schema(),
as_scopes(),
as_security_scheme(),
as_security_scheme_details(),
as_security_schemes(),
class_api_key_security_scheme(),
class_components(),
class_oauth2_authorization_code_flow(),
class_oauth2_implicit_flow(),
class_oauth2_security_scheme(),
class_oauth2_token_flow(),
class_reference(),
class_schema(),
class_scopes(),
class_security_scheme_details(),
class_security_schemes()
Examples
as_reference()
#> <rapid::reference>
#> @ ref_uri : chr(0)
#> @ summary : chr(0)
#> @ description: chr(0)
as_reference(list(`$ref` = "#/components/schemas/Pet"))
#> <rapid::reference>
#> @ ref_uri : chr "#/components/schemas/Pet"
#> @ summary : chr(0)
#> @ description: chr(0)