Skip to content

beekeeper 0.5.0

Latest

Choose a tag to compare

@jonthegeek jonthegeek released this 20 May 14:14

Summary

More robust scaffolding.

Proposal wording

  • Add parameter documentation.
  • Also add parameter type checking.
  • Potential challenges: By this point I'll need an OAS definition document to use for testing that includes all of the possible parameter types. I'll likely need to generate a fake API specification that goes beyond a typical individual example.

Changes from Proposal

  • Type checking is implemented for many parameter types (logical, character, integer, double), and infrastructure is in place to add the rest as they become available in the spun-off {stbl} package.
  • I don't really need the grand API specification I envisioned for testing, so I did not create that.

News

  • New generation functions generate_pkg_auth(), generate_pkg_paths(), generate_pkg_req_prepare(), and generate_pkg_shared_params() allow for more modular API-wrapping package generation (#101).
  • New read functions read_api_abbr(), read_api_definition(), read_api_title(), read_config(), read_rapid_filename(), read_security_data(), read_security_data_filename(), and read_security_schemes() extract pieces needed for building an API-wrapping package (#82, #99).
  • generate_pkg_paths() now generates a separate R file for each endpoint, rather than a single file per tag (#65).
  • generate_pkg_paths() also includes parameter documentation, and parameter validation to prevent users from creating API calls that will fail due to passing the wrong parameter type (#69, #85).
  • Header and cookie parameters are handled properly by generate_pkg_paths() (#84).
  • All functions now have examples, and example configuration data is available in fs::path_package("beekeeper", "guru") and fs::path_package("beekeeper", "trello") (#99).

What's Changed

  • Increment version number to 0.4.0.9000 by @jonthegeek in #56
  • Remove checkmarks in README sub-bullets by @jonthegeek in #57
  • Fix SVG font by @jonthegeek in #60
  • File per operation by @jonthegeek in #77
  • Transfer to api2r org by @jonthegeek in #86
  • Use plain R class names in generated parameter type docs by @Copilot in #88
  • Pass header and cookie parameters to correct args in nectar::req_prepare (#84) by @Copilot in #89
  • Update oas_format_registry with better function names by @jonthegeek in #90
  • Generate request-argument validation and casting from OAS format mappings in path templates, with conditional stbl imports by @Copilot in #91
  • Update ai & condition infrastructure by @jonthegeek in #92
  • Refactor generate_pkg() to accept direct API inputs and export config/API loaders by @Copilot in #93
  • Use @returns by @jonthegeek in #94
  • Prepare to auto-document internal functions by @jonthegeek in #95
  • Document internal helpers and centralize shared internal params by @Copilot in #97
  • Make use_testthat() quiet by @jonthegeek in #98
  • Better read helpers by @jonthegeek in #100
  • Export incremental generate_pkg_*() helpers by @Copilot in #103
  • Update milestone information by @jonthegeek in #104
  • Release Candidate 0.5.0 by @jonthegeek in #107

New Contributors

  • @Copilot made their first contribution in #88

Full Changelog: v0.4.0...v0.5.0