Review and save names and servers for multiple APIs
configure_apis.RdDiscover local schemas and review API names, server URLs and inclusion in one table. Names are proposed from schema titles rather than filenames.
Usage
configure_apis(root, schemas = NULL, origins = NULL, choices = NULL,
review = NULL, mode = c("plan", "apply"))Arguments
- root
Existing project directory.
- schemas
Local JSON, YAML, or YML schema paths inside root. Defaults to those extensions directly inside root, excluding specmill project and catalogue configuration files.
- origins
Optional character vector of download URLs, named by schema path relative to root. Used to resolve relative servers.
- choices
Optional data frame keyed by schema with api, base_url or include columns for scripted review.
- review
Open the table in R's data editor for one review of names, base URLs and include flags. Requires an interactive session. NULL opens the editor only for new or changed schemas in an interactive session; saved unchanged choices do not prompt again.
- mode
Plan returns the table without writing. Apply saves validated selections to specmill-apis.yml.
Details
Saved selections are reused by schema path, or by canonical content hash after renaming a file. Equivalent JSON and YAML documents with reordered object keys have the same identity. New duplicate content is deselected; distinct schemas with duplicate titles receive hash suffixes for review. Ambiguous or missing servers require an explicit choice. This catalogue prepares multi-API setup; it does not itself generate wrappers or request helpers.