A simple object for referencing other components in the API description

The reference object allows for reuse of components between different parts of the API description. These objects are currently simple character references, but may change structure in the future to automatically resolve references.

Usage

class_reference(
  ref_uri = character(0),
  summary = character(0),
  description = character(0)
)

Arguments

ref_uri

Character scalar. The reference identifier. This must be in the form of a URI.

summary

Character scalar (optional). A short summary which by default should override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect.

description

Character scalar (optional). A description which by default should override that of the referenced component. CommonMark syntax may be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect.

Value

A reference S7 object pointing (by name) to another part of the rapid object.

See also

reference objects as_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_reference(), 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_schema(), class_scopes(), class_security_scheme_details(), class_security_schemes()

Examples

class_reference("#/components/schemas/Pet")
#> <rapid::reference>
#>  @ ref_uri    : chr "#/components/schemas/Pet"
#>  @ summary    : chr(0) 
#>  @ description: chr(0)