api-guidelines
api-guidelines copied to clipboard
bcgov
BC Government API Guidelines
## No Project Lifecycle Badge found in your readme! Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to...
![repo-mountie[bot] avatar](https://avatars.githubusercontent.com/in/19327?v=4 "repo-mountie[bot] avatar"){kind=avatar}
This issue is a kind reminder that your repository has been inactive for 181 days. Some repositories are maintained in accordance with business requirements that infrequently change thus appearing inactive,...
> path: (do not delete) https://github.com/bcgov/api-guidelines/blob/master/government-of-british-columbia-api-guidelines.md > (do not delete) devhub page: https://developer.gov.bc.ca/Data-and-APIs/BC-Government-API-Guidelines ## Devhub Content Issue Some things aren't displayed correctly in the guidelines web page. The image below...
> path: (do not delete) https://github.com/bcgov/api-guidelines/blob/master/government-of-british-columbia-api-guidelines.md > (do not delete) devhub page: undefined ## Devhub Content Issue ❗ not inserted correctly - see: 
> path: (do not delete) https://github.com/bcgov/api-guidelines/blob/master/government-of-british-columbia-api-guidelines.md > (do not delete) devhub page: undefined ## Devhub Content Issue API with security by design is briefly mentioned, OWASP security principles can be...
The link attached to the GovBC API Catalog I believe has a built in language setting. (Hebrew - Currently in Document) https://catalogue.data.gov.bc.ca/he/group/bc-government-api-registry (English) https://catalogue.data.gov.bc.ca/en/group/bc-government-api-registry (Default) https://catalogue.data.gov.bc.ca/group/bc-government-api-registry Was quite confused when...
Overall, a pretty good document. Handling version info in a header is brilliant. Here are a few proposed additions: ## Spatial considerations ### Map projection 1. Use an srs parameter...
Working in 'vertical slices' (API, testing, database, UI) is a keystone habit for Agile Product development. API First implies a horizontal development pattern where the API goes to a 'Backend'...
> services SHOULD include a Link header (see [RFC 5988](https://tools.ietf.org/html/rfc5988)) to point to documentation for the resource in question. ``` Link: ; rel="help" ``` RFC 5988: > Relation Name: help...
Include guidelines around IP Whitelisting for partner-facing APIs that are not intended for the general public.
