search

NetAppDocs / ontap-automation

https://docs.netapp.com/us-en/ontap-automation/
1 stars 2 forks source link

The requirement to use the start=1& in the API call is not documented. #68

Closed binder1234 closed 11 months ago

binder1234 commented 12 months ago

Page URL

https://docs.netapp.com/us-en/ontap-automation/rest/input_variables.html

Page title

Input variables controlling an API request

Summary

We recently ran into an issue where a customer was making a call and wanted to limit the response.

This was ignored in the response because the customer specified 'limit=' and not 'start=1&limit='

This requirement is not documented.

Public issues must not contain sensitive information

dmp-netapp commented 12 months ago

Thanks for your feedback. We are reviewing this.

dmp-netapp commented 11 months ago

What is the customer actually trying to limit? Is this the number of records (objects) returned in a response? If so, have they tried using the query parameter "max_records=" which is documented on the same page?

I've reviewed the page and don't believe we document a parameter "limit=" and so the question is, where did they get this parameter from?

This is a technical question and I have reached out to the engineering team for an opinion.

dmp-netapp commented 11 months ago

I've confirmed with engineering that "limit=" is not a standard query parameter in the ONTAP REST API. Just curious, can they point to exactly where they got this parameter from and why they're trying to use it?

And again, can they try to use the query parameter "max_records" instead?

I don't see a documentation issue at this time and will wait more feedback as indicated above.

dmp-netapp commented 11 months ago

Robert Binder had opened this ticket but this is not the correct place for it. He said it's OK to close.