This repository has been archived by the owner on May 1, 2024. It is now read-only.
EDUCATOR-464: Add POST method to course_summaries/ #173
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The failure you're currently seeing will go away with a |
kdmccormick
force-pushed
the
edx/kdmccormick/post-course-summaries
branch
from
4795f8d
to
289ea1f
Compare
Codecov Report
@@ Coverage Diff @@
## master #173 +/- ##
==========================================
+ Coverage 97.89% 97.91% +0.01%
==========================================
Files 54 54
Lines 3134 3164 +30
Branches 235 238 +3
==========================================
+ Hits 3068 3098 +30
Misses 42 42
Partials 24 24
Continue to review full report at Codecov.
|
kdmccormick
changed the title
kdmccormick
force-pushed
the
edx/kdmccormick/post-course-summaries
branch
from
3e557bb
to
387ddd6
Compare
kdmccormick
changed the title
kdmccormick
force-pushed
the
edx/kdmccormick/post-course-summaries
branch
2 times, most recently
from
1f47461
to
be1ec92
Compare
kdmccormick
changed the title
kdmccormick
commented
Jun 15, 2017
| return '/api/v0/{}/{}'.format(self.list_name, query_string) | ||
|
|
||
| def validated_request(self, ids=None, fields=None, exclude=None, **extra_args): |
There was a problem hiding this comment.
This is the function I'm most interested in feedback on. I'm making it so every request is done as both a GET and POST, and the results are compared before returning. Let me know what you think @efischer19.
There was a problem hiding this comment.
I like it, very nice test addition
POST method allows large number of course ID arguments to be passed as data, while GET method is restricted by URL length. EDUCATOR-464
kdmccormick
force-pushed
the
edx/kdmccormick/post-course-summaries
branch
from
be1ec92
to
ff9fb9b
Compare
efischer19
approved these changes
Jun 15, 2017
| return '/api/v0/{}/{}'.format(self.list_name, query_string) | ||
|
|
||
| def validated_request(self, ids=None, fields=None, exclude=None, **extra_args): |
There was a problem hiding this comment.
I like it, very nice test addition
dsjen
approved these changes
Jun 16, 2017
| @@ -9,3 +9,4 @@ Jason Bau <[email protected]> | |||
| John Jarvis <[email protected]> | |||
| Dmitry Viskov <[email protected]> | |||
| Eric Fischer <[email protected]> | |||
| Kyle McCormick <[email protected]> | |||
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The course_summaries/ currently supports only the GET method. A client can restrict the number of course summaries returned from the endpoint by passing in a list of desired course IDs in the
course_idsparameter. However, this is not practically usable, as the number of IDs many clients would want to pass in would make the URL too long. So, Insights currently does not use thecourse_idsparameter, and instead fetches every course summary and filters them on the client side. Fetching every summary incurs a response time of ~5s.To fix this, this PR adds a POST method to this endpoint. The POST method functions exactly the same as the GET method, except that all parameters are passed in the request body, allowing a much larger number of course IDs to be passed in. (It is understood that this is not the semantic meaning of the POST verb, however, this is not an uncommon workaround to URL length restrictions).
This PR updates the Analytics API Client to use the new POST method, and this PR updates Insights to take advantage of the course ID filtering now usable in the client.
JIRA Ticket: EDUCATOR-464.
TODO:
@edx/educator-dahlia