Comments (5)
The problem with this concept (regardless where it lives) is API provider upkeep. Once these tutorials are created will they get maintained, retired? In the "real world" this needs to be done in an environment with a TTL clause. If the API provider does not update their info on a regular basis then the tutorial will become inactive. This would require more than a static website or a bunch of GitHub repos.
from api3-docs.
This might be possible with an advanced component. The docs would now need and authentication method to protect each use case.
I have not heard any further conversations on the issue since Aug 10th and not sure who had came up with the idea. Keeping this issue alive for now hoping for other input.
from api3-docs.
I think this is at least partially covered by the Web3 API catalog on api3.org. For instance, the page for API provider Interzoid links to Airnode instructions and parameters for calling various endpoints.
from api3-docs.
I agree with @dcroote. Rather than doing this in our official docs it should be done in the API-provider-owned Airnode docs for each API, which are linked to with the "+ Airnode" link on the API pages on our site. I think the marketing team should provide these examples. We did something similar with Bitcoin Bankathon here. We can work with the account managers to get good examples into the API Airnode docs.
from api3-docs.
Then we have a good consensus. I am closing this issue related to the Docs supporting this idea. I
from api3-docs.
Related Issues (20)
- Create v0.11 Migration Guide branch HOT 5
- Create Airnode `v0.11` doc set HOT 1
- Change `airnode-validator` `ChainOptions` `fulfillmentGasLimit` to be optional HOT 1
- quick-deploy-container tutorial is broken: "stage" invalid HOT 2
- Have RRP fulfillments estimate gas HOT 2
- Relax engine specification for pre/post-processing HOT 1
- Create OIS `v2.0` doc set HOT 6
- Remove Oracle Developer position in careers page
- Corrections to OIS v2.0
- Verify Airnode `v0.11` uses node `v18` HOT 6
- remove `airnodeAddressShort` HOT 3
- No airnode-examples integration with both gateways enabled
- Remove `--detach` in airnode-client commands
- Implement the HTTP gateway to facilitate OEV auctions
- Add OEV GW changes to the Airnode v0.11 migration guide
- Include the deployment_id in the heartbeat payload
- Change "byog" to "Nodary" in QRNG docs HOT 1
- QRNG airnode response time in Fantom network HOT 1
- Broken links after update HOT 4
- Remove use of chainNames and networks from references.json
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api3-docs.