General Comments
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api, documentation, security
Research direction
Start by locating the “Bulk Dataset via API” and “API Security” sections in the guidelines. Update the guidance to address larger datasets and assess whether TLS 1.3 should be recommended; done means both suggestions are addressed in the document.
Written by the indexing model from the issue text.
Description
The Bulk Dataset via API indicates three (3) guidelines/considerations. One of which is “small datasets”. A lot of data requests call for larger segments of data, so I’d like to see a section reference larger datasets via API’s.
API Security section – Secure Data in Transit references enabling TLS version 1.2. I know last year(?) we had to upgrade due to TLS vulnerabilities and I think(?) we moved to TLS 1.2 however there’s a transcript collision (SLOTH) in 1.2. Should we be forward-looking and recommend the build of API’s that leverage TLS 1.3?
Other than that I think this is a very well written guide.
- 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 1555 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 1/5 Under an hour Newbie friendliness 72/100
supadata-ai/mcp#27 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
objectionary/sodg.rs#300 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
topoteretes/cognee#5647 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
components-web-app/api-components-bundle#403 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
mollie/PrestaShop#1566 ·
Maintainers usually reply within 1 day