diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 577a14f..59a4aad 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,7 +16,7 @@ If you’ve found a bug, please file an issue that illustrates the bug with a mi ### Pull request process -* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("jonthegeek/rapid", fork = TRUE)`. +* Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("api2r/rapid", fork = TRUE)`. * Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md index 6ef79a2..eb3a6fc 100644 --- a/.github/SUPPORT.md +++ b/.github/SUPPORT.md @@ -16,12 +16,12 @@ Armed with your reprex, the next step is to figure out where to ask. * If it's a question: It's best to ask on the [R4DS Online Learning Community Slack](https://r4ds.io/join). Other options include [Posit Community](https://community.rstudio.com/), and StackOverflow. There are more people there to answer questions. -* If it's a bug: you're in the right place, [file an issue](https://github.com/jonthegeek/rapid/issues/new). +* If it's a bug: you're in the right place, [file an issue](https://github.com/api2r/rapid/issues/new). * If you're not sure: let the community help you figure it out! If your problem _is_ a bug or a feature request, you can easily return here and report it. -Before opening a new issue, be sure to [search issues and pull requests](https://github.com/jonthegeek/rapid/issues) to make sure the bug hasn't been reported and/or already fixed in the development version. +Before opening a new issue, be sure to [search issues and pull requests](https://github.com/api2r/rapid/issues) to make sure the bug hasn't been reported and/or already fixed in the development version. By default, the search will be pre-populated with `is:issue is:open`. You can [edit the qualifiers](https://help.github.com/articles/searching-issues-and-pull-requests/) (e.g. `is:pr`, `is:closed`) as needed. For example, you'd simply remove `is:open` to search _all_ issues in the repo, open or closed. diff --git a/.github/skills/create-issue/SKILL.md b/.github/skills/create-issue/SKILL.md index 43af38b..e9fb310 100644 --- a/.github/skills/create-issue/SKILL.md +++ b/.github/skills/create-issue/SKILL.md @@ -17,10 +17,10 @@ The hardcoded IDs below are correct for this repo as of 2026-04-28 13:47:49 UTC. ```bash # Repository node ID -gh api graphql -f query='{ repository(owner: "jonthegeek", name: "rapid") { id } }' +gh api graphql -f query='{ repository(owner: "api2r", name: "rapid") { id } }' # Available issue type IDs -gh api graphql -f query='{ repository(owner: "jonthegeek", name: "rapid") { issueTypes(first: 20) { nodes { id name description } } } }' +gh api graphql -f query='{ repository(owner: "api2r", name: "rapid") { issueTypes(first: 20) { nodes { id name description } } } }' ``` ## Issue type @@ -29,6 +29,11 @@ Choose the type that best fits the issue: | Type | ID | Use for | |---|---|---| +| Task | `IT_kwDOCPuMJs4BPtRZ` | A specific piece of work | +| Bug | `IT_kwDOCPuMJs4BPtRc` | An unexpected problem or behavior | +| Feature | `IT_kwDOCPuMJs4BPtRe` | A request, idea, or new functionality | +| Documentation | `IT_kwDOCPuMJs4B5OL_` | Explanations of how or why to do things | +| Infrastructure | `IT_kwDOCPuMJs4B5OMn` | Infrastructure of a project, like GitHub Actions | ## Issue title diff --git a/AGENTS.md b/AGENTS.md index bdf463c..778311d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -9,7 +9,7 @@ Convert an 'API' description ('APID'), such as one that (a "rapid"). The rapid object follows the 'OpenAPI Specification' to make it easy to convert to and from 'API' documents. -https://rapid.api2r.org/, https://github.com/jonthegeek/rapid +https://rapid.api2r.org/, https://github.com/api2r/rapid ### Overall structure diff --git a/DESCRIPTION b/DESCRIPTION index ba6fbcd..a41da3c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -12,8 +12,8 @@ Description: Convert an 'API' description ('APID'), such as one that (a "rapid"). The rapid object follows the 'OpenAPI Specification' to make it easy to convert to and from 'API' documents. License: MIT + file LICENSE -URL: https://rapid.api2r.org/, https://github.com/jonthegeek/rapid -BugReports: https://github.com/jonthegeek/rapid/issues +URL: https://rapid.api2r.org/, https://github.com/api2r/rapid +BugReports: https://github.com/api2r/rapid/issues Depends: R (>= 3.5.0) Imports: @@ -26,7 +26,7 @@ Imports: snakecase, stbl (>= 0.3.0), tibble, - tibblify (>= 0.3.1.9000), + tibblify (>= 0.3.2), xml2, yaml Suggests: @@ -35,12 +35,12 @@ Suggests: Remotes: stbl=wranglezone/stbl, tibblify=wranglezone/tibblify +Config/roxygen2/version: 8.0.0 Config/testthat/edition: 3 Config/testthat/parallel: true Encoding: UTF-8 Language: en-US Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.3 Collate: 'aaa-conditions.R' 'aaa-shared_params.R' diff --git a/R/rapid-package.R b/R/rapid-package.R index 64b898f..6786cd6 100644 --- a/R/rapid-package.R +++ b/R/rapid-package.R @@ -1,3 +1,6 @@ +#' @keywords internal +"_PACKAGE" + ## usethis namespace: start #' @importFrom cli format_inline #' @importFrom glue glue diff --git a/README.Rmd b/README.Rmd index 5dc8385..096d822 100644 --- a/README.Rmd +++ b/README.Rmd @@ -18,8 +18,8 @@ knitr::opts_chunk$set( [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/rapid)](https://CRAN.R-project.org/package=rapid) -[![Codecov test coverage](https://codecov.io/gh/jonthegeek/rapid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/rapid?branch=main) -[![R-CMD-check](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml) +[![Codecov test coverage](https://codecov.io/gh/api2r/rapid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/api2r/rapid?branch=main) +[![R-CMD-check](https://github.com/api2r/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/api2r/rapid/actions/workflows/R-CMD-check.yaml) Convert an API description (APID), such as one that follows the [OpenAPI Specification](https://spec.openapis.org/oas/v3.1.0), to an R API description object. @@ -40,7 +40,7 @@ Install the development version of rapid from [GitHub](https://github.com/): ``` r # install.packages("pak") -pak::pak("jonthegeek/rapid") +pak::pak("api2r/rapid") ``` ::: @@ -50,4 +50,4 @@ This package will be used by [{beekeeper}](https://beekeeper.api2r.org/) and [{m ## Code of Conduct -Please note that the rapid project is released with a [Contributor Code of Conduct](https://jonthegeek.github.io/rapid/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. +Please note that the rapid project is released with a [Contributor Code of Conduct](https://api2r.github.io/rapid/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. diff --git a/README.md b/README.md index 4404aaa..62dbe18 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h [![CRAN status](https://www.r-pkg.org/badges/version/rapid)](https://CRAN.R-project.org/package=rapid) [![Codecov test -coverage](https://codecov.io/gh/jonthegeek/rapid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/jonthegeek/rapid?branch=main) -[![R-CMD-check](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/jonthegeek/rapid/actions/workflows/R-CMD-check.yaml) +coverage](https://codecov.io/gh/api2r/rapid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/api2r/rapid?branch=main) +[![R-CMD-check](https://github.com/api2r/rapid/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/api2r/rapid/actions/workflows/R-CMD-check.yaml) Convert an API description (APID), such as one that follows the [OpenAPI @@ -40,7 +40,7 @@ Install the development version of rapid from ``` r # install.packages("pak") -pak::pak("jonthegeek/rapid") +pak::pak("api2r/rapid") ``` @@ -53,5 +53,5 @@ and [{mockplumber}](https://jonthegeek.github.io/mockplumber/). ## Code of Conduct Please note that the rapid project is released with a [Contributor Code -of Conduct](https://jonthegeek.github.io/rapid/CODE_OF_CONDUCT.html). By +of Conduct](https://api2r.github.io/rapid/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. diff --git a/man/as_api_key_security_scheme.Rd b/man/as_api_key_security_scheme.Rd index eea7f20..bb5e9a2 100644 --- a/man/as_api_key_security_scheme.Rd +++ b/man/as_api_key_security_scheme.Rd @@ -9,7 +9,7 @@ as_api_key_security_scheme(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or be a list or character vector with names "name" and either "in" or "location", or names that can be -coerced to those names via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names +coerced to those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -34,47 +34,47 @@ An \code{api_key_security_scheme} as returned by 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}()} +security scheme objects: +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/as_api_object.Rd b/man/as_api_object.Rd index 52b442b..4ee8a21 100644 --- a/man/as_api_object.Rd +++ b/man/as_api_object.Rd @@ -17,7 +17,7 @@ as_api_object( \item{x}{The object to coerce. Must be empty, or be a named list or character vector having names corresponding to the parameter of the \code{target_class}, or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored.} +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored.} \item{target_class}{The S7 class to which the object should be converted.} @@ -43,9 +43,9 @@ An object with the specified \code{target_class}. 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}()} +rapid object: +\code{\link[=as_rapid]{as_rapid()}}, +\code{\link[=class_rapid]{class_rapid()}}, +\code{\link[=expand_servers]{expand_servers()}} } \concept{rapid} diff --git a/man/as_components.Rd b/man/as_components.Rd index d435152..4e319ce 100644 --- a/man/as_components.Rd +++ b/man/as_components.Rd @@ -9,7 +9,7 @@ as_components(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or be a list containing a single list named "security_schemes", or a name that can be coerced to -"security_schemes" via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names are +"security_schemes" via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -80,28 +80,28 @@ 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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} diff --git a/man/as_contact.Rd b/man/as_contact.Rd index d1d4627..93d0a30 100644 --- a/man/as_contact.Rd +++ b/man/as_contact.Rd @@ -9,7 +9,7 @@ as_contact(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or have names "name", "email", and/or "url", or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This object should +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single point of contact.} \item{...}{These dots are for future extensions and must be empty.} @@ -35,13 +35,13 @@ 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}()} +info object: +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/as_info.Rd b/man/as_info.Rd index bc2124f..63eba3a 100644 --- a/man/as_info.Rd +++ b/man/as_info.Rd @@ -11,7 +11,7 @@ as_info(x, ..., arg = caller_arg(x), call = caller_env()) "version", "contact", "description", "license", "summary", "terms_of_service", and/or "origin" (or "x-origin", which will be coerced to "origin"), or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This object should +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single API.} \item{...}{These dots are for future extensions and must be empty.} @@ -38,13 +38,13 @@ 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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/as_license.Rd b/man/as_license.Rd index 3f7fe55..52f025d 100644 --- a/man/as_license.Rd +++ b/man/as_license.Rd @@ -9,7 +9,7 @@ as_license(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or have names "name", "identifier", and/or "url", or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This object should +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single license.} \item{...}{These dots are for future extensions and must be empty.} @@ -35,13 +35,13 @@ 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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/as_oauth2_authorization_code_flow.Rd b/man/as_oauth2_authorization_code_flow.Rd index 4f6eff6..a8418fd 100644 --- a/man/as_oauth2_authorization_code_flow.Rd +++ b/man/as_oauth2_authorization_code_flow.Rd @@ -16,7 +16,7 @@ as_oauth2_authorization_code_flow( \item{x}{The object to coerce. Must be empty or be a list of named lists, each with names "refresh_url", "scopes", "authorization_url", and/or "token_url", or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names are ignored.} +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -40,47 +40,47 @@ An \code{oauth2_authorization_code_flow} as returned by \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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 084042f..7e5ec57 100644 --- a/man/as_oauth2_implicit_flow.Rd +++ b/man/as_oauth2_implicit_flow.Rd @@ -10,7 +10,7 @@ as_oauth2_implicit_flow(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or be a list of named lists, each with names "refresh_url", "scopes", and/or "authorization_url", or -names that can be coerced to those names via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. +names that can be coerced to those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -35,47 +35,47 @@ An \code{oauth2_implicit_flow} as returned by 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 baf097e..9922d5f 100644 --- a/man/as_oauth2_security_scheme.Rd +++ b/man/as_oauth2_security_scheme.Rd @@ -9,7 +9,7 @@ as_oauth2_security_scheme(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or be a list with an object named "flows" or a name that can be coerced to "flows" via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names are ignored.} +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} } @@ -24,47 +24,47 @@ An \code{oauth2_security_scheme} as returned by 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 1f83410..a65d4d3 100644 --- a/man/as_oauth2_token_flow.Rd +++ b/man/as_oauth2_token_flow.Rd @@ -9,7 +9,7 @@ as_oauth2_token_flow(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or be a list of named lists, each with names "refresh_url", "scopes", and/or "token_url", or names that -can be coerced to those names via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional +can be coerced to those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -32,47 +32,47 @@ An \code{oauth2_token_flow} as returned by \code{\link[=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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/as_origin.Rd b/man/as_origin.Rd index 0af8023..82a239e 100644 --- a/man/as_origin.Rd +++ b/man/as_origin.Rd @@ -9,7 +9,7 @@ as_origin(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{x}{The object to coerce. Must be empty or have names "url", "format", and/or "version", or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This object should +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single origin for this API description.} \item{...}{These dots are for future extensions and must be empty.} @@ -43,13 +43,13 @@ 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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/as_paths.Rd b/man/as_paths.Rd index 6b32497..5990b58 100644 --- a/man/as_paths.Rd +++ b/man/as_paths.Rd @@ -26,7 +26,7 @@ as_paths() as_paths(mtcars) } \seealso{ -paths object -\code{\link{class_paths}()} +paths object: +\code{\link[=class_paths]{class_paths()}} } \concept{paths} diff --git a/man/as_rapid.Rd b/man/as_rapid.Rd index 2d281f2..4090b26 100644 --- a/man/as_rapid.Rd +++ b/man/as_rapid.Rd @@ -9,7 +9,7 @@ as_rapid(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or have names "info", "servers", "components", "paths", and/or "security", or names that can be coerced to -those names via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. +those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. \code{\link[=url]{url()}} objects are read with \code{\link[jsonlite:fromJSON]{jsonlite::fromJSON()}} or \code{\link[yaml:read_yaml]{yaml::read_yaml()}} before conversion.} @@ -27,9 +27,9 @@ properties. as_rapid() } \seealso{ -rapid object -\code{\link{as_api_object}()}, -\code{\link{class_rapid}()}, -\code{\link{expand_servers}()} +rapid object: +\code{\link[=as_api_object]{as_api_object()}}, +\code{\link[=class_rapid]{class_rapid()}}, +\code{\link[=expand_servers]{expand_servers()}} } \concept{rapid} diff --git a/man/as_reference.Rd b/man/as_reference.Rd index 6340639..bc96021 100644 --- a/man/as_reference.Rd +++ b/man/as_reference.Rd @@ -9,7 +9,7 @@ as_reference(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{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 \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This +those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single reference.} \item{...}{These dots are for future extensions and must be empty.} @@ -36,32 +36,32 @@ as_reference() as_reference(list(`$ref` = "#/components/schemas/Pet")) } \seealso{ -reference objects -\code{\link{class_reference}()} +reference objects: +\code{\link[=class_reference]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_reference} diff --git a/man/as_schema.Rd b/man/as_schema.Rd index 0f73cd6..1515aa1 100644 --- a/man/as_schema.Rd +++ b/man/as_schema.Rd @@ -9,7 +9,7 @@ as_schema(x, ..., arg = caller_arg(x), call = caller_env()) \arguments{ \item{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 \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored. This +those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored. This object should describe a single schema.} \item{...}{These dots are for future extensions and must be empty.} @@ -41,32 +41,32 @@ as_schema( ) } \seealso{ -schema objects -\code{\link{class_schema}()} +schema objects: +\code{\link[=class_schema]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_schema} diff --git a/man/as_scopes.Rd b/man/as_scopes.Rd index 769eaeb..d800664 100644 --- a/man/as_scopes.Rd +++ b/man/as_scopes.Rd @@ -19,47 +19,47 @@ A \code{scopes} as returned by \code{\link[=class_scopes]{class_scopes()}}. 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/as_security.Rd b/man/as_security.Rd index 3a1e050..2054f56 100644 --- a/man/as_security.Rd +++ b/man/as_security.Rd @@ -9,7 +9,7 @@ as_security(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or be a list containing a single list named "security_schemes", or a name that can be coerced to -"security_schemes" via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names are +"security_schemes" via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -34,7 +34,7 @@ as_security( ) } \seealso{ -security object -\code{\link{class_security}()} +security object: +\code{\link[=class_security]{class_security()}} } \concept{security} diff --git a/man/as_security_scheme.Rd b/man/as_security_scheme.Rd index 1048f0f..bc2bd35 100644 --- a/man/as_security_scheme.Rd +++ b/man/as_security_scheme.Rd @@ -9,7 +9,7 @@ as_security_scheme(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or be a named list, with at least an element \code{type}. The \code{type} element is processed through -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}, and then must be one of "api_key", "oauth2", +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}, and then must be one of "api_key", "oauth2", or "oauth_2".} \item{...}{These dots are for future extensions and must be empty.} @@ -64,47 +64,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 866e176..c748fa4 100644 --- a/man/as_security_scheme_details.Rd +++ b/man/as_security_scheme_details.Rd @@ -68,47 +68,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/as_security_schemes.Rd b/man/as_security_schemes.Rd index 042d116..94ec04c 100644 --- a/man/as_security_schemes.Rd +++ b/man/as_security_schemes.Rd @@ -67,47 +67,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/as_server_variables.Rd b/man/as_server_variables.Rd index fc1f898..fb7f1a1 100644 --- a/man/as_server_variables.Rd +++ b/man/as_server_variables.Rd @@ -42,11 +42,11 @@ 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}()} +servers object: +\code{\link[=as_servers]{as_servers()}}, +\code{\link[=as_string_replacements]{as_string_replacements()}}, +\code{\link[=class_server_variables]{class_server_variables()}}, +\code{\link[=class_servers]{class_servers()}}, +\code{\link[=class_string_replacements]{class_string_replacements()}} } \concept{servers} diff --git a/man/as_servers.Rd b/man/as_servers.Rd index 944ef54..d3a1f4a 100644 --- a/man/as_servers.Rd +++ b/man/as_servers.Rd @@ -9,7 +9,7 @@ as_servers(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or have names "name", "email", and/or "url", or names that can be coerced to those names via -\code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Extra names are ignored.} +\code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Extra names are ignored.} \item{...}{These dots are for future extensions and must be empty.} } @@ -41,11 +41,11 @@ 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}()} +servers object: +\code{\link[=as_server_variables]{as_server_variables()}}, +\code{\link[=as_string_replacements]{as_string_replacements()}}, +\code{\link[=class_server_variables]{class_server_variables()}}, +\code{\link[=class_servers]{class_servers()}}, +\code{\link[=class_string_replacements]{class_string_replacements()}} } \concept{servers} diff --git a/man/as_string_replacements.Rd b/man/as_string_replacements.Rd index 2cdc188..15f08d8 100644 --- a/man/as_string_replacements.Rd +++ b/man/as_string_replacements.Rd @@ -9,7 +9,7 @@ as_string_replacements(x, ...) \arguments{ \item{x}{The object to coerce. Must be empty or be a list of named lists, each with names "enum", "default", or "description", or names that can be -coerced to those names via \code{\link[snakecase:caseconverter]{snakecase::to_snake_case()}}. Additional names +coerced to those names via \code{\link[snakecase:to_snake_case]{snakecase::to_snake_case()}}. Additional names are ignored.} \item{...}{These dots are for future extensions and must be empty.} @@ -39,11 +39,11 @@ 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}()} +servers object: +\code{\link[=as_server_variables]{as_server_variables()}}, +\code{\link[=as_servers]{as_servers()}}, +\code{\link[=class_server_variables]{class_server_variables()}}, +\code{\link[=class_servers]{class_servers()}}, +\code{\link[=class_string_replacements]{class_string_replacements()}} } \concept{servers} diff --git a/man/class_api_key_security_scheme.Rd b/man/class_api_key_security_scheme.Rd index 2c081cf..67c6c08 100644 --- a/man/class_api_key_security_scheme.Rd +++ b/man/class_api_key_security_scheme.Rd @@ -30,47 +30,47 @@ class_api_key_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}()}, -\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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/class_components.Rd b/man/class_components.Rd index b661729..4ed80e7 100644 --- a/man/class_components.Rd +++ b/man/class_components.Rd @@ -37,28 +37,28 @@ class_components( \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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} diff --git a/man/class_contact.Rd b/man/class_contact.Rd index e1c80a1..a59aa36 100644 --- a/man/class_contact.Rd +++ b/man/class_contact.Rd @@ -31,13 +31,13 @@ class_contact( ) } \seealso{ -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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/class_info.Rd b/man/class_info.Rd index b24489d..eeeaff2 100644 --- a/man/class_info.Rd +++ b/man/class_info.Rd @@ -71,13 +71,13 @@ class_info( ) } \seealso{ -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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_license]{class_license()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/class_license.Rd b/man/class_license.Rd index 619136f..8358167 100644 --- a/man/class_license.Rd +++ b/man/class_license.Rd @@ -44,13 +44,13 @@ class_license( ) } \seealso{ -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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_origin]{class_origin()}} } \concept{info} diff --git a/man/class_oauth2_authorization_code_flow.Rd b/man/class_oauth2_authorization_code_flow.Rd index fe8d52d..92a93a0 100644 --- a/man/class_oauth2_authorization_code_flow.Rd +++ b/man/class_oauth2_authorization_code_flow.Rd @@ -52,47 +52,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 efd34f7..c67b807 100644 --- a/man/class_oauth2_implicit_flow.Rd +++ b/man/class_oauth2_implicit_flow.Rd @@ -41,47 +41,47 @@ class_oauth2_implicit_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_security_scheme}()}, -\code{\link{class_oauth2_token_flow}()}, -\code{\link{class_scopes}()}, -\code{\link{class_security_scheme_details}()}, -\code{\link{class_security_schemes}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 5febc03..5d22973 100644 --- a/man/class_oauth2_security_scheme.Rd +++ b/man/class_oauth2_security_scheme.Rd @@ -38,47 +38,47 @@ class_oauth2_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}()}, -\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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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 898aa28..9316392 100644 --- a/man/class_oauth2_token_flow.Rd +++ b/man/class_oauth2_token_flow.Rd @@ -45,47 +45,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/class_origin.Rd b/man/class_origin.Rd index 5249766..ad4e7a0 100644 --- a/man/class_origin.Rd +++ b/man/class_origin.Rd @@ -42,13 +42,13 @@ class_origin( ) } \seealso{ -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}()} +info object: +\code{\link[=as_contact]{as_contact()}}, +\code{\link[=as_info]{as_info()}}, +\code{\link[=as_license]{as_license()}}, +\code{\link[=as_origin]{as_origin()}}, +\code{\link[=class_contact]{class_contact()}}, +\code{\link[=class_info]{class_info()}}, +\code{\link[=class_license]{class_license()}} } \concept{info} diff --git a/man/class_paths.Rd b/man/class_paths.Rd index bacd11e..89898d9 100644 --- a/man/class_paths.Rd +++ b/man/class_paths.Rd @@ -30,7 +30,7 @@ class_paths( ) } \seealso{ -paths object -\code{\link{as_paths}()} +paths object: +\code{\link[=as_paths]{as_paths()}} } \concept{paths} diff --git a/man/class_rapid.Rd b/man/class_rapid.Rd index 1085320..3b188c1 100644 --- a/man/class_rapid.Rd +++ b/man/class_rapid.Rd @@ -66,9 +66,9 @@ class_rapid( ) } \seealso{ -rapid object -\code{\link{as_api_object}()}, -\code{\link{as_rapid}()}, -\code{\link{expand_servers}()} +rapid object: +\code{\link[=as_api_object]{as_api_object()}}, +\code{\link[=as_rapid]{as_rapid()}}, +\code{\link[=expand_servers]{expand_servers()}} } \concept{rapid} diff --git a/man/class_reference.Rd b/man/class_reference.Rd index 4f267cf..d278715 100644 --- a/man/class_reference.Rd +++ b/man/class_reference.Rd @@ -37,32 +37,32 @@ references. class_reference("#/components/schemas/Pet") } \seealso{ -reference objects -\code{\link{as_reference}()} +reference objects: +\code{\link[=as_reference]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_reference} diff --git a/man/class_schema.Rd b/man/class_schema.Rd index 584eb54..0259c09 100644 --- a/man/class_schema.Rd +++ b/man/class_schema.Rd @@ -42,32 +42,32 @@ class_schema("string") class_schema("string", nullable = TRUE, description = "A nullable string.") } \seealso{ -schema objects -\code{\link{as_schema}()} +schema objects: +\code{\link[=as_schema]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_schema} diff --git a/man/class_scopes.Rd b/man/class_scopes.Rd index 42f2221..c633d8c 100644 --- a/man/class_scopes.Rd +++ b/man/class_scopes.Rd @@ -41,47 +41,47 @@ class_scopes( ) } \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_security_scheme_details}()}, -\code{\link{class_security_schemes}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_security_scheme_details]{class_security_scheme_details()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/class_security.Rd b/man/class_security.Rd index c9cdd10..ae87020 100644 --- a/man/class_security.Rd +++ b/man/class_security.Rd @@ -36,7 +36,7 @@ class_security( ) } \seealso{ -security object -\code{\link{as_security}()} +security object: +\code{\link[=as_security]{as_security()}} } \concept{security} diff --git a/man/class_security_scheme_details.Rd b/man/class_security_scheme_details.Rd index bef51f1..895dd0d 100644 --- a/man/class_security_scheme_details.Rd +++ b/man/class_security_scheme_details.Rd @@ -57,47 +57,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_schemes]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_schemes]{class_security_schemes()}} } \concept{components} \concept{components_security_schemes} diff --git a/man/class_security_schemes.Rd b/man/class_security_schemes.Rd index dcc77be..639a9b5 100644 --- a/man/class_security_schemes.Rd +++ b/man/class_security_schemes.Rd @@ -63,47 +63,47 @@ 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}()} +security scheme objects: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{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}()} +components object: +\code{\link[=as_api_key_security_scheme]{as_api_key_security_scheme()}}, +\code{\link[=as_components]{as_components()}}, +\code{\link[=as_oauth2_authorization_code_flow]{as_oauth2_authorization_code_flow()}}, +\code{\link[=as_oauth2_implicit_flow]{as_oauth2_implicit_flow()}}, +\code{\link[=as_oauth2_security_scheme]{as_oauth2_security_scheme()}}, +\code{\link[=as_oauth2_token_flow]{as_oauth2_token_flow()}}, +\code{\link[=as_reference]{as_reference()}}, +\code{\link[=as_schema]{as_schema()}}, +\code{\link[=as_scopes]{as_scopes()}}, +\code{\link[=as_security_scheme]{as_security_scheme()}}, +\code{\link[=as_security_scheme_details]{as_security_scheme_details()}}, +\code{\link[=as_security_schemes]{as_security_schemes()}}, +\code{\link[=class_api_key_security_scheme]{class_api_key_security_scheme()}}, +\code{\link[=class_components]{class_components()}}, +\code{\link[=class_oauth2_authorization_code_flow]{class_oauth2_authorization_code_flow()}}, +\code{\link[=class_oauth2_implicit_flow]{class_oauth2_implicit_flow()}}, +\code{\link[=class_oauth2_security_scheme]{class_oauth2_security_scheme()}}, +\code{\link[=class_oauth2_token_flow]{class_oauth2_token_flow()}}, +\code{\link[=class_reference]{class_reference()}}, +\code{\link[=class_schema]{class_schema()}}, +\code{\link[=class_scopes]{class_scopes()}}, +\code{\link[=class_security_scheme_details]{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 1a98bf9..503eda4 100644 --- a/man/class_server_variables.Rd +++ b/man/class_server_variables.Rd @@ -24,11 +24,11 @@ class_server_variables( ) } \seealso{ -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}()} +servers object: +\code{\link[=as_server_variables]{as_server_variables()}}, +\code{\link[=as_servers]{as_servers()}}, +\code{\link[=as_string_replacements]{as_string_replacements()}}, +\code{\link[=class_servers]{class_servers()}}, +\code{\link[=class_string_replacements]{class_string_replacements()}} } \concept{servers} diff --git a/man/class_servers.Rd b/man/class_servers.Rd index 5ebc3c1..d3615a9 100644 --- a/man/class_servers.Rd +++ b/man/class_servers.Rd @@ -61,11 +61,11 @@ class_servers( ) } \seealso{ -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}()} +servers object: +\code{\link[=as_server_variables]{as_server_variables()}}, +\code{\link[=as_servers]{as_servers()}}, +\code{\link[=as_string_replacements]{as_string_replacements()}}, +\code{\link[=class_server_variables]{class_server_variables()}}, +\code{\link[=class_string_replacements]{class_string_replacements()}} } \concept{servers} diff --git a/man/class_string_replacements.Rd b/man/class_string_replacements.Rd index c38479f..a48062e 100644 --- a/man/class_string_replacements.Rd +++ b/man/class_string_replacements.Rd @@ -50,11 +50,11 @@ class_string_replacements( ) } \seealso{ -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}()} +servers object: +\code{\link[=as_server_variables]{as_server_variables()}}, +\code{\link[=as_servers]{as_servers()}}, +\code{\link[=as_string_replacements]{as_string_replacements()}}, +\code{\link[=class_server_variables]{class_server_variables()}}, +\code{\link[=class_servers]{class_servers()}} } \concept{servers} diff --git a/man/expand_servers.Rd b/man/expand_servers.Rd index c3ab62c..20327e6 100644 --- a/man/expand_servers.Rd +++ b/man/expand_servers.Rd @@ -20,9 +20,9 @@ paths. 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}()} +rapid object: +\code{\link[=as_api_object]{as_api_object()}}, +\code{\link[=as_rapid]{as_rapid()}}, +\code{\link[=class_rapid]{class_rapid()}} } \concept{rapid} diff --git a/man/rapid-package.Rd b/man/rapid-package.Rd new file mode 100644 index 0000000..ee49670 --- /dev/null +++ b/man/rapid-package.Rd @@ -0,0 +1,34 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/rapid-package.R +\docType{package} +\name{rapid-package} +\alias{rapid} +\alias{rapid-package} +\title{rapid: R 'API' Descriptions} +\description{ +Convert an 'API' description ('APID'), such as one that follows the 'OpenAPI Specification', to an R 'API' description object (a "rapid"). The rapid object follows the 'OpenAPI Specification' to make it easy to convert to and from 'API' documents. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://rapid.api2r.org/} + \item \url{https://github.com/api2r/rapid} + \item Report bugs at \url{https://github.com/api2r/rapid/issues} +} + +} +\author{ +\strong{Maintainer}: Jon Harmon \email{jonthegeek@gmail.com} (\href{https://orcid.org/0000-0003-4781-4346}{ORCID}) + +Authors: +\itemize{ + \item Jon Harmon \email{jonthegeek@gmail.com} (\href{https://orcid.org/0000-0003-4781-4346}{ORCID}) +} + +Other contributors: +\itemize{ + \item The Linux Foundation (OpenAPI Specification) [copyright holder] +} + +} +\keyword{internal} diff --git a/man/reexports.Rd b/man/reexports.Rd index 1bea638..d26f2e1 100644 --- a/man/reexports.Rd +++ b/man/reexports.Rd @@ -12,6 +12,6 @@ These objects are imported from other packages. Follow the links below to see their documentation. \describe{ - \item{rlang}{\code{\link[rlang]{caller_arg}}, \code{\link[rlang:stack]{caller_env}}} + \item{rlang}{\code{\link[rlang:caller_arg]{caller_arg()}}, \code{\link[rlang:caller_env]{caller_env()}}} }}