Include information about client name and version when calling server API.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api
Research direction
Start by locating where clients make requests to the server API and where request metadata is defined. Review the linked Stack Overflow discussion and the proposed X-Client-Name and X-Client-Version headers; done means API calls identify the client and its version consistently.
Written by the indexing model from the issue text.
Description
As a service provider it is important to identify clients which consume an API and their version. Reason being, sometimes there are bad requests, buggy versions, deprecate old versions, etc.
A suggestion is to use X-Client-Name and X-Client-Version.
- Dominant language
- No language data
- Stars
- 39
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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 buildingSMART/foundation-API
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 42/100
buildingSMART/foundation-API#41 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
buildingSMART/foundation-API#39 · 1 comment · 2 reactions ·
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
buildingSMART/foundation-API#27 · 1 comment · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
buildingSMART/foundation-API#26 · 3 comments ·
All issues in buildingSMART/foundation-API
Similar issues
-
comp/tools P2 platform/telegram sweeper:risk-message-delivery type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 61/100
NousResearch/hermes-agent#133164 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Under an hour Newbie friendliness 90/100
huggingface/huggingface_hub#5083 ·
Maintainers usually reply within 1 day
-
Bouncer: long messages are re-split at 350 bytes, breaks echo-message reconciliationPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day