Skip to content

Commit

Permalink
feat: update migration guide for v0.11.2 (#529)
Browse files Browse the repository at this point in the history
Also includes updates the v0.12 migration guide
  • Loading branch information
dcroote authored Jun 30, 2023
1 parent 9b7c4a5 commit 55aed29
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 33 deletions.
33 changes: 26 additions & 7 deletions docs/reference/airnode/latest/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ tags:
# {{$frontmatter.title}}

The following guide assumes a valid v0.10.x `config.json` file. All changes
listed below will need to be implemented in order to migrate to Airnode v0.11.x.
listed below will need to be implemented in order to migrate to Airnode v0.11.2.
This document is written in a way that will preserve existing behavior with
earlier Airnode versions.

Expand All @@ -29,9 +29,10 @@ such as airnode-deployer, airnode-admin, etc., and new features.

## Summary

1. `ois[n].oisFormat` updated to "2.0.0".
1. `ois[n].oisFormat` updated to "2.1.0". Note that Airnode v0.11.0 and v0.11.1
use "2.0.0".

2. `nodeSettings.nodeVersion` updated to "0.11.1".
2. `nodeSettings.nodeVersion` updated to "0.11.2".

3. `ois[n].endpoints[n].preProcessingSpecifications` and
`ois[n].endpoints[n].postProcessingSpecifications` have an updated allowed
Expand All @@ -46,23 +47,23 @@ such as airnode-deployer, airnode-admin, etc., and new features.

1. `ois[n].oisFormat`

Updated to "2.0.0"
Updated to "2.1.0". Note that Airnode v0.11.0 and v0.11.1 use "2.0.0".

```diff
{
- "oisFormat": "1.4.0"
+ "oisFormat": "2.0.0"
+ "oisFormat": "2.1.0"
}
```

2. `nodeSettings.nodeVersion`

Updated to "0.11.1"
Updated to "0.11.2"

```diff
{
- "nodeVersion": "0.10.0"
+ "nodeVersion": "0.11.1"
+ "nodeVersion": "0.11.2"
}
```

Expand Down Expand Up @@ -153,5 +154,23 @@ to learn more about this feature.
[OEV gateway](/reference/airnode/latest/understand/oev-gateway.md) doc to
learn more about this feature.
- The heartbeat payload now includes `deployment_id`.
- The `value` for a `fixedOperationParameters` object is now allowed to be any
type, including an object; for example, the following specifies an array
containing multiple primitives. Note that this feature is only available
beginning in v0.11.2.

```json
{
"fixedOperationParameters": [
{
"operationParameter": {
"in": "query",
"name": "params"
},
"value": ["finalized", false]
}
]
}
```

<FlexEndTag/>
52 changes: 26 additions & 26 deletions docs/reference/airnode/next/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ tags:

# {{$frontmatter.title}}

The following guide assumes a valid v0.11.x `config.json` file. All changes
listed below will need to be implemented in order to migrate to Airnode v0.12.x.
The following guide assumes a valid v0.11.2 `config.json` file. All changes
listed below will need to be implemented in order to migrate to Airnode v0.12.0.
This document is written in a way that will preserve existing behavior with
earlier Airnode versions.

Expand All @@ -29,22 +29,21 @@ such as airnode-deployer, airnode-admin, etc., and new features.

## Summary

1. `ois[n].oisFormat` updated to "2.1.0".
1. `ois[n].oisFormat` updated to "2.1.0". This has not changed since v0.11.2,
but has changed since v0.11.0 and v0.11.1 for which it was "2.0.0".

2. `nodeSettings.nodeVersion` updated to "0.12.0".

3. Fields specifying `AirnodeRrpV0` and `RequesterAuthorizerWithErc721` contract
addresses on chains for which there is an API3 deployment are now optional.
See details below for additional information.

4. The `value` for a `fixedOperationParameters` object is now allowed to be any
type.

## Details

1. `ois[n].oisFormat`

Updated to "2.1.0"
Updated to "2.1.0". This has not changed since v0.11.2, but has changed since
v0.11.0 and v0.11.1 for which it was "2.0.0".

```diff
{
Expand All @@ -59,7 +58,7 @@ Updated to "0.12.0"

```diff
{
- "nodeVersion": "0.11.1"
- "nodeVersion": "0.11.2"
+ "nodeVersion": "0.12.0"
}
```
Expand Down Expand Up @@ -120,24 +119,6 @@ And second, within the `chains[n].authorizers` object:
}
```

4. The `value` for a `fixedOperationParameters` object is now allowed to be any
type, including an object; for example, the following specifies an array
containing multiple primitives.

```json
{
"fixedOperationParameters": [
{
"operationParameter": {
"in": "query",
"name": "params"
},
"value": ["finalized", false]
}
]
}
```

## New features and updates

- There is no longer a hardcoded limit to the maximum number of sponsor wallet
Expand All @@ -149,5 +130,24 @@ And second, within the `chains[n].authorizers` object:
2. Reserved parameters are inaccessible in response pre/post processing. This
is only relevant if reserved parameters are being _modified_ in pre/post
processing (advanced use case).
- The `value` for a `fixedOperationParameters` object is now allowed to be any
type, including an object; for example, the following specifies an array
containing multiple primitives. This has not changed since v0.11.2, but has
changed since v0.11.0 and v0.11.1 for which it was only allowed to be a
string.

```json
{
"fixedOperationParameters": [
{
"operationParameter": {
"in": "query",
"name": "params"
},
"value": ["finalized", false]
}
]
}
```

<FlexEndTag/>

0 comments on commit 55aed29

Please sign in to comment.