Function reference
rapid object
The main rapid object, containing all information about the API.
-
as_api_object()
- Convert to a rapid-style object
-
as_rapid()
- Coerce lists and urls to rapid objects
-
class_rapid()
- R API description object
-
expand_servers()
- Expand server urls to absolute paths
info object
The info object contains metadata about the API.
-
as_contact()
- Coerce lists and character vectors to contacts
-
as_info()
- Coerce lists and character vectors to info objects
-
as_license()
- Coerce lists and character vectors to licenses
-
as_origin()
- Coerce lists and character vectors to origin
-
class_contact()
- Contact information for the API
-
class_info()
- Information about the API
-
class_license()
- License information for the API
-
class_origin()
- Source information for the API description
components object
The components object contains reusable objects for different aspects of the API.
-
class_components()
- An element to hold various schemas for the API
-
as_components()
- Coerce lists to components objects
-
as_reference()
- Coerce lists and character vectors to references
-
class_reference()
- A simple object for referencing other components in the API description
-
as_schema()
- Coerce lists to schemas
-
class_schema()
- Reusable input and output data type definitions
-
as_api_key_security_scheme()
- Coerce lists and character vectors to API key security schemes
-
as_oauth2_authorization_code_flow()
- Coerce lists and character vectors to OAuth2 authorization code flows
-
as_oauth2_implicit_flow()
- Coerce lists and character vectors to OAuth2 implicit flows
-
as_oauth2_security_scheme()
- Coerce lists to oauth2 security schemes
-
as_oauth2_token_flow()
- Coerce lists and character vectors to OAuth2 token flows
-
as_scopes()
- Coerce lists and character vectors to scopes
-
as_security_scheme()
- Coerce lists to security_scheme objects
-
as_security_scheme_details()
- Coerce lists to security_scheme_details objects
-
as_security_schemes()
- Coerce lists to security_schemes objects
-
class_api_key_security_scheme()
- API key security schemes
-
class_oauth2_authorization_code_flow()
- OAuth2 authorization code flow object
-
class_oauth2_implicit_flow()
- OAuth2 implicit flow object
-
class_oauth2_security_scheme()
- OAuth2 security schemes
-
class_oauth2_token_flow()
- OAuth2 token flow object
-
class_scopes()
- OAuth2 flow scopes objects
-
class_security_scheme_details()
- Details of API security schemes
-
class_security_schemes()
- Reusable security schemes for an API
paths object
The paths object contains available paths and operations for the API.
-
as_paths()
- Coerce objects to paths
-
class_paths()
- The available paths and operations for the API
security object
The security object contains a declaration of which security mechanisms can be used across the API.
-
as_security()
- Coerce lists to as_security objects
-
class_security()
- Security schemes required to execute an operation
servers object
The servers object contains connectivity information for the API.
-
as_server_variables()
- Coerce lists to server_variables
-
as_servers()
- Coerce lists and character vectors to servers
-
as_string_replacements()
- Coerce lists to string_replacements
-
class_server_variables()
- A collection of string replacements for multiple servers
-
class_servers()
- An object representing a collection of servers
-
class_string_replacements()
- A set of variables for server URL template substitution