show_filters: Show filters available on the provided api endpoint
In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

show_filters

R Documentation

Show filters available on the provided api endpoint

Description

Most of the API endpoints have a large number of available filters. This function takes an API endpoint name and prints out all of the available filters. If 'filter_like' is provided, only those filters that contain the provided string are printed. If no endpoint name is provided, a list of available endpoints will be displayed.

Usage

show_filters(endpoint = "", filter_like = "")

Arguments

`endpoint`	the name of the api endpoint
`filter_like`	a partial string to match filter against

Details

See https://intra.glis.mnr.gov.on.ca/project_tracker/api/v1/swagger/, https://intra.glis.mnr.gov.on.ca/fn_portal/api/v1/swagger/, https://intra.glis.mnr.gov.on.ca/creels/api/v1/swagger/, and https://intra.glis.mnr.gov.on.ca/common/api/v1/swagger/ for an alternative way to view the full list of available filter keys (query parameters)

Author(s)

Adam Cottrill adam.cottrill@ontario.ca

Examples

## Not run: 
show_filters("fn125")
show_filters("fn125", filter_like = "prj")
show_filters("sc121", "mode")
show_filters("species")
show_filters("sc121", "cats")
# show_filters("foo")

## End(Not run)

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