Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harmonize HTTP Gateway response object #609

Merged
merged 3 commits into from
Oct 23, 2023
Merged

Harmonize HTTP Gateway response object #609

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92d6d8c
fix: harmonize HTTP Gateway response object
dcroote Aug 23, 2023
a7e5a44
fix: run prettier on unrelated files
dcroote Aug 23, 2023
666845b
fix: update for 0.12 and 0.13 behavior
dcroote Oct 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/guides/dao-members/proposals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,8 @@ To create a new proposal using the DAO dashboard:
> A description can be typed text but consider using a PDF hosted on IPFS.
> See the
> [Using IPFS for Proposals](/guides/dao-members/proposals.md#using-ipfs-for-proposals)
> section below. Also consider adding a link back to the forum where you posted
> your proposal for discussion.
> section below. Also consider adding a link back to the forum where you
> posted your proposal for discussion.

5. Enter the **Target Contract** address.

Expand Down
5 changes: 3 additions & 2 deletions docs/guides/dao-members/staking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ DAO pool (as a percentage of the DAO pool). Watch the
[Stake and Earn](/guides/dao-members/videos.md#stake-and-earn) video.

1. Click the **_Stake_** button.
> The number of tokens available to stake depends on the number of tokens deposited
> and are available to withdraw as displayed in the **Balance** box as WITHDRAWABLE.
> The number of tokens available to stake depends on the number of tokens
> deposited and are available to withdraw as displayed in the **Balance** box
> as WITHDRAWABLE.
2. Enter the number of tokens to stake (or select the **Max** link) and click
the **_Stake_** button.

Expand Down
24 changes: 12 additions & 12 deletions docs/reference/airnode/latest/understand/http-gateways.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,21 @@ The regular HTTP gateway is strictly for testing purposes. Using a simple tool
like CURL you can test that endpoints in the Airnode configuration are working
properly without accessing the blockchain.

In order to facilitate testing, HTTP gateway requests have the following
differences in handling when compared to blockchain requests or requests to the
HTTP signed data gateway:

1. Data from a request that yields a successful API call but fails response
processing are returned in the response. This is in contrast to the other
types of requests for which only an error would be returned. The intention is
to facilitate configuration of reserved parameters that dictate how API call
responses are processed. Under this scenario, the response will include:
In order to facilitate configuration and testing of parameters, HTTP gateway
requests have the following differences in handling when compared to blockchain
requests or requests to the HTTP signed data gateway:

1. When a request's API call is successful but then that response fails
extraction and encoding, data are still returned. This is in contrast to the
other types of requests for which only an error would be returned. The API
call response, after undergoing any
[post-processing](/reference/ois/latest/processing.md), will be present in
the response body if encoding fails, and in the `rawValue` field if the
encoding is successful:

```json
{
"success": true,
"errorMessage": "string",
"data": data
"rawValue": {...}
}
```

Expand Down
21 changes: 10 additions & 11 deletions docs/reference/airnode/next/understand/http-gateways.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,21 +38,20 @@ The regular HTTP gateway is strictly for testing purposes. Using a simple tool
like CURL you can test that endpoints in the Airnode configuration are working
properly without accessing the blockchain.

In order to facilitate testing, HTTP gateway requests have the following
differences in handling when compared to blockchain requests or requests to the
HTTP signed data gateway:
In order to facilitate configuration and testing of parameters, HTTP gateway
requests have the following differences in handling when compared to blockchain
requests or requests to the HTTP signed data gateway:

1. Data from a request that yields a successful API call but fails response
processing are returned in the response. This is in contrast to the other
types of requests for which only an error would be returned. The intention is
to facilitate configuration of reserved parameters that dictate how API call
responses are processed. Under this scenario, the response will include:
1. When a request's API call is successful but then that response fails
extraction and encoding, data are still returned. This is in contrast to the
other types of requests for which only an error would be returned. The API
call response, after undergoing any
[post-processing](/reference/ois/latest/processing.md), will be present in
the `rawValue` field independent of encoding success or failure:

```json
{
"success": true,
"errorMessage": "string",
"data": data
"rawValue": {...}
}
```

Expand Down
Loading