@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api BC Data Catalogue API
@base https://catalogue.data.gov.bc.ca/api/3
@version 3.0.1
@auth OAuth2 | ApiKey ckan_api_key in header
@endpoints 22
@hint download_for_search
@toc action(22)

@endpoint GET /action/tag_list
@optional {offset: int=0, limit: int=100}
@returns(200)

@endpoint GET /action/status_show
@returns(200)

@endpoint GET /action/package_list
@optional {offset: int=0, limit: int=100}
@returns(200)

@endpoint GET /action/package_search
@optional {q: str="Okanagan Lake"}
@returns(200)

@endpoint GET /action/package_show
@optional {id: str=grizzly-bear-population-units}
@returns(200)

@endpoint GET /action/package_activity_list
@optional {id: str=grizzly-bear-population-units, offset: int=0, limit: int=31}
@returns(200)

@endpoint GET /action/package_activity_list_html
@optional {id: str=grizzly-bear-population-units, offset: int=0, limit: int=31}
@returns(200)

@endpoint GET /action/package_autocomplete
@optional {q: str="Okanagan Lake", limit: int=10}
@returns(200)

@endpoint GET /action/package_relationships_list
@optional {id: str=grizzly-bear-population-units, id2: str=important-fossil-areas, rel: str}
@returns(200)

@endpoint GET /action/package_revision_list
@optional {id: str=grizzly-bear-population-units}
@returns(200)

@endpoint GET /action/organization_activity_list
@optional {id: str=ministry-of-agriculture}
@returns(200)

@endpoint GET /action/organization_activity_list_html
@optional {id: str=ministry-of-agriculture}
@returns(200)

@endpoint GET /action/organization_follower_count
@optional {id: str=ministry-of-agriculture}
@returns(200)

@endpoint GET /action/organization_follower_list
@optional {id: str=ministry-of-agriculture}
@returns(200)

@endpoint GET /action/organization_list_for_user
@optional {permission: str="edit_group"}
@returns(200)

@endpoint GET /action/organization_revision_list
@optional {id: str=ministry-of-agriculture}
@returns(200)

@endpoint GET /action/organization_show
@optional {id: str=ministry-of-agriculture, include_datasets: bool=true}
@returns(200)

@endpoint GET /action/organization_list
@optional {offset: int=0, limit: int=100}
@returns(200)

@endpoint GET /action/organization_autocomplete
@optional {q: str=ministry, limit: int=20}
@returns(200)

@endpoint GET /action/resource_search
@optional {query: str=format:csv, fields: str, order_by: str, offset: int=0, limit: int=0}
@returns(200)

@endpoint GET /action/resource_show
@optional {id: str=e6c8bb1d-3726-418b-9b7e-1d97a9bbb817, include_tracking: bool=false}
@returns(200)

@endpoint GET /action/related_list
@optional {id: str, dataset: str, type_filter: str, sort: str, featured: str}
@returns(200)

@end