Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document lack of versioning in request method. #323

Open
martey opened this issue Oct 27, 2016 · 2 comments
Open

Document lack of versioning in request method. #323

martey opened this issue Oct 27, 2016 · 2 comments

Comments

@martey
Copy link
Member

martey commented Oct 27, 2016

@dursk raised a great and prescient point in an message on the Google Group several months ago:

Either request() should be marked private as _request(), or, since the API calls funnel through request(), the versioning should be handled within this method rather than passed to this method by all callers.

Since then, multiple people have suggested the latter solution (see #284 and #302). As I mentioned in those issues, I think the latter solution will end up causing additional issues. I think the former solution (suggesting that the request method is private and should not be used unless you know what you are doing) is better.

@martey martey added this to the v3.0.0 milestone Oct 27, 2016
@martey
Copy link
Member Author

martey commented Oct 27, 2016

Also see e3a7c11, which removes versioning from request().

@martey
Copy link
Member Author

martey commented Aug 18, 2017

I think I disagree with my earlier comments. Making the request method private might stop people from using it, which isn't really what we want (request() exists so that advanced Graph API functionality not covered by the builtin methods can still be used).

I think a better solution would be to document the fact that request() doesn't use versions for flexibility, and that people using it need to add it in themselves. I am keeping this on the v3.0.0 milestone since people understandably continue to be confused by this (see #382 for example).

@martey martey changed the title Make request method private. Document lack of versioning in request method. Aug 18, 2017
@martey martey modified the milestones: v3.0.0, v3.1.0 Jul 19, 2018
@martey martey modified the milestones: v3.1.0, v3.2.0 Nov 6, 2018
@martey martey modified the milestones: v3.2.0, v5.0.0 Jul 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant