From GIS CoP
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Domain
- api, documentation
Research direction
No implementation file or test is named. Start by reviewing the existing API Guidelines and the questions about cataloguing, documentation, API keys, and authentication; done means turning an agreed scope into guidance or clearly recording where consumers find these resources.
Written by the indexing model from the issue text.
Description
Feedback sent via API Guidelines from Yammer (GIS CoP):
William Burt (FLNRORD, Regional Geomatics Specialist, Kootenay Boundary Region)
–
This guidance looks great. Likely I won't be developing an api anytime soon but perhaps I would be a consumer. Many of bcgov api are purpose built for and limited to one application. To animate the new data story line that is being presented access needs to be open to other consumers with un-forcasted use cases.
Here are some questions I expect this COP would have:- Are our APIs catalogued and documented like data? If I need documentation, an api key or authentication where would someone go?
- Dominant language
- No language data
- Stars
- 34
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bcgov/api-guidelines
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
bcgov/api-guidelines#34 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
bcgov/api-guidelines#33 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
bcgov/api-guidelines#32 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
bcgov/api-guidelines#31 ·
-
It's Been a While Since This Repository has Been UpdatedMay be free again @jeff-card claimed this 1563 days ago, and no pull request is open. Open
bcgov/api-guidelines#28 · 3 comments · 2 assignees ·
All issues in bcgov/api-guidelines
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
BC remittance upload: a claim MSP refused (S03) is saved with a blank status instead of refused (F)Opentype: bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
carlos-emr/carlos#4933 ·
Maintainers usually reply within 1 day
-
Authentication / Authorization Feature: Volunteer
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Emanuele-web04/remodex#203 ·
Maintainers usually reply within 1 day
-
area:protocol bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
Maintainers usually reply within 1 day