{"note":"OpenAPI conversion -- returning structured metadata","name":"gov-bc-ca-bcdc","description":"BC Data Catalogue API","version":"3.0.1","base_url":"https://catalogue.data.gov.bc.ca/api/3","endpoints":22,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api BC Data Catalogue API\n@base https://catalogue.data.gov.bc.ca/api/3\n@version 3.0.1\n@auth OAuth2 | ApiKey ckan_api_key in header\n@endpoints 22\n@hint download_for_search\n@toc action(22)\n\n@endpoint GET /action/tag_list\n@desc Get a list of tags\n@optional {offset: int=0 # The offset (index) of the first tag to return, limit: int=100 # The number of tags to be returned per page}\n@returns(200) List of tags\n\n@endpoint GET /action/status_show\n@desc Get the site status\n@returns(200) Returns the site status, version, installed extensions\n\n@endpoint GET /action/package_list\n@desc Get a list of all packages (datasets)\n@optional {offset: int=0 # The offset (index) of the first package to return, limit: int=100 # The number of packages to be returned per page}\n@returns(200) List of packages\n\n@endpoint GET /action/package_search\n@desc Find packages (datasets) matching query terms\n@optional {q: str=\"Okanagan Lake\" # A query string}\n@returns(200) List of packages\n\n@endpoint GET /action/package_show\n@desc Get metadata about one specific package (dataset)\n@optional {id: str=grizzly-bear-population-units # The package name}\n@returns(200) A package metadata object\n\n@endpoint GET /action/package_activity_list\n@desc Get the activity stream of a package (dataset)\n@optional {id: str=grizzly-bear-population-units # The id or name of the package, offset: int=0 # Where to start getting activity items from, limit: int=31 # The maximum number of activities to return}\n@returns(200) List of activities\n\n@endpoint GET /action/package_activity_list_html\n@desc Get the activity stream of a package (dataset), HTML format\n@optional {id: str=grizzly-bear-population-units # The id or name of the package, offset: int=0 # Where to start getting activity items from, limit: int=31 # The maximum number of activities to return}\n@returns(200) List of activities rendered as HTML snippet\n\n@endpoint GET /action/package_autocomplete\n@desc Find packages (datasets) matching a query\n@optional {q: str=\"Okanagan Lake\" # The string to query, limit: int=10 # The maximum number of resource formats to return}\n@returns(200) List of datasets that match a string\n\n@endpoint GET /action/package_relationships_list\n@desc Get package (dataset) relationships\n@optional {id: str=grizzly-bear-population-units # The id or name of the first package, id2: str=important-fossil-areas # The id or name of the second package, rel: str # relationship as string}\n@returns(200) List of dataset relationships\n\n@endpoint GET /action/package_revision_list\n@desc Get list of revisions for a package (dataset)\n@optional {id: str=grizzly-bear-population-units # The id or name of the dataset}\n@returns(200) List of dataset revisions\n\n@endpoint GET /action/organization_activity_list\n@desc Get the activity stream of an organization\n@optional {id: str=ministry-of-agriculture # The id or name of the organization}\n@returns(200) List of an organization's activities\n\n@endpoint GET /action/organization_activity_list_html\n@desc Get the activity stream of an organization, HTML format\n@optional {id: str=ministry-of-agriculture # The id or name of the organization}\n@returns(200) List of an organization's activities in HTML\n\n@endpoint GET /action/organization_follower_count\n@desc Get number of followers of an organization\n@optional {id: str=ministry-of-agriculture # The id or name of the organization}\n@returns(200) Count of organization followers\n\n@endpoint GET /action/organization_follower_list\n@desc Get users following an organization\n@optional {id: str=ministry-of-agriculture # The id or name of the organization}\n@returns(200) List of organization followers\n\n@endpoint GET /action/organization_list_for_user\n@desc Get organizations that a user has a given permission for\n@optional {permission: str=\"edit_group\" # The permission the user has against the returned organization}\n@returns(200) List of organizations for given permission\n\n@endpoint GET /action/organization_revision_list\n@desc Get organization revisions\n@optional {id: str=ministry-of-agriculture # The name or id of the organization}\n@returns(200) List of an organization's revisions\n\n@endpoint GET /action/organization_show\n@desc Get details of a specific organization\n@optional {id: str=ministry-of-agriculture # The id or name of the organization, include_datasets: bool=true # include a list of the organization's datasets}\n@returns(200) List organization details\n\n@endpoint GET /action/organization_list\n@desc Get names of all organizations\n@optional {offset: int=0 # The offset (index) of the first organizations to return, limit: int=100 # The number of organizations to be returned per page}\n@returns(200) List of organizations\n\n@endpoint GET /action/organization_autocomplete\n@desc Get names of organizations that match a query string\n@optional {q: str=ministry # The string to search for, limit: int=20 # The maximum number of organizations to return (optional)}\n@returns(200) List of organizations\n\n@endpoint GET /action/resource_search\n@desc Find resources\n@optional {query: str=format:csv # The search criteria string or list of strings of the form ``{field}:{term1}``, fields: str # Depreciated, order_by: str # A field on the resource model that orders the results, offset: int=0 # Apply an offset to the query, limit: int=0 # Apply a limit to the query}\n@returns(200) Search for resources\n\n@endpoint GET /action/resource_show\n@desc Get metadata for a specific resource\n@optional {id: str=e6c8bb1d-3726-418b-9b7e-1d97a9bbb817 # The id of the resource, include_tracking: bool=false # Add tracking information to dataset}\n@returns(200) Return metadata of a resource\n\n@endpoint GET /action/related_list\n@desc Gets items related to a package (dataset)\n@optional {id: str # id or name of the dataset (optional), dataset: str # Dataset dictionary of the dataset (optional), type_filter: str # The type of related item to show (optional), sort: str # The order to sort the related items in, featured: str # whether or not to restrict the results to only featured items}\n@returns(200) Search for related items\n\n@end\n"}