From 8d5206c0cf20df7e64886d8152ced680304d361a Mon Sep 17 00:00:00 2001 From: Jon Harmon Date: Mon, 29 Apr 2024 12:12:27 -0500 Subject: [PATCH] Cleaner documentation. No luck setting up a catch-all, but it should be easier to keep things organized now. --- R/absolute_paths.R | 1 + R/as.R | 1 + R/components-reference.R | 6 +- R/components-schema.R | 6 +- R/components-security_scheme-api_key.R | 4 + ...ty_scheme-oauth2-authorization_code_flow.R | 7 ++ ...nts-security_scheme-oauth2-implicit_flow.R | 7 ++ R/components-security_scheme-oauth2-scopes.R | 6 +- ...onents-security_scheme-oauth2-token_flow.R | 9 +- R/components-security_scheme-oauth2.R | 4 + R/components-security_scheme.R | 2 + R/components-security_scheme_details.R | 4 + R/components-security_schemes.R | 5 ++ R/components.R | 4 +- R/info-contact.R | 4 +- R/info-license.R | 4 +- R/info-origin.R | 4 +- R/info.R | 4 +- R/paths.R | 4 +- R/security.R | 3 + R/servers-server_variables.R | 4 +- R/servers-string_replacements.R | 6 +- R/servers.R | 4 +- R/zz-rapid.R | 4 +- _pkgdown.yml | 87 +++++++------------ man/as_api_key_security_scheme.Rd | 45 ++++++++++ man/as_api_object.Rd | 7 ++ man/as_components.Rd | 28 ++++++ man/as_contact.Rd | 11 +++ man/as_info.Rd | 11 +++ man/as_license.Rd | 11 +++ man/as_oauth2_authorization_code_flow.Rd | 45 ++++++++++ man/as_oauth2_implicit_flow.Rd | 45 ++++++++++ man/as_oauth2_security_scheme.Rd | 45 ++++++++++ man/as_oauth2_token_flow.Rd | 45 ++++++++++ man/as_origin.Rd | 11 +++ man/as_paths.Rd | 5 ++ man/as_rapid.Rd | 7 ++ man/as_reference.Rd | 30 +++++++ man/as_schema.Rd | 30 +++++++ man/as_scopes.Rd | 45 ++++++++++ man/as_security.Rd | 5 ++ man/as_security_scheme.Rd | 45 ++++++++++ man/as_security_scheme_details.Rd | 45 ++++++++++ man/as_security_schemes.Rd | 45 ++++++++++ man/as_server_variables.Rd | 9 ++ man/as_servers.Rd | 9 ++ man/as_string_replacements.Rd | 9 ++ man/class_api_key_security_scheme.Rd | 45 ++++++++++ man/class_components.Rd | 25 ++++++ man/class_contact.Rd | 10 ++- man/class_info.Rd | 10 ++- man/class_license.Rd | 10 ++- man/class_oauth2_authorization_code_flow.Rd | 49 +++++++++++ man/class_oauth2_implicit_flow.Rd | 49 +++++++++++ man/class_oauth2_security_scheme.Rd | 45 ++++++++++ man/class_oauth2_token_flow.Rd | 48 +++++++++- man/class_origin.Rd | 10 ++- man/class_paths.Rd | 4 +- man/class_rapid.Rd | 6 +- man/class_reference.Rd | 29 ++++++- man/class_schema.Rd | 29 ++++++- man/class_scopes.Rd | 44 +++++++++- man/class_security.Rd | 5 ++ man/class_security_scheme_details.Rd | 45 ++++++++++ man/class_security_schemes.Rd | 45 ++++++++++ man/class_server_variables.Rd | 8 +- man/class_servers.Rd | 8 +- man/class_string_replacements.Rd | 10 ++- man/expand_servers.Rd | 7 ++ man/roxygen/meta.R | 13 +++ 71 files changed, 1237 insertions(+), 99 deletions(-) create mode 100644 man/roxygen/meta.R diff --git a/R/absolute_paths.R b/R/absolute_paths.R index 7d0ad31..bf790a3 100644 --- a/R/absolute_paths.R +++ b/R/absolute_paths.R @@ -13,6 +13,7 @@ NULL #' @return A `rapid` object as returned by [class_rapid()], with absolute server #' paths. #' @export +#' @family rapid expand_servers <- S7::new_generic("expand_servers", "x") S7::method(expand_servers, class_rapid) <- function(x) { diff --git a/R/as.R b/R/as.R index 8938b47..d2b9e39 100644 --- a/R/as.R +++ b/R/as.R @@ -15,6 +15,7 @@ #' #' @return An object with the specified `target_class`. #' @export +#' @family rapid as_api_object <- S7::new_generic( "as_api_object", "x", diff --git a/R/components-reference.R b/R/components-reference.R index 6957121..a030af6 100644 --- a/R/components-reference.R +++ b/R/components-reference.R @@ -22,8 +22,8 @@ NULL #' @return A `reference` S7 object pointing (by name) to another part of the #' `rapid` object. #' @export -#' -#' @seealso [as_reference()] for coercing objects to `reference`. +#' @family components_reference +#' @family components #' #' @examples #' class_reference("#/components/schemas/Pet") @@ -63,6 +63,8 @@ S7::method(length, class_reference) <- function(x) { #' #' @return A `reference` as returned by [class_reference()]. #' @export +#' @family components_reference +#' @family components #' #' @examples #' as_reference() diff --git a/R/components-schema.R b/R/components-schema.R index 4a1358b..d434ce8 100644 --- a/R/components-schema.R +++ b/R/components-schema.R @@ -22,8 +22,8 @@ NULL #' @return A `schema` S7 object describing the data type, with fields `type`, #' `nullable`, `description`, and `format`. #' @export -#' -#' @seealso [as_schema()] for coercing objects to `schema`. +#' @family components_schema +#' @family components #' #' @examples #' class_schema("string") @@ -90,6 +90,8 @@ S7::method(length, class_schema) <- function(x) { #' #' @return A `schema` as returned by [class_schema()]. #' @export +#' @family components_schema +#' @family components #' #' @examples #' as_schema() diff --git a/R/components-security_scheme-api_key.R b/R/components-security_scheme-api_key.R index b287606..ede68b7 100644 --- a/R/components-security_scheme-api_key.R +++ b/R/components-security_scheme-api_key.R @@ -14,6 +14,8 @@ NULL #' @return An `api_key_security_scheme` S7 object, with fields `parameter_name` #' and `location`. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' class_api_key_security_scheme( @@ -71,6 +73,8 @@ S7::method(length, class_api_key_security_scheme) <- function(x) { #' @return An `api_key_security_scheme` as returned by #' [class_api_key_security_scheme()]. #' @export +#' @family components_security_schemes +#' @family components as_api_key_security_scheme <- function(x, ..., arg = caller_arg(x), diff --git a/R/components-security_scheme-oauth2-authorization_code_flow.R b/R/components-security_scheme-oauth2-authorization_code_flow.R index e102894..da7ae18 100644 --- a/R/components-security_scheme-oauth2-authorization_code_flow.R +++ b/R/components-security_scheme-oauth2-authorization_code_flow.R @@ -12,7 +12,12 @@ NULL #' @inheritParams class_oauth2_implicit_flow #' @inheritParams class_oauth2_token_flow #' +#' @return An `oauth2_authorization_code_flow` S7 object, with fields +#' `authorization_url`, `token_url`, `refresh_url`, and `scopes`. #' @export +#' @family components_security_schemes +#' @family components +#' #' @examples #' class_oauth2_authorization_code_flow( #' authorization_url = "https://example.com/authorize", @@ -77,6 +82,8 @@ S7::method(length, class_oauth2_authorization_code_flow) <- function(x) { #' @return An `oauth2_authorization_code_flow` as returned by #' [class_oauth2_authorization_code_flow()]. #' @export +#' @family components_security_schemes +#' @family components as_oauth2_authorization_code_flow <- function(x, ..., arg = caller_arg(x), diff --git a/R/components-security_scheme-oauth2-implicit_flow.R b/R/components-security_scheme-oauth2-implicit_flow.R index e45e2df..4c4a821 100644 --- a/R/components-security_scheme-oauth2-implicit_flow.R +++ b/R/components-security_scheme-oauth2-implicit_flow.R @@ -12,7 +12,12 @@ NULL #' to be used for this flow. This must be in the form of a URL. The OAuth2 #' standard requires the use of TLS. #' +#' @return An `oauth2_implicit_flow` S7 object, with fields `authorization_url`, +#' `refresh_url`, and `scopes`. #' @export +#' @family components_security_schemes +#' @family components +#' #' @examples #' class_oauth2_implicit_flow( #' authorization_url = "https://example.com/authorize", @@ -68,6 +73,8 @@ S7::method(length, class_oauth2_implicit_flow) <- function(x) { #' @return An `oauth2_implicit_flow` as returned by #' [class_oauth2_implicit_flow()]. #' @export +#' @family components_security_schemes +#' @family components as_oauth2_implicit_flow <- function(x, ..., arg = caller_arg(x), diff --git a/R/components-security_scheme-oauth2-scopes.R b/R/components-security_scheme-oauth2-scopes.R index 65be87d..7d84cda 100644 --- a/R/components-security_scheme-oauth2-scopes.R +++ b/R/components-security_scheme-oauth2-scopes.R @@ -7,8 +7,10 @@ #' scope. #' #' @return A `scopes` S7 object, with fields `name` and `description`. -#' @seealso [as_scopes()] for coercing objects to `scopes`. #' @export +#' @family components_security_schemes +#' @family components +#' #' @examples #' class_scopes( #' name = c( @@ -69,6 +71,8 @@ S7::method(length, class_scopes) <- function(x) { #' #' @return A `scopes` as returned by [class_scopes()]. #' @export +#' @family components_security_schemes +#' @family components as_scopes <- S7::new_generic("as_scopes", "x") S7::method( diff --git a/R/components-security_scheme-oauth2-token_flow.R b/R/components-security_scheme-oauth2-token_flow.R index 30195c6..68c366e 100644 --- a/R/components-security_scheme-oauth2-token_flow.R +++ b/R/components-security_scheme-oauth2-token_flow.R @@ -13,9 +13,12 @@ NULL #' this flow. This must be in the form of a URL. The OAuth2 standard requires #' the use of TLS. #' -#' @return An `oauth2_token_flow` object. -#' +#' @return An `oauth2_token_flow` S7 object, with fields `token_url`, +#' `refresh_url`, and `scopes`. #' @export +#' @family components_security_schemes +#' @family components +#' #' @examples #' class_oauth2_token_flow( #' token_url = "https://example.com/token", @@ -73,6 +76,8 @@ S7::method(length, class_oauth2_token_flow) <- function(x) { #' #' @return An `oauth2_token_flow` as returned by [class_oauth2_token_flow()]. #' @export +#' @family components_security_schemes +#' @family components as_oauth2_token_flow <- function(x, ..., arg = caller_arg(x), diff --git a/R/components-security_scheme-oauth2.R b/R/components-security_scheme-oauth2.R index 17740d4..a162357 100644 --- a/R/components-security_scheme-oauth2.R +++ b/R/components-security_scheme-oauth2.R @@ -19,6 +19,8 @@ NULL #' @return An `oauth2_security_scheme` S7 object, with fields `implicit_flow`, #' `password_flow`, `client_credentials_flow`, and `authorization_code_flow`. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' class_oauth2_security_scheme() @@ -73,6 +75,8 @@ S7::method(length, class_oauth2_security_scheme) <- function(x) { #' @return An `oauth2_security_scheme` as returned by #' [class_oauth2_security_scheme()]. #' @export +#' @family components_security_schemes +#' @family components as_oauth2_security_scheme <- S7::new_generic("as_oauth2_security_scheme", "x") S7::method( diff --git a/R/components-security_scheme.R b/R/components-security_scheme.R index 930a4f1..c607de6 100644 --- a/R/components-security_scheme.R +++ b/R/components-security_scheme.R @@ -27,6 +27,8 @@ abstract_security_scheme <- S7::new_class( #' @return A `security_scheme` object as returned by #' [class_api_key_security_scheme()] or [class_oauth2_security_scheme()]. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' as_security_scheme( diff --git a/R/components-security_scheme_details.R b/R/components-security_scheme_details.R index 68325e8..a1e4e07 100644 --- a/R/components-security_scheme_details.R +++ b/R/components-security_scheme_details.R @@ -12,6 +12,8 @@ #' @return A `security_scheme_details` object, which is a validated list of #' [abstract_security_scheme()] objects. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' class_security_scheme_details( @@ -90,6 +92,8 @@ class_security_scheme_details <- S7::new_class( #' @return A `security_scheme_details` object as returned by #' [class_security_scheme_details()]. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' as_security_scheme_details() diff --git a/R/components-security_schemes.R b/R/components-security_schemes.R index 1ee1828..0f3f0f0 100644 --- a/R/components-security_schemes.R +++ b/R/components-security_schemes.R @@ -19,6 +19,9 @@ NULL #' @return A `security_schemes` S7 object with details about security available #' for operations. #' @export +#' @family components_security_schemes +#' @family components +#' #' @examples #' class_security_schemes() #' class_security_schemes( @@ -96,6 +99,8 @@ S7::method(length, class_security_schemes) <- function(x) { #' @return A `security_schemes` object as returned by #' [class_security_schemes()]. #' @export +#' @family components_security_schemes +#' @family components #' #' @examples #' as_security_schemes() diff --git a/R/components.R b/R/components.R index 531c550..3ff7687 100644 --- a/R/components.R +++ b/R/components.R @@ -15,9 +15,9 @@ NULL #' #' @return A `components` S7 object with various schemas for the API. #' @export -#' #' @seealso [as_components()] for coercing objects to #' `components` objects. +#' @family components #' #' @examples #' class_components() @@ -66,6 +66,8 @@ S7::method(length, class_components) <- function(x) { #' @return A `components` object as returned by #' [class_components()]. #' @export +#' @seealso [class_components()] for creating `components` objects. +#' @family components #' #' @examples #' as_components() diff --git a/R/info-contact.R b/R/info-contact.R index c7bb85e..fd848db 100644 --- a/R/info-contact.R +++ b/R/info-contact.R @@ -15,8 +15,7 @@ NULL #' @return A `contact` S7 object describing who to contact for information about #' the API, with fields `name`, `email`, and `url`. #' @export -#' -#' @seealso [as_contact()] for coercing objects to `contact`. +#' @family info #' #' @examples #' class_contact( @@ -55,6 +54,7 @@ S7::method(length, class_contact) <- function(x) { #' #' @return A `contact` as returned by [class_contact()]. #' @export +#' @family info #' #' @examples #' as_contact() diff --git a/R/info-license.R b/R/info-license.R index 80f9946..8ae6adb 100644 --- a/R/info-license.R +++ b/R/info-license.R @@ -19,8 +19,7 @@ NULL #' @return A `license` S7 object describing allowed usage of the API, with #' fields `name`, `identifier`, and `url`. #' @export -#' -#' @seealso [as_license()] for coercing objects to `license`. +#' @family info #' #' @examples #' class_license( @@ -77,6 +76,7 @@ S7::method(length, class_license) <- function(x) { #' #' @return A `license` as returned by [class_license()]. #' @export +#' @family info #' #' @examples #' as_license() diff --git a/R/info-origin.R b/R/info-origin.R index 90f8fd7..8bd3e4c 100644 --- a/R/info-origin.R +++ b/R/info-origin.R @@ -20,8 +20,7 @@ NULL #' @return An `origin` S7 object describing where to find the API description, #' with fields `url`, `format`, and `version`. #' @export -#' -#' @seealso [as_origin()] for coercing objects to `origin`. +#' @family info #' #' @examples #' class_origin( @@ -76,6 +75,7 @@ S7::method(length, class_origin) <- function(x) { #' #' @return An `origin` as returned by [class_origin()]. #' @export +#' @family info #' #' @examples #' as_origin() diff --git a/R/info.R b/R/info.R index ffc2677..6399bce 100644 --- a/R/info.R +++ b/R/info.R @@ -33,8 +33,7 @@ NULL #' #' @return An `info` S7 object with metadata describing a single API. #' @export -#' -#' @seealso [as_info()] for coercing objects to `info`. +#' @family info #' #' @examples #' class_info() @@ -124,6 +123,7 @@ S7::method(length, class_info) <- function(x) { #' #' @return An `info` object as returned by [class_info()]. #' @export +#' @family info #' #' @examples #' as_info() diff --git a/R/paths.R b/R/paths.R index 3e0e3c2..a3861e7 100644 --- a/R/paths.R +++ b/R/paths.R @@ -8,8 +8,7 @@ #' #' @return A `paths` S7 object with details about API endpoints. #' @export -#' -#' @seealso [as_paths()] for coercing objects to `paths`. +#' @family paths #' #' @examples #' class_paths() @@ -48,6 +47,7 @@ class_paths <- S7::new_class( #' #' @return A `paths` object as returned by [class_paths()]. #' @export +#' @family paths #' #' @examples #' as_paths() diff --git a/R/security.R b/R/security.R index 81d61c9..96451ec 100644 --- a/R/security.R +++ b/R/security.R @@ -17,6 +17,8 @@ NULL #' @return A `security` S7 object with references of security required for #' operations. #' @export +#' @family security +#' #' @examples #' class_security() #' class_security( @@ -76,6 +78,7 @@ S7::method(length, class_security) <- function(x) { #' #' @return A `security` object as returned by [class_security()]. #' @export +#' @family security #' #' @examples #' as_security() diff --git a/R/servers-server_variables.R b/R/servers-server_variables.R index 4a76021..97d6a12 100644 --- a/R/servers-server_variables.R +++ b/R/servers-server_variables.R @@ -9,8 +9,7 @@ #' @return A `server_variables` S7 object, which is a validated list of #' [class_string_replacements()] objects. #' @export -#' -#' @seealso [as_server_variables()] for coercing objects to `server_variables`. +#' @family servers #' #' @examples #' class_server_variables( @@ -57,6 +56,7 @@ class_server_variables <- S7::new_class( #' @return A `server_variables` object as returned by #' [class_server_variables()]. #' @export +#' @family servers #' #' @examples #' as_server_variables() diff --git a/R/servers-string_replacements.R b/R/servers-string_replacements.R index f233f4e..7bc5790 100644 --- a/R/servers-string_replacements.R +++ b/R/servers-string_replacements.R @@ -25,10 +25,7 @@ NULL #' variables for a single server, with fields `name`, `default`, `enum`, and #' `description`. #' @export -#' -#' @seealso [as_string_replacements()] for coercing objects to -#' `string_replacements`, and [class_server_variables()] for creating -#' collections of `string_replacements`. +#' @family servers #' #' @examples #' class_string_replacements( @@ -94,6 +91,7 @@ S7::method(length, class_string_replacements) <- function(x) { #' #' @return A `string_replacements` as returned by [class_string_replacements()]. #' @export +#' @family servers #' #' @examples #' as_string_replacements() diff --git a/R/servers.R b/R/servers.R index e2d4a8c..ff918a7 100644 --- a/R/servers.R +++ b/R/servers.R @@ -18,8 +18,7 @@ NULL #' @return A `servers` S7 object, with properties `url`, `description`, and #' `variables`. #' @export -#' -#' @seealso [as_servers()] for coercing objects to `servers`. +#' @family servers #' #' @examples #' class_servers( @@ -96,6 +95,7 @@ S7::method(length, class_servers) <- function(x) { #' #' @return A `servers` object as returned by [class_servers()]. #' @export +#' @family servers #' #' @examples #' as_servers() diff --git a/R/zz-rapid.R b/R/zz-rapid.R index bde5ca0..aedc646 100644 --- a/R/zz-rapid.R +++ b/R/zz-rapid.R @@ -19,8 +19,7 @@ NULL #' @return A `rapid` S7 object, with properties `info`, `servers`, `components`, #' `paths`, and `security`. #' @export -#' -#' @seealso [as_rapid()] for coercing objects to `rapid`. +#' @family rapid #' #' @examples #' class_rapid() @@ -116,6 +115,7 @@ S7::method(length, class_rapid) <- function(x) { #' #' @return A `rapid` object as returned by [class_rapid()]. #' @export +#' @family rapid #' #' @examples #' as_rapid() diff --git a/_pkgdown.yml b/_pkgdown.yml index 1d87f5f..8f89d7f 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -2,62 +2,37 @@ url: https://jonthegeek.github.io/rapid/ template: bootstrap: 5 reference: - - title: rapid class - contents: - - class_rapid - - as_rapid - - expand_servers - - title: info class - contents: - - class_info - - as_info - - class_contact - - as_contact - - class_license - - as_license - - class_origin - - as_origin - - title: servers class - contents: - - class_servers - - as_servers - - class_string_replacements - - as_string_replacements - - class_server_variables - - as_server_variables - - title: components class + - title: rapid object + desc: The main rapid object, containing [all information about the API](https://spec.openapis.org/oas/v3.1.0#openapi-object). + contents: + - has_concept("rapid") + - title: info object + desc: The info object contains [metadata about the API](https://spec.openapis.org/oas/v3.1.0#info-object). + contents: + - has_concept("info") + - title: components object + desc: The components object contains [reusable objects for different aspects of the API](https://spec.openapis.org/oas/v3.1.0#components-object). contents: - class_components - as_components - - class_schema - - as_schema - - class_security_schemes - - as_security_schemes - - as_security_scheme - - class_security_scheme_details - - as_security_scheme_details - - class_api_key_security_scheme - - as_api_key_security_scheme - - class_oauth2_security_scheme - - as_oauth2_security_scheme - - class_oauth2_authorization_code_flow - - as_oauth2_authorization_code_flow - - class_oauth2_implicit_flow - - as_oauth2_implicit_flow - - class_oauth2_token_flow - - as_oauth2_token_flow - - class_scopes - - as_scopes - - title: paths class - contents: - - class_paths - - as_paths - - title: security class - contents: - - class_security - - as_security - - title: other - contents: - - class_reference - - as_reference - - as_api_object + - subtitle: reference objects + contents: + - has_concept("components_reference") + - subtitle: schema objects + contents: + - has_concept("components_schema") + - subtitle: security scheme objects + contents: + - has_concept("components_security_schemes") + - title: paths object + desc: The paths object contains [available paths and operations for the API](https://spec.openapis.org/oas/v3.1.0#paths-object). + contents: + - has_concept("paths") + - title: security object + desc: The security object contains [a declaration of which security mechanisms can be used across the API](https://spec.openapis.org/oas/v3.1.0#security-requirement-object). + contents: + - has_concept("security") + - title: servers object + desc: The servers object contains [connectivity information for the API](https://spec.openapis.org/oas/v3.1.0#server-object). + contents: + - has_concept("servers") diff --git a/man/as_api_key_security_scheme.Rd b/man/as_api_key_security_scheme.Rd index b935c24..eea7f20 100644 --- a/man/as_api_key_security_scheme.Rd +++ b/man/as_api_key_security_scheme.Rd @@ -33,3 +33,48 @@ An \code{api_key_security_scheme} as returned by \code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, which builds an \code{api_key_security_scheme} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_api_object.Rd b/man/as_api_object.Rd index 47e5e63..52b442b 100644 --- a/man/as_api_object.Rd +++ b/man/as_api_object.Rd @@ -42,3 +42,10 @@ An object with the specified \code{target_class}. \description{ Convert an object into an object with a rapid-style class. } +\seealso{ +rapid object +\code{\link{as_rapid}()}, +\code{\link{class_rapid}()}, +\code{\link{expand_servers}()} +} +\concept{rapid} diff --git a/man/as_components.Rd b/man/as_components.Rd index ed212da..d435152 100644 --- a/man/as_components.Rd +++ b/man/as_components.Rd @@ -77,3 +77,31 @@ as_components(list( ) )) } +\seealso{ +\code{\link[=class_components]{class_components()}} for creating \code{components} objects. + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} diff --git a/man/as_contact.Rd b/man/as_contact.Rd index d6432d3..d1d4627 100644 --- a/man/as_contact.Rd +++ b/man/as_contact.Rd @@ -34,3 +34,14 @@ with \code{\link[=class_contact]{class_contact()}}, which builds a \code{contact as_contact() as_contact(list(name = "Jon Harmon", email = "jonthegeek@gmail.com")) } +\seealso{ +info object +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} +} +\concept{info} diff --git a/man/as_info.Rd b/man/as_info.Rd index c15409b..bc2124f 100644 --- a/man/as_info.Rd +++ b/man/as_info.Rd @@ -37,3 +37,14 @@ properties. as_info() as_info(list(title = "My Cool API", version = "1.0.0")) } +\seealso{ +info object +\code{\link{as_contact}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} +} +\concept{info} diff --git a/man/as_license.Rd b/man/as_license.Rd index b73a1f6..3f7fe55 100644 --- a/man/as_license.Rd +++ b/man/as_license.Rd @@ -34,3 +34,14 @@ with \code{\link[=class_license]{class_license()}}, which builds a \code{license as_license() as_license(list(name = "Apache 2.0", identifier = "Apache-2.0")) } +\seealso{ +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} +} +\concept{info} diff --git a/man/as_oauth2_authorization_code_flow.Rd b/man/as_oauth2_authorization_code_flow.Rd index 3f4f40f..4f6eff6 100644 --- a/man/as_oauth2_authorization_code_flow.Rd +++ b/man/as_oauth2_authorization_code_flow.Rd @@ -39,3 +39,48 @@ An \code{oauth2_authorization_code_flow} as returned by \code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, which builds an \code{oauth2_authorization_code_flow} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_oauth2_implicit_flow.Rd b/man/as_oauth2_implicit_flow.Rd index 6da2ec8..084042f 100644 --- a/man/as_oauth2_implicit_flow.Rd +++ b/man/as_oauth2_implicit_flow.Rd @@ -34,3 +34,48 @@ An \code{oauth2_implicit_flow} as returned by \code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, which builds an \code{oauth2_implicit_flow} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_oauth2_security_scheme.Rd b/man/as_oauth2_security_scheme.Rd index ca0a452..baf097e 100644 --- a/man/as_oauth2_security_scheme.Rd +++ b/man/as_oauth2_security_scheme.Rd @@ -23,3 +23,48 @@ An \code{oauth2_security_scheme} as returned by \code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, which builds an \code{oauth2_security_scheme} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_oauth2_token_flow.Rd b/man/as_oauth2_token_flow.Rd index 7b93d88..1f83410 100644 --- a/man/as_oauth2_token_flow.Rd +++ b/man/as_oauth2_token_flow.Rd @@ -31,3 +31,48 @@ An \code{oauth2_token_flow} as returned by \code{\link[=class_oauth2_token_flow] \code{oauth2_token_flow}. This is in contrast with \code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, which builds an \code{oauth2_token_flow} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_origin.Rd b/man/as_origin.Rd index 2745caf..0af8023 100644 --- a/man/as_origin.Rd +++ b/man/as_origin.Rd @@ -42,3 +42,14 @@ as_origin( ) ) } +\seealso{ +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} +} +\concept{info} diff --git a/man/as_paths.Rd b/man/as_paths.Rd index 6d681f1..6b32497 100644 --- a/man/as_paths.Rd +++ b/man/as_paths.Rd @@ -25,3 +25,8 @@ other valid objects to the expected shape. as_paths() as_paths(mtcars) } +\seealso{ +paths object +\code{\link{class_paths}()} +} +\concept{paths} diff --git a/man/as_rapid.Rd b/man/as_rapid.Rd index 5632a27..2d281f2 100644 --- a/man/as_rapid.Rd +++ b/man/as_rapid.Rd @@ -26,3 +26,10 @@ properties. \examples{ as_rapid() } +\seealso{ +rapid object +\code{\link{as_api_object}()}, +\code{\link{class_rapid}()}, +\code{\link{expand_servers}()} +} +\concept{rapid} diff --git a/man/as_reference.Rd b/man/as_reference.Rd index 2e19b09..6340639 100644 --- a/man/as_reference.Rd +++ b/man/as_reference.Rd @@ -35,3 +35,33 @@ properties. as_reference() as_reference(list(`$ref` = "#/components/schemas/Pet")) } +\seealso{ +reference objects +\code{\link{class_reference}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_reference} diff --git a/man/as_schema.Rd b/man/as_schema.Rd index f826ff1..0f73cd6 100644 --- a/man/as_schema.Rd +++ b/man/as_schema.Rd @@ -40,3 +40,33 @@ as_schema( ) ) } +\seealso{ +schema objects +\code{\link{class_schema}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_schema} diff --git a/man/as_scopes.Rd b/man/as_scopes.Rd index fcce14a..769eaeb 100644 --- a/man/as_scopes.Rd +++ b/man/as_scopes.Rd @@ -18,3 +18,48 @@ A \code{scopes} as returned by \code{\link[=class_scopes]{class_scopes()}}. \code{as_scopes()} turns an existing object into a \code{scopes}. This is in contrast with \code{\link[=class_scopes]{class_scopes()}}, which builds a \code{scopes} from individual properties. } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_security.Rd b/man/as_security.Rd index e8070f4..3a1e050 100644 --- a/man/as_security.Rd +++ b/man/as_security.Rd @@ -33,3 +33,8 @@ as_security( ) ) } +\seealso{ +security object +\code{\link{class_security}()} +} +\concept{security} diff --git a/man/as_security_scheme.Rd b/man/as_security_scheme.Rd index 43c9131..1048f0f 100644 --- a/man/as_security_scheme.Rd +++ b/man/as_security_scheme.Rd @@ -63,3 +63,48 @@ as_security_scheme( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_security_scheme_details.Rd b/man/as_security_scheme_details.Rd index 1db5853..866e176 100644 --- a/man/as_security_scheme_details.Rd +++ b/man/as_security_scheme_details.Rd @@ -67,3 +67,48 @@ as_security_scheme_details( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_security_schemes.Rd b/man/as_security_schemes.Rd index cced3fe..042d116 100644 --- a/man/as_security_schemes.Rd +++ b/man/as_security_schemes.Rd @@ -66,3 +66,48 @@ as_security_schemes( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/as_server_variables.Rd b/man/as_server_variables.Rd index 9a78983..fc1f898 100644 --- a/man/as_server_variables.Rd +++ b/man/as_server_variables.Rd @@ -41,3 +41,12 @@ as_server_variables( ) ) } +\seealso{ +servers object +\code{\link{as_servers}()}, +\code{\link{as_string_replacements}()}, +\code{\link{class_server_variables}()}, +\code{\link{class_servers}()}, +\code{\link{class_string_replacements}()} +} +\concept{servers} diff --git a/man/as_servers.Rd b/man/as_servers.Rd index 2aa8f66..944ef54 100644 --- a/man/as_servers.Rd +++ b/man/as_servers.Rd @@ -40,3 +40,12 @@ as_servers( ) ) } +\seealso{ +servers object +\code{\link{as_server_variables}()}, +\code{\link{as_string_replacements}()}, +\code{\link{class_server_variables}()}, +\code{\link{class_servers}()}, +\code{\link{class_string_replacements}()} +} +\concept{servers} diff --git a/man/as_string_replacements.Rd b/man/as_string_replacements.Rd index 6fa459e..2cdc188 100644 --- a/man/as_string_replacements.Rd +++ b/man/as_string_replacements.Rd @@ -38,3 +38,12 @@ as_string_replacements( ) ) } +\seealso{ +servers object +\code{\link{as_server_variables}()}, +\code{\link{as_servers}()}, +\code{\link{class_server_variables}()}, +\code{\link{class_servers}()}, +\code{\link{class_string_replacements}()} +} +\concept{servers} diff --git a/man/class_api_key_security_scheme.Rd b/man/class_api_key_security_scheme.Rd index 3d8e404..2c081cf 100644 --- a/man/class_api_key_security_scheme.Rd +++ b/man/class_api_key_security_scheme.Rd @@ -29,3 +29,48 @@ class_api_key_security_scheme( location = "header" ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_components.Rd b/man/class_components.Rd index 275c3fe..b661729 100644 --- a/man/class_components.Rd +++ b/man/class_components.Rd @@ -36,4 +36,29 @@ class_components( \seealso{ \code{\link[=as_components]{as_components()}} for coercing objects to \code{components} objects. + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} } +\concept{components} diff --git a/man/class_contact.Rd b/man/class_contact.Rd index 5c743cc..6e2d775 100644 --- a/man/class_contact.Rd +++ b/man/class_contact.Rd @@ -31,5 +31,13 @@ class_contact( ) } \seealso{ -\code{\link[=as_contact]{as_contact()}} for coercing objects to \code{contact}. +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} } +\concept{info} diff --git a/man/class_info.Rd b/man/class_info.Rd index 2772c0e..b24489d 100644 --- a/man/class_info.Rd +++ b/man/class_info.Rd @@ -71,5 +71,13 @@ class_info( ) } \seealso{ -\code{\link[=as_info]{as_info()}} for coercing objects to \code{info}. +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_license}()}, +\code{\link{class_origin}()} } +\concept{info} diff --git a/man/class_license.Rd b/man/class_license.Rd index a67f34a..619136f 100644 --- a/man/class_license.Rd +++ b/man/class_license.Rd @@ -44,5 +44,13 @@ class_license( ) } \seealso{ -\code{\link[=as_license]{as_license()}} for coercing objects to \code{license}. +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_origin}()} } +\concept{info} diff --git a/man/class_oauth2_authorization_code_flow.Rd b/man/class_oauth2_authorization_code_flow.Rd index 22f23ce..fe8d52d 100644 --- a/man/class_oauth2_authorization_code_flow.Rd +++ b/man/class_oauth2_authorization_code_flow.Rd @@ -31,6 +31,10 @@ standard requires the use of TLS.} \item{scopes}{An optional \code{\link[=class_scopes]{class_scopes()}} object with the available scopes for the OAuth2 security scheme.} } +\value{ +An \code{oauth2_authorization_code_flow} S7 object, with fields +\code{authorization_url}, \code{token_url}, \code{refresh_url}, and \code{scopes}. +} \description{ An \code{oauth2_authorization_code_flow} object describes the configuration for the OAuth Authorization Code flow. Previously called \code{accessCode} in OpenAPI @@ -47,3 +51,48 @@ class_oauth2_authorization_code_flow( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_oauth2_implicit_flow.Rd b/man/class_oauth2_implicit_flow.Rd index 51f9146..efd34f7 100644 --- a/man/class_oauth2_implicit_flow.Rd +++ b/man/class_oauth2_implicit_flow.Rd @@ -26,6 +26,10 @@ standard requires the use of TLS.} \item{scopes}{An optional \code{\link[=class_scopes]{class_scopes()}} object with the available scopes for the OAuth2 security scheme.} } +\value{ +An \code{oauth2_implicit_flow} S7 object, with fields \code{authorization_url}, +\code{refresh_url}, and \code{scopes}. +} \description{ An \code{oauth2_implicit_flow} object describes the configuration for the OAuth Implicit flow. @@ -36,3 +40,48 @@ class_oauth2_implicit_flow( refresh_url = "https://example.com/refresh" ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_oauth2_security_scheme.Rd b/man/class_oauth2_security_scheme.Rd index 4731ec3..5febc03 100644 --- a/man/class_oauth2_security_scheme.Rd +++ b/man/class_oauth2_security_scheme.Rd @@ -37,3 +37,48 @@ class_oauth2_security_scheme( password_flow = class_oauth2_token_flow(token_url = "/tokens/passwords") ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_oauth2_token_flow.Rd b/man/class_oauth2_token_flow.Rd index 6fb5795..898aa28 100644 --- a/man/class_oauth2_token_flow.Rd +++ b/man/class_oauth2_token_flow.Rd @@ -26,7 +26,8 @@ standard requires the use of TLS.} for the OAuth2 security scheme.} } \value{ -An \code{oauth2_token_flow} object. +An \code{oauth2_token_flow} S7 object, with fields \code{token_url}, +\code{refresh_url}, and \code{scopes}. } \description{ An \code{oauth2_token_flow} object describes the configuration for the OAuth @@ -43,3 +44,48 @@ class_oauth2_token_flow( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_origin.Rd b/man/class_origin.Rd index 31fbc34..5249766 100644 --- a/man/class_origin.Rd +++ b/man/class_origin.Rd @@ -42,5 +42,13 @@ class_origin( ) } \seealso{ -\code{\link[=as_origin]{as_origin()}} for coercing objects to \code{origin}. +info object +\code{\link{as_contact}()}, +\code{\link{as_info}()}, +\code{\link{as_license}()}, +\code{\link{as_origin}()}, +\code{\link{class_contact}()}, +\code{\link{class_info}()}, +\code{\link{class_license}()} } +\concept{info} diff --git a/man/class_paths.Rd b/man/class_paths.Rd index d1159e5..bacd11e 100644 --- a/man/class_paths.Rd +++ b/man/class_paths.Rd @@ -30,5 +30,7 @@ class_paths( ) } \seealso{ -\code{\link[=as_paths]{as_paths()}} for coercing objects to \code{paths}. +paths object +\code{\link{as_paths}()} } +\concept{paths} diff --git a/man/class_rapid.Rd b/man/class_rapid.Rd index dfcb061..1085320 100644 --- a/man/class_rapid.Rd +++ b/man/class_rapid.Rd @@ -66,5 +66,9 @@ class_rapid( ) } \seealso{ -\code{\link[=as_rapid]{as_rapid()}} for coercing objects to \code{rapid}. +rapid object +\code{\link{as_api_object}()}, +\code{\link{as_rapid}()}, +\code{\link{expand_servers}()} } +\concept{rapid} diff --git a/man/class_reference.Rd b/man/class_reference.Rd index 16622d3..9fc8c16 100644 --- a/man/class_reference.Rd +++ b/man/class_reference.Rd @@ -37,5 +37,32 @@ references. class_reference("#/components/schemas/Pet") } \seealso{ -\code{\link[=as_reference]{as_reference()}} for coercing objects to \code{reference}. +reference objects +\code{\link{as_reference}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} } +\concept{components} +\concept{components_reference} diff --git a/man/class_schema.Rd b/man/class_schema.Rd index d94327a..584eb54 100644 --- a/man/class_schema.Rd +++ b/man/class_schema.Rd @@ -42,5 +42,32 @@ class_schema("string") class_schema("string", nullable = TRUE, description = "A nullable string.") } \seealso{ -\code{\link[=as_schema]{as_schema()}} for coercing objects to \code{schema}. +schema objects +\code{\link{as_schema}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} } +\concept{components} +\concept{components_schema} diff --git a/man/class_scopes.Rd b/man/class_scopes.Rd index 46f3655..42f2221 100644 --- a/man/class_scopes.Rd +++ b/man/class_scopes.Rd @@ -41,5 +41,47 @@ class_scopes( ) } \seealso{ -\code{\link[=as_scopes]{as_scopes()}} for coercing objects to \code{scopes}. +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_security_scheme_details}()}, +\code{\link{class_security_schemes}()} } +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_security.Rd b/man/class_security.Rd index e31ee5a..c9cdd10 100644 --- a/man/class_security.Rd +++ b/man/class_security.Rd @@ -35,3 +35,8 @@ class_security( ) ) } +\seealso{ +security object +\code{\link{as_security}()} +} +\concept{security} diff --git a/man/class_security_scheme_details.Rd b/man/class_security_scheme_details.Rd index 61b4ca0..bef51f1 100644 --- a/man/class_security_scheme_details.Rd +++ b/man/class_security_scheme_details.Rd @@ -56,3 +56,48 @@ class_security_scheme_details( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_schemes}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_schemes}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_security_schemes.Rd b/man/class_security_schemes.Rd index 5d18a14..dcc77be 100644 --- a/man/class_security_schemes.Rd +++ b/man/class_security_schemes.Rd @@ -62,3 +62,48 @@ class_security_schemes( ) ) } +\seealso{ +security scheme objects +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()} + +components object +\code{\link{as_api_key_security_scheme}()}, +\code{\link{as_components}()}, +\code{\link{as_oauth2_authorization_code_flow}()}, +\code{\link{as_oauth2_implicit_flow}()}, +\code{\link{as_oauth2_security_scheme}()}, +\code{\link{as_oauth2_token_flow}()}, +\code{\link{as_reference}()}, +\code{\link{as_schema}()}, +\code{\link{as_scopes}()}, +\code{\link{as_security_scheme}()}, +\code{\link{as_security_scheme_details}()}, +\code{\link{as_security_schemes}()}, +\code{\link{class_api_key_security_scheme}()}, +\code{\link{class_components}()}, +\code{\link{class_oauth2_authorization_code_flow}()}, +\code{\link{class_oauth2_implicit_flow}()}, +\code{\link{class_oauth2_security_scheme}()}, +\code{\link{class_oauth2_token_flow}()}, +\code{\link{class_reference}()}, +\code{\link{class_schema}()}, +\code{\link{class_scopes}()}, +\code{\link{class_security_scheme_details}()} +} +\concept{components} +\concept{components_security_schemes} diff --git a/man/class_server_variables.Rd b/man/class_server_variables.Rd index 12b0a5a..1a98bf9 100644 --- a/man/class_server_variables.Rd +++ b/man/class_server_variables.Rd @@ -24,5 +24,11 @@ class_server_variables( ) } \seealso{ -\code{\link[=as_server_variables]{as_server_variables()}} for coercing objects to \code{server_variables}. +servers object +\code{\link{as_server_variables}()}, +\code{\link{as_servers}()}, +\code{\link{as_string_replacements}()}, +\code{\link{class_servers}()}, +\code{\link{class_string_replacements}()} } +\concept{servers} diff --git a/man/class_servers.Rd b/man/class_servers.Rd index b28b34e..5ebc3c1 100644 --- a/man/class_servers.Rd +++ b/man/class_servers.Rd @@ -61,5 +61,11 @@ class_servers( ) } \seealso{ -\code{\link[=as_servers]{as_servers()}} for coercing objects to \code{servers}. +servers object +\code{\link{as_server_variables}()}, +\code{\link{as_servers}()}, +\code{\link{as_string_replacements}()}, +\code{\link{class_server_variables}()}, +\code{\link{class_string_replacements}()} } +\concept{servers} diff --git a/man/class_string_replacements.Rd b/man/class_string_replacements.Rd index a2141a4..c38479f 100644 --- a/man/class_string_replacements.Rd +++ b/man/class_string_replacements.Rd @@ -50,7 +50,11 @@ class_string_replacements( ) } \seealso{ -\code{\link[=as_string_replacements]{as_string_replacements()}} for coercing objects to -\code{string_replacements}, and \code{\link[=class_server_variables]{class_server_variables()}} for creating -collections of \code{string_replacements}. +servers object +\code{\link{as_server_variables}()}, +\code{\link{as_servers}()}, +\code{\link{as_string_replacements}()}, +\code{\link{class_server_variables}()}, +\code{\link{class_servers}()} } +\concept{servers} diff --git a/man/expand_servers.Rd b/man/expand_servers.Rd index 6723e63..c3ab62c 100644 --- a/man/expand_servers.Rd +++ b/man/expand_servers.Rd @@ -19,3 +19,10 @@ paths. \code{expand_servers()} uses the \code{origin} property of a \code{rapid} object to expand the \code{servers} \code{url} property to an absolute path. } +\seealso{ +rapid object +\code{\link{as_api_object}()}, +\code{\link{as_rapid}()}, +\code{\link{class_rapid}()} +} +\concept{rapid} diff --git a/man/roxygen/meta.R b/man/roxygen/meta.R new file mode 100644 index 0000000..659ec70 --- /dev/null +++ b/man/roxygen/meta.R @@ -0,0 +1,13 @@ +list( + rd_family_title = list( + components = "components object", + components_reference = "reference objects", + components_schema = "schema objects", + components_security_schemes = "security scheme objects", + info = "info object", + paths = "paths object", + security = "security object", + servers = "servers object", + rapid = "rapid object" + ) +)