get_api_filters: Create global list of available API filters

View source: R/get_api_filters.R

get_api_filtersR Documentation

Create global list of available API filters

Description

This function connects to the openapi/swagger endpoint provided by fn_portal, creels, and common APIs and fetches all of the available filters for each endpoint. The filters are available in a global list 'api_filters' which subsequently used by other functions - check_filters, show_filters. Generally, this function is not intended to be called directly by the user.

Usage

get_api_filters(api_app, create_list = TRUE)

Arguments

api_app
  • the name of the api application to fetch the filters from.

create_list
  • create the global list of api_filters if it does not exist? Defaults to True.

Value

list

Author(s)

Adam Cottrill adam.cottrill@ontario.ca


AdamCottrill/glfishr documentation built on Aug. 9, 2024, 5:47 p.m.