microsoft / microsoft/api-guidelines

PII used in example of good URL

Open
#190 0 comments 1 reaction 0 assignees View on GitHub

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

Your example of a well structured URL:

https://api.contoso.com/v1.0/people/jdoe@contoso.com/inbox

in URL Structure includes PII in the URL which is prohibited in PII parameters

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open Guidelines.md and read the URL Structure section alongside the PII parameters section linked in the issue. Locate the well-structured URL example, revise the example so it does not contain PII, and confirm the surrounding guidance remains consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.