Skip to content
This repository has been archived by the owner on Aug 26, 2024. It is now read-only.

Add migration guides #1056

Merged
merged 6 commits into from
Sep 30, 2022
Merged

Add migration guides #1056

merged 6 commits into from
Sep 30, 2022

Conversation

Siegrift
Copy link
Contributor

Closes api3dao/airnode#1448

@Siegrift Siegrift self-assigned this Sep 26, 2022
Copy link
Contributor

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice 👍 only very minor rephrasing suggestions from me.

docs/airnode/v0.9/reference/migration.md Outdated Show resolved Hide resolved
docs/airnode/v0.9/reference/migration.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@Siegrift Siegrift left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In 0.9. we also have Sepolia network available for Airnodes to use. I don't think this needs to be mentioned in the migration guide though.

Copy link
Member

@wkande wkande left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall @dcroote mentioned some issues with the 0.7.0 to 0.8.0 guide by Andre. I will take a look into them after merging which is when I will add your guides to the sidebars.

  • #4 - might be worth mentioning rrp[n].cacheResponses is a new, required field
  • Refer to airnode-admin wherever applicable #5 (both in the summary and the Details): 0.8.0 uses oisFormat "1.1.1" rather than "1.1.2" (see here for example). There is a bit of debate on how to handle the coupling of Airnode and OIS going forward though (for which we might need a 4th opinion 😅).
  • Minor typo "0.8.9" at the end
  • corsOrigins was added for HTTP gateways (relevant config.json changes here) in #1357.
  • relayRequestId was added as a supported security scheme. Functionality implemented with an example of use in #1286 (though between that PR and now, OIS was moved into its own repo).

@dcroote
Copy link
Contributor

dcroote commented Sep 27, 2022

@wkande - Andre incorporated all of my changes before @Siegrift copied it for this PR so all set.

@Siegrift - I think we should mention Sepolia is available and that we're deprecating some testnets (api3dao/airnode#1476), including why we're doing it. This way we can point users (e.g. from Discord) to one piece of information about the change.

@dcroote dcroote self-requested a review September 27, 2022 14:53
Copy link
Contributor

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting updates per my above comment

@Siegrift
Copy link
Contributor Author

I think we should mention Sepolia is available and that we're deprecating some testnets (api3dao/airnode#1476), including why we're doing it. This way we can point users (e.g. from Discord) to one piece of information about the change.

Ok. Added in last commit. Please either @wkande or @dcroote take a look at wording and make any necessary updates. Feel free to merge it afterwards.

@github-actions
Copy link

github-actions bot commented Sep 28, 2022

Visit the preview URL for this PR (updated for commit eb302d3):

https://api3-docs--pr1056-migration-guides-gnvlc8mt.web.app

(expires Thu, 06 Oct 2022 05:01:29 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Copy link
Contributor

@dcroote dcroote left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Siegrift. I added a note about Etherscan discontinuing their blockchain explorers and also added these guides to the sidebar nav.

@wkande I'll leave it to you to merge

@wkande wkande merged commit f35df98 into main Sep 30, 2022
@wkande wkande deleted the migration-guides branch September 30, 2022 14:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Airnode Migration Guide v0.9
3 participants