microsoftgraph / microsoftgraph/msgraph-sdk-dotnet

V5 upgrade guide should contain information about the use of URL templates

Open
#2,541 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Request: documentation
Dominant language
C#
Stars
789
Forks
264
Avg merge
15h 17m
Merged PRs (30d)
3

Description

We have customers who were URL encoding before passing in data to SDK in versions <5 which causes double encoding issues when they upgrade to v5. Our v5 upgrade guide should contain guidance around this.
 

Closing this one for now as this is resolved with V5 of the SDK which uses URL templates that automatically encode the URL segments based on the HTTP specification

Originally posted by @andrueastman in https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/1515#issuecomment-1469997376

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

Update docs/upgrade-to-v5.md, the v5 upgrade guide named in the issue. Start by reviewing the existing URL and encoding guidance, then document that pre-v5 callers should not URL-encode values before passing them to the SDK because v5 URL templates encode URL segments automatically. Done means the guide explains the double-encoding upgrade issue clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.