microsoftgraph / microsoftgraph/msgraph-sdk-python
Document backing store
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 630
- Forks
- 96
- Avg merge
- 15h 20m
- Merged PRs (30d)
- 3
Description
Is your feature request related to a problem? Please describe.
When I first used this SDK, I modified objects that were returned but just for the needs of my script, with no intention of pushing back to the API the modifications. It didn't work properly and I had a couple of issues that I didn't understand at first, until I noticed that this SDK uses a notion of "backing store". I didn't dig deeper what it was but now I understand thanks to this description in the Java Graph SDK for the "backing store" and "dirty" mechanisms which I believe are the same as in this Python SDK.
Describe the solution you'd like
If it's indeed the same thing, please raise awareness about it in the README (or elsewhere) to reduce confusion
Describe alternatives you've considered
Perhaps I could have spent more time and managed to find the article myself, or this https://learn.microsoft.com/en-us/openapi/kiota/models#backing-store
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
Review the README and the linked Microsoft Graph Java and Kiota backing-store descriptions. Confirm how the Python SDK's backing store and dirty mechanisms behave, then document them in the README or another appropriate location so users understand when returned-object changes are tracked or sent back to the API.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100