rwars (version 1.0.0)

get_planet_schema: Retrieve the schema specifications for different object classes

Description

*_schema functions grab the schema specifications for each class of objects in the SWAPI database. This can be used to predict what structure data returned from the API will take.

Usage

get_planet_schema(parse_result = FALSE, ...)
get_species_schema(parse_result = FALSE, ...)
get_film_schema(parse_result = FALSE, ...)
get_vehicle_schema(parse_result = FALSE, ...)
get_starship_schema(parse_result = FALSE, ...)
get_person_schema(parse_result = FALSE, ...)

Arguments

parse_result

whether to simplify the results before they are returned. This is FALSE by default.

...

additional arguments to pass to httr's GET function, such as timeout settings or user agents.

Value

a list-based representation of the relevant JSON schema.

See Also

entries for retrieving data about individual planets, schemas, etc, or all_entries for retrieving all of the data in a particular category.

Examples

get_planet_schema()