Skip to content

Commit b112daf

Browse files
khadnikhadni
authored
Add callouts for URL redirects (#3301)
* add callouts for url redirects * add callouts for url redirects * nit update
1 parent baf1a2c commit b112daf

File tree

11 files changed

+104
-24
lines changed

11 files changed

+104
-24
lines changed

‎reports/llms-report.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
{
2-
"startedAt": "2025-12-15T18:30:25.869Z",
2+
"startedAt": "2025-12-16T15:44:36.319Z",
33
"siteBase": "https://docs.chain.link",
44
"sections": [
55
{
66
"section": "cre-go",
77
"pagesProcessed": 84,
88
"outputPath": "src/content/cre/llms-full-go.txt",
9-
"bytes": 673266,
10-
"prevBytes": 673266,
9+
"bytes": 674210,
10+
"prevBytes": 674210,
1111
"deltaBytes": 0
1212
},
1313
{
1414
"section": "cre-ts",
1515
"pagesProcessed": 79,
1616
"outputPath": "src/content/cre/llms-full-ts.txt",
17-
"bytes": 629202,
18-
"prevBytes": 629202,
17+
"bytes": 630146,
18+
"prevBytes": 630146,
1919
"deltaBytes": 0
2020
},
2121
{
2222
"section": "vrf",
2323
"pagesProcessed": 35,
2424
"outputPath": "src/content/vrf/llms-full.txt",
2525
"bytes": 301005,
26-
"prevBytes": 301012,
27-
"deltaBytes": -7
26+
"prevBytes": 301005,
27+
"deltaBytes": 0
2828
},
2929
{
3030
"section": "ccip",
@@ -39,8 +39,8 @@
3939
"pagesProcessed": 37,
4040
"outputPath": "src/content/data-feeds/llms-full.txt",
4141
"bytes": 302811,
42-
"prevBytes": 302816,
43-
"deltaBytes": -5
42+
"prevBytes": 302811,
43+
"deltaBytes": 0
4444
},
4545
{
4646
"section": "data-streams",
@@ -87,8 +87,8 @@
8787
"pagesProcessed": 12,
8888
"outputPath": "src/content/resources/llms-full.txt",
8989
"bytes": 340405,
90-
"prevBytes": 340412,
91-
"deltaBytes": -7
90+
"prevBytes": 340405,
91+
"deltaBytes": 0
9292
},
9393
{
9494
"section": "architecture-overview",
@@ -123,5 +123,5 @@
123123
"deltaBytes": 0
124124
}
125125
],
126-
"finishedAt": "2025-12-15T18:30:30.307Z"
126+
"finishedAt": "2025-12-16T15:44:40.643Z"
127127
}

‎src/content/cre/guides/workflow/using-http-client/get-request-go.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pageId: "guides-workflow-http-get-request"
77
metadata:
88
description: "Fetch data from APIs in Go: learn to make GET requests with consensus validation to bring offchain data into your workflow."
99
datePublished: "2025-11-04"
10-
lastModified: "2025-11-04"
10+
lastModified: "2025-12-16"
1111
---
1212

1313
import { Aside } from "@components"
@@ -23,6 +23,11 @@ All HTTP requests are wrapped in a consensus mechanism to provide a single, reli
2323

2424
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
2525

26+
{/* prettier-ignore */}
27+
<Aside type="caution" title="Redirects are not supported">
28+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
29+
</Aside>
30+
2631
## Choosing your approach
2732

2833
### Use `http.SendRequest` (Section 1) when:

‎src/content/cre/guides/workflow/using-http-client/get-request-ts.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pageId: "guides-workflow-http-get-request"
77
metadata:
88
description: "Fetch data from APIs in TypeScript: learn to make GET requests with consensus validation to bring offchain data into your workflow."
99
datePublished: "2025-11-04"
10-
lastModified: "2025-11-04"
10+
lastModified: "2025-12-16"
1111
---
1212

1313
import { Aside } from "@components"
@@ -23,6 +23,11 @@ All HTTP requests are wrapped in a consensus mechanism to provide a single, reli
2323

2424
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
2525

26+
{/* prettier-ignore */}
27+
<Aside type="caution" title="Redirects are not supported">
28+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
29+
</Aside>
30+
2631
## Choosing your approach
2732

2833
### Use `sendRequest` (Section 1) when:

‎src/content/cre/guides/workflow/using-http-client/post-request-go.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pageId: "guides-workflow-http-post-request"
77
metadata:
88
description: "Send data to external APIs in Go: learn to make POST requests from your workflow with authentication and custom headers."
99
datePublished: "2025-11-04"
10-
lastModified: "2025-11-04"
10+
lastModified: "2025-12-16"
1111
---
1212

1313
import { Aside } from "@components"
@@ -52,6 +52,11 @@ For this example, we will use <a href="https://webhook.site/" target="_blank">**
5252

5353
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
5454

55+
{/* prettier-ignore */}
56+
<Aside type="caution" title="Redirects are not supported">
57+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
58+
</Aside>
59+
5560
## 1. The `http.SendRequest` Pattern (recommended)
5661

5762
The `http.SendRequest` helper function is the simplest and recommended way to make `POST` requests. It automatically handles the `cre.RunInNodeMode` pattern for you.

‎src/content/cre/guides/workflow/using-http-client/post-request-ts.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pageId: "guides-workflow-http-post-request"
77
metadata:
88
description: "Send data to external APIs in TypeScript: learn to make POST requests from your workflow with authentication and custom headers."
99
datePublished: "2025-11-04"
10-
lastModified: "2025-11-04"
10+
lastModified: "2025-12-16"
1111
---
1212

1313
import { Aside } from "@components"
@@ -52,6 +52,11 @@ For this example, we will use <a href="https://webhook.site/" target="_blank">**
5252

5353
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
5454

55+
{/* prettier-ignore */}
56+
<Aside type="caution" title="Redirects are not supported">
57+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
58+
</Aside>
59+
5560
## 1. The High-Level `sendRequest` Pattern (recommended)
5661

5762
The high-level `sendRequest()` method is the simplest and recommended way to make `POST` requests. It automatically handles the `runInNodeMode` pattern for you.

‎src/content/cre/guides/workflow/using-http-client/submitting-reports-http-go.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@ This guide shows how to send a cryptographically signed report (generated by you
3131
- Understanding of [generating reports](/cre/guides/workflow/using-evm-client/onchain-write/generating-reports-single-values)
3232
- A generated report from `runtime.GenerateReport()`
3333

34+
{/* prettier-ignore */}
35+
<Aside type="caution" title="Redirects are not supported">
36+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
37+
</Aside>
38+
3439
## Quick start: Minimal example
3540

3641
Here's the simplest possible workflow that generates and submits a report via HTTP:

‎src/content/cre/guides/workflow/using-http-client/submitting-reports-http-ts.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ This guide shows how to send a cryptographically signed report (generated by you
3030
- Familiarity with [making POST requests](/cre/guides/workflow/using-http-client/post-request)
3131
- Familiarity with `runtime.report()` (covered [below](#generating-reports-for-http-submission))
3232

33+
{/* prettier-ignore */}
34+
<Aside type="caution" title="Redirects are not supported">
35+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
36+
</Aside>
37+
3338
## Quick start: Minimal example
3439

3540
Here's the simplest possible workflow that generates and submits a report via HTTP:

‎src/content/cre/llms-full-go.txt‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10751,7 +10751,7 @@ These `KeystoneForwarder` addresses are used by deployed workflows. Use these ad
1075110751

1075210752
# Making GET Requests
1075310753
Source: https://docs.chain.link/cre/guides/workflow/using-http-client/get-request-go
10754-
Last Updated: 2025-11-04
10754+
Last Updated: 2025-12-16
1075510755

1075610756
The `http.Client` is the SDK's interface for the underlying [HTTP Capability](/cre/capabilities/http). It allows your workflow to fetch data from any external API.
1075710757

@@ -10764,6 +10764,11 @@ All HTTP requests are wrapped in a consensus mechanism to provide a single, reli
1076410764

1076510765
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
1076610766

10767+
10768+
<Aside type="caution" title="Redirects are not supported">
10769+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
10770+
</Aside>
10771+
1076710772
## Choosing your approach
1076810773

1076910774
### Use `http.SendRequest` (Section 1) when:
@@ -10957,7 +10962,7 @@ The `http.Request` struct provides several fields to customize your request. See
1095710962

1095810963
# Making POST Requests
1095910964
Source: https://docs.chain.link/cre/guides/workflow/using-http-client/post-request-go
10960-
Last Updated: 2025-11-04
10965+
Last Updated: 2025-12-16
1096110966

1096210967
This guide explains how to use the HTTP Client to send data to an external API using a `POST` request. Because POST requests typically create resources or trigger actions, this guide shows you how to ensure your request executes only once, even though multiple nodes in the DON run your workflow.
1096310968

@@ -10999,6 +11004,11 @@ For this example, we will use <a href="https://webhook.site/" target="_blank">**
1099911004

1100011005
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
1100111006

11007+
11008+
<Aside type="caution" title="Redirects are not supported">
11009+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
11010+
</Aside>
11011+
1100211012
## 1. The `http.SendRequest` Pattern (recommended)
1100311013

1100411014
The `http.SendRequest` helper function is the simplest and recommended way to make `POST` requests. It automatically handles the `cre.RunInNodeMode` pattern for you.
@@ -11532,6 +11542,11 @@ This guide shows how to send a cryptographically signed report (generated by you
1153211542
- Understanding of [generating reports](/cre/guides/workflow/using-evm-client/onchain-write/generating-reports-single-values)
1153311543
- A generated report from `runtime.GenerateReport()`
1153411544

11545+
11546+
<Aside type="caution" title="Redirects are not supported">
11547+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
11548+
</Aside>
11549+
1153511550
## Quick start: Minimal example
1153611551

1153711552
Here's the simplest possible workflow that generates and submits a report via HTTP:
@@ -13931,7 +13946,7 @@ if err != nil {
1393113946

1393213947
# SDK Reference: HTTP Client
1393313948
Source: https://docs.chain.link/cre/reference/sdk/http-client-go
13934-
Last Updated: 2025-11-04
13949+
Last Updated: 2025-12-16
1393513950

1393613951
The HTTP Client lets you make requests to external APIs from your workflow. Each node in the DON executes the request independently, and the SDK uses consensus to provide a single, reliable result.
1393713952

@@ -13956,6 +13971,11 @@ The HTTP Client lets you make requests to external APIs from your workflow. Each
1395613971

1395713972
Defines the parameters for an outgoing HTTP request.
1395813973

13974+
13975+
<Aside type="caution" title="Redirects are not supported">
13976+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
13977+
</Aside>
13978+
1395913979
| Field | Type | Description |
1396013980
| --------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------- |
1396113981
| `Url` | `string` | The URL of the API endpoint. |

‎src/content/cre/llms-full-ts.txt‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9500,7 +9500,7 @@ These `KeystoneForwarder` addresses are used by deployed workflows. Use these ad
95009500

95019501
# Making GET Requests
95029502
Source: https://docs.chain.link/cre/guides/workflow/using-http-client/get-request-ts
9503-
Last Updated: 2025-11-04
9503+
Last Updated: 2025-12-16
95049504

95059505
The `HTTPClient` is the SDK's interface for the underlying [HTTP Capability](/cre/capabilities/http). It allows your workflow to fetch data from any external API.
95069506

@@ -9513,6 +9513,11 @@ All HTTP requests are wrapped in a consensus mechanism to provide a single, reli
95139513

95149514
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
95159515

9516+
9517+
<Aside type="caution" title="Redirects are not supported">
9518+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
9519+
</Aside>
9520+
95169521
## Choosing your approach
95179522

95189523
### Use `sendRequest` (Section 1) when:
@@ -9854,7 +9859,7 @@ The request object provides several fields to customize your HTTP call. See the
98549859

98559860
# Making POST Requests
98569861
Source: https://docs.chain.link/cre/guides/workflow/using-http-client/post-request-ts
9857-
Last Updated: 2025-11-04
9862+
Last Updated: 2025-12-16
98589863

98599864
This guide explains how to use the HTTP Client to send data to an external API using a `POST` request. Because POST requests typically create resources or trigger actions, this guide shows you how to ensure your request executes only once, even though multiple nodes in the DON run your workflow.
98609865

@@ -9896,6 +9901,11 @@ For this example, we will use <a href="https://webhook.site/" target="_blank">**
98969901

98979902
This guide assumes you have a basic understanding of CRE. If you are new, we strongly recommend completing the [Getting Started tutorial](/cre/getting-started/overview) first.
98989903

9904+
9905+
<Aside type="caution" title="Redirects are not supported">
9906+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
9907+
</Aside>
9908+
98999909
## 1. The High-Level `sendRequest` Pattern (recommended)
99009910

99019911
The high-level `sendRequest()` method is the simplest and recommended way to make `POST` requests. It automatically handles the `runInNodeMode` pattern for you.
@@ -10333,6 +10343,11 @@ This guide shows how to send a cryptographically signed report (generated by you
1033310343
- Familiarity with [making POST requests](/cre/guides/workflow/using-http-client/post-request)
1033410344
- Familiarity with `runtime.report()` (covered [below](#generating-reports-for-http-submission))
1033510345

10346+
10347+
<Aside type="caution" title="Redirects are not supported">
10348+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
10349+
</Aside>
10350+
1033610351
## Quick start: Minimal example
1033710352

1033810353
Here's the simplest possible workflow that generates and submits a report via HTTP:
@@ -13425,7 +13440,7 @@ const evmClient = new cre.capabilities.EVMClient(network.chainSelector.selector)
1342513440

1342613441
# SDK Reference: HTTP Client
1342713442
Source: https://docs.chain.link/cre/reference/sdk/http-client-ts
13428-
Last Updated: 2025-11-04
13443+
Last Updated: 2025-12-16
1342913444

1343013445
This page provides a reference for making offchain HTTP requests using the `HTTPClient`. This is a "node-level" action capability, meaning it executes on each individual node in the DON.
1343113446

@@ -13804,6 +13819,11 @@ const fetchPrice = (sendRequester: HTTPSendRequester, url: string): number => {
1380413819

1380513820
Defines the parameters for an outgoing HTTP request.
1380613821

13822+
13823+
<Aside type="caution" title="Redirects are not supported">
13824+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
13825+
</Aside>
13826+
1380713827
| Field | Type | Description |
1380813828
| --------------- | ------------------------------------------------- | --------------------------------------------------------------- |
1380913829
| `url` | `string` | The URL of the API endpoint. |

‎src/content/cre/reference/sdk/http-client-go.mdx‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pageId: "reference-sdk-http-client"
77
metadata:
88
description: "Reference for Go HTTP Client: complete API for GET/POST requests, headers, authentication, and consensus aggregation methods."
99
datePublished: "2025-11-04"
10-
lastModified: "2025-11-04"
10+
lastModified: "2025-12-16"
1111
---
1212

1313
import { Aside } from "@components"
@@ -35,6 +35,11 @@ The HTTP Client lets you make requests to external APIs from your workflow. Each
3535

3636
Defines the parameters for an outgoing HTTP request.
3737

38+
{/* prettier-ignore */}
39+
<Aside type="caution" title="Redirects are not supported">
40+
HTTP requests to URLs that return redirects (3xx status codes) will fail. Ensure the URL you provide is the final destination and does not redirect to another URL.
41+
</Aside>
42+
3843
| <div style="width: 120px;">Field</div> | <div style="width: 200px;">Type</div> | Description |
3944
| -------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
4045
| `Url` | `string` | The URL of the API endpoint. |

0 commit comments

Comments
 (0)