Coerce lists and character vectors to API key security schemes

as_api_key_security_scheme() turns an existing object into an api_key_security_scheme. This is in contrast with class_api_key_security_scheme(), which builds an api_key_security_scheme from individual properties.

Usage

as_api_key_security_scheme(x, ..., arg = caller_arg(x), call = caller_env())

Arguments

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 snakecase::to_snake_case(). Additional names are ignored.

...

These dots are for future extensions and must be empty.

arg

An argument name as a string. This argument will be mentioned in error messages as the input that is at the origin of a problem.

call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

An api_key_security_scheme as returned by class_api_key_security_scheme().

See also

security scheme objects as_oauth2_authorization_code_flow(), as_oauth2_implicit_flow(), as_oauth2_security_scheme(), as_oauth2_token_flow(), as_scopes(), as_security_scheme(), as_security_scheme_details(), as_security_schemes(), class_api_key_security_scheme(), class_oauth2_authorization_code_flow(), class_oauth2_implicit_flow(), class_oauth2_security_scheme(), class_oauth2_token_flow(), class_scopes(), class_security_scheme_details(), class_security_schemes()

components object as_components(), as_oauth2_authorization_code_flow(), as_oauth2_implicit_flow(), as_oauth2_security_scheme(), as_oauth2_token_flow(), as_reference(), as_schema(), as_scopes(), as_security_scheme(), as_security_scheme_details(), as_security_schemes(), class_api_key_security_scheme(), class_components(), class_oauth2_authorization_code_flow(), class_oauth2_implicit_flow(), class_oauth2_security_scheme(), class_oauth2_token_flow(), class_reference(), class_schema(), class_scopes(), class_security_scheme_details(), class_security_schemes()