Stronger Functions banners in Any API pages (#2275)

* Stronger Functions banners in Any API pages * Revert earlier changes to Basic Request Model description
smartcontractkit · Jan 24, 2025 · 0542021 · 0542021
1 parent 7e110d0
commit 0542021
Show file tree

Hide file tree

Showing 13 changed files with 38 additions and 67 deletions.
diff --git a/src/content/any-api/api-reference.mdx b/src/content/any-api/api-reference.mdx
@@ -8,6 +8,8 @@ isMdx: true
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
+<AnyApiCallout callout="usefunctions" />
+
 <Aside type="note" title="API reference for ChainlinkClient">
 
 `ChainlinkClient` [contracts](https://github.com/smartcontractkit/chainlink/blob/develop/contracts/src/v0.8/ChainlinkClient.sol)

diff --git a/src/content/any-api/find-oracle.mdx b/src/content/any-api/find-oracle.mdx
@@ -8,13 +8,11 @@ whatsnext: { "API Reference": "/any-api/api-reference/", "Testnet Oracles": "/an
 
 import { Aside } from "@components"
 
-This page explains how to find an existing Oracle Job to suit the needs of your API call.
+import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
+
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+This page explains how to find an existing Oracle Job to suit the needs of your API call.
 
 ## Introduction to Oracles
 

diff --git a/src/content/any-api/get-request/examples/array-response.mdx b/src/content/any-api/get-request/examples/array-response.mdx
@@ -15,13 +15,9 @@ whatsnext:
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-This guide explains how to make an HTTP GET request to an external API, that returns a _json_ array, from a smart contract, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and then receive the needed data from the array.
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+This guide explains how to make an HTTP GET request to an external API, that returns a _json_ array, from a smart contract, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and then receive the needed data from the array.
 
 <AnyApiCallout callout="prerequisites" />
 

diff --git a/src/content/any-api/get-request/examples/existing-job-request.mdx b/src/content/any-api/get-request/examples/existing-job-request.mdx
@@ -18,13 +18,9 @@ metadata:
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-Using an _existing_ Oracle Job makes your smart contract code more succinct. This page explains how to retrieve the gas price from an existing Chainlink job that calls [etherscan gas tracker API](https://docs.etherscan.io/api-endpoints/gas-tracker#get-gas-oracle).
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+Using an _existing_ Oracle Job makes your smart contract code more succinct. This page explains how to retrieve the gas price from an existing Chainlink job that calls [etherscan gas tracker API](https://docs.etherscan.io/api-endpoints/gas-tracker#get-gas-oracle).
 
 <AnyApiCallout callout="prerequisites" />
 

diff --git a/src/content/any-api/get-request/examples/large-responses.mdx b/src/content/any-api/get-request/examples/large-responses.mdx
@@ -14,13 +14,9 @@ whatsnext:
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-This guide explains how to make an HTTP GET request to an external API from a smart contract, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and then receive large responses.
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+This guide explains how to make an HTTP GET request to an external API from a smart contract, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and then receive large responses.
 
 <AnyApiCallout callout="prerequisites" />
 

diff --git a/src/content/any-api/get-request/examples/multi-variable-responses.mdx b/src/content/any-api/get-request/examples/multi-variable-responses.mdx
@@ -16,15 +16,11 @@ whatsnext:
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
+<AnyApiCallout callout="usefunctions" />
+
 This guide explains how to make an HTTP GET request to an external API from a smart contract, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and then receive multiple responses.
 This is known as **multi-variable** or **multi-word** responses.
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
-
 <AnyApiCallout callout="prerequisites" />
 
 ## Example

diff --git a/src/content/any-api/get-request/examples/single-word-response.mdx b/src/content/any-api/get-request/examples/single-word-response.mdx
@@ -21,13 +21,9 @@ metadata:
 import { Aside, CodeSample } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-This guide explains how to make an HTTP GET request to an external API from a smart contract using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and receive a single response.
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+This guide explains how to make an HTTP GET request to an external API from a smart contract using Chainlink's [Request & Receive Data](/any-api/introduction) cycle and receive a single response.
 
 <AnyApiCallout callout="prerequisites" />
 

diff --git a/src/content/any-api/get-request/introduction.mdx b/src/content/any-api/get-request/introduction.mdx
@@ -22,13 +22,9 @@ metadata:
 import { Aside } from "@components"
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-This series of guides explains how to make HTTP GET requests to external APIs from smart contracts, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle.
+<AnyApiCallout callout="usefunctions" />
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+This series of guides explains how to make HTTP GET requests to external APIs from smart contracts, using Chainlink's [Request & Receive Data](/any-api/introduction) cycle.
 
 <AnyApiCallout callout="common" />
 

diff --git a/src/content/any-api/getting-started.mdx b/src/content/any-api/getting-started.mdx
@@ -11,19 +11,9 @@ metadata:
 
 import { Aside, CodeSample } from "@components"
 import { YouTube } from "@astro-community/astro-embed-youtube"
+import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
-
-<Aside type="note" title="Requirements">
-  This guide requires basic knowledge about smart contracts. If you are new to smart contract development, learn how to
-  [Deploy Your First Smart Contract](/quickstarts/deploy-your-first-contract) before you begin.
-</Aside>
-
-<YouTube id="https://www.youtube.com/watch?v=ay4rXZhAefs" />
+<AnyApiCallout callout="usefunctions" />
 
 In this guide, you will learn how to request data from a public API in a smart contract. This includes understanding what Tasks and External adapters are and how Oracle Jobs use them. You will also learn how to find the Oracle Jobs and Tasks for your contract and how to request data from an Oracle Job.
 

diff --git a/src/content/any-api/introduction.mdx b/src/content/any-api/introduction.mdx
@@ -19,18 +19,9 @@ metadata:
 import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 import { Aside } from "@components"
 
-<Aside type="note" title="Talk to an expert">
-  <a href="https://chain.link/contact?ref_id=AnyAPI">Contact us</a> to talk to an expert about using Chainlink Any API
-  to get your data on chain.
-</Aside>
-
-<Aside type="note" title="Chainlink Functions">
-  Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to
-  fetch data from APIs and perform custom computation. Read the [Chainlink Functions
-  documentation](/chainlink-functions) to learn more.
-</Aside>
+<AnyApiCallout callout="usefunctions" />
 
-**Connecting to any API** with Chainlink enables your contracts to access to _any_ external data source through our decentralized oracle network. We understand making smart contracts compatible with offchain data adds to the complexity of building smart contracts. We created a framework with minimal requirements, yet unbounded flexibility, so developers can focus more on the functionality of smart contracts rather than what feeds them. Chainlink’s decentralized oracle network provides smart contracts with the ability to push and pull data, facilitating the interoperability between onchain and offchain applications.
+**Connecting to any API** with Chainlink enables your contracts to access to _any_ external data source through our decentralized oracle network. We understand making smart contracts compatible with offchain data adds to the complexity of building smart contracts. We created a framework with minimal requirements, yet unbounded flexibility, so developers can focus more on the functionality of smart contracts rather than what feeds them. Chainlink's decentralized oracle network provides smart contracts with the ability to push and pull data, facilitating the interoperability between onchain and offchain applications.
 
 Whether your contract requires sports results, the latest weather, or any other publicly available data, the [Chainlink contract library](https://github.com/smartcontractkit/chainlink/tree/master/contracts) provides the tools required for your contract to consume it.
 

diff --git a/src/content/any-api/testnet-oracles.mdx b/src/content/any-api/testnet-oracles.mdx
@@ -10,8 +10,9 @@ metadata:
 ---
 
 import { Aside } from "@components"
+import AnyApiCallout from "@features/any-api/common/AnyApiCallout.astro"
 
-The Chainlink Developer Relations team maintains several testnet oracles that you can use to test your implementation quickly.
+<AnyApiCallout callout="usefunctions" />
 
 <Aside type="tip" title="Link token address and Faucet details">
 

diff --git a/src/features/any-api/common/AnyApiCallout.astro b/src/features/any-api/common/AnyApiCallout.astro
@@ -5,11 +5,15 @@ const CommonComponent = common[0].Content
 const prerequisites = await Astro.glob("./CommonPrerequisites.mdx")
 const PrerequisitesComponent = prerequisites[0].Content
 
+const usefunctions = await Astro.glob("./UseFunctions.mdx")
+const UseFunctionsComponent = usefunctions[0].Content
+
 export type Props = {
-  callout?: "common" | "prerequisites"
+  callout?: "common" | "prerequisites" | "usefunctions"
 }
 const { callout } = Astro.props as Props
 ---
 
 {callout === "common" && <CommonComponent />}
 {callout === "prerequisites" && <PrerequisitesComponent />}
+{callout === "usefunctions" && <UseFunctionsComponent />}
diff --git a/src/features/any-api/common/UseFunctions.mdx b/src/features/any-api/common/UseFunctions.mdx
@@ -0,0 +1,9 @@
+import { Aside } from "@components"
+
+<Aside type="caution" title="Use Chainlink Functions">
+The Any API docs remain as a public historical reference for node operators. Please use Chainlink Functions instead.
+
+Chainlink Functions provides your smart contracts access to trust-minimized compute infrastructure, allowing you to fetch data from APIs and perform custom computation. Read the [Chainlink Functions
+documentation](/chainlink-functions) to learn more.
+
+</Aside>