Generate API index metadata — generate_api_index • coMMpass

Creates the index.json content listing all available endpoints, their descriptions, and URLs for the static JSON API.

Usage

generate_api_index(
  base_url = "https://JohnGavin.github.io/coMMpass-analysis/api/v1"
)

Arguments

base_url: Base URL for the static API. Defaults to the GitHub Pages URL.

Value

A list suitable for JSON serialization containing endpoint catalogue, version, and generated timestamp.

See also

Other api: api_get_clinical(), api_get_de_results(), api_get_pathways(), api_get_survival(), api_list_datasets(), api_serve(), generate_api_endpoint()

Examples

if (FALSE) { # \dontrun{
idx <- generate_api_index()
cat(jsonlite::toJSON(idx, pretty = TRUE, auto_unbox = TRUE))
} # }