villebro opened a new pull request #16397:
URL: https://github.com/apache/superset/pull/16397


   ### SUMMARY
   <!--- Describe the change below, including rationale and design decisions -->
   While reviewing/testing #16144 , I came across a TODO related to the 
`/related` endpoints not returning total object count, but rather the count of 
results on the requested page. 
   
   This PR makes the following changes:
   - When `include_ids` is undefined, always return the total number of objects 
as the `count` parameter as opposed to the actual number of objects in `result`.
   - When `include_ids` is defined, behavior is unchanged, i.e. `count` equals 
the length of `result`.
   - When `include_ids` is defined and `page > 0`, a 400 is returned due to 
pagination of mixed results not being possible.
   
   ### BEFORE
   Currently the `count` parameter in the response is equal to the length of 
the `result` array (in this example, the total number of objects is in fact 
two, not just one):
   
![image](https://user-images.githubusercontent.com/33317356/130430642-68136936-76da-4a47-ada2-854dcbf34cf3.png)
   
   ### AFTER
   Now the `count` parameter shows the total number of objects, despite the 
page size being less:
   
![image](https://user-images.githubusercontent.com/33317356/130430128-c6efd9c4-862a-432a-97e4-2086992b46ab.png)
   
   When sending the request with `include_ids` and `page=0`, the result is the 
same as before (notice how `page_size` only affects the values not included in 
`include_ids`):
   
![image](https://user-images.githubusercontent.com/33317356/130431296-34112eaf-f5ff-41b8-afb3-fd66237dbc1f.png)
   
   Now requesting other than the first page with defined `include_ids` will 
result in a 400:
   
![image](https://user-images.githubusercontent.com/33317356/130430204-7b9c2cf8-f683-4f03-b375-647a991e980d.png)
   
   
   ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
   <!--- Skip this if not applicable -->
   
   ### TESTING INSTRUCTIONS
   <!--- Required! What steps can be taken to manually verify the changes? -->
   
   ### ADDITIONAL INFORMATION
   <!--- Check any relevant boxes with "x" -->
   <!--- HINT: Include "Fixes #nnn" if you are fixing an existing issue -->
   - [ ] Has associated issue:
   - [ ] Required feature flags:
   - [ ] Changes UI
   - [ ] Includes DB Migration (follow approval process in 
[SIP-59](https://github.com/apache/superset/issues/13351))
     - [ ] Migration is atomic, supports rollback & is backwards-compatible
     - [ ] Confirm DB migration upgrade and downgrade tested
     - [ ] Runtime estimates and downtime expectations provided
   - [ ] Introduces new feature or API
   - [ ] Removes existing feature or API
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to