api3dao / old-api3-docs

Documentation for the API3 Project

Home Page:https://docs.api3.org/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Allow API call to be skipped in endpoints

amarthadan opened this issue · comments

Documentation for api3dao/airnode#1527
One of the TODOs from the Migration guide should be part of this issue (#1174 (comment))

I think we still need a short explanation (maybe a brief use case) as to why one would want to skip the API call.

@aTeoke , @metobom - I am working on this one today. Adding myself as an assignee.

@metobom and @aTeoke
Please check this review at these preview links or in the code.

@metobom and @aTeoke Please check this review at these preview links or in the code.

  • Is API provider call the right term? Should it be just API call?
  • I did not think of it but, in the random number generation example output will always be zero since Math.random() returns between 0 and 1 and _type in reservedParameters is uint256. If that's a problem, it can be changed to Math.floor(Math.random() * 100) to make it return between 0 and 100.

Let's change the example please.

Is API provider call the right term? Should it be just API call?

I am fine either way:

  • (Required: when calling an API provider operation) > becomes > (Required: when calling an API)
  • Instead of calling an API provider operation > becomes > Instead of calling an API

@amarthadan - I updated the Airnode v0.10 migrations guide with regards to skipping an API call. It will show up in the next push to this PR.

@metobom @aTeoke @amarthadan - The PR has been updated with all requested changes. Please let me know if I can merge.

All good from my side