microsoft / microsoft/api-guidelines
GET urls often fail to meet the relevant spec standards
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
For example,
GET https://api.contoso.com/v1.0/people?$filter=name eq 'david'&$orderBy=hireDate
In this example, the success of this request is contingent on the HTTP client replacing with%20. Are you sure that's what you mean here? I notice also you don't make mention of potential SQL injection and similar issues arising from such a request-driven-dsl in this case.
Contributor 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.
Research direction
Start by locating the guideline section containing the GET example and review the relevant URL-encoding and request-driven DSL guidance. Done means the guidance clearly addresses spaces in query expressions and the potential SQL-injection concerns raised by this issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100