From e7b5a28cb13f16f9501d39b17c72e3119c767ead Mon Sep 17 00:00:00 2001 From: Derek Croote Date: Wed, 12 Apr 2023 07:37:52 -0700 Subject: [PATCH] fix: links to new vitepress docs (#1731) --- .changeset/long-baboons-wait.md | 2 ++ .github/workflows/build-test.yml | 8 ----- .github/workflows/mlc_config.json | 11 +----- README.md | 6 ++-- packages/airnode-abi/README.md | 6 ++-- packages/airnode-adapter/README.md | 7 ++-- packages/airnode-admin/README.md | 2 +- packages/airnode-admin/docker/README.md | 2 +- packages/airnode-deployer/README.md | 4 +-- packages/airnode-deployer/docker/README.md | 4 +-- packages/airnode-examples/README.md | 36 +++++++++---------- packages/airnode-examples/aws.example.env | 2 +- .../airnode-examples/integrations/README.md | 10 +++--- .../authenticated-coinmarketcap/README.md | 2 +- .../coingecko-http-gateways/README.md | 6 ++-- .../coingecko-post-processing/README.md | 6 ++-- .../coingecko-pre-processing/README.md | 6 ++-- .../integrations/coingecko-template/README.md | 10 +++--- .../integrations/coingecko/README.md | 2 +- .../integrations/failing-example/README.md | 2 +- .../relay-security-schemes/README.md | 2 +- .../weather-multi-value/README.md | 6 ++-- .../src/scripts/create-aws-secrets.ts | 2 +- packages/airnode-node/README.md | 2 +- .../airnode-node/config/secrets.example.env | 2 +- packages/airnode-node/docker/README.md | 4 +-- packages/airnode-validator/README.md | 2 +- .../airnode-validator/src/config/config.ts | 2 +- 28 files changed, 70 insertions(+), 86 deletions(-) create mode 100644 .changeset/long-baboons-wait.md diff --git a/.changeset/long-baboons-wait.md b/.changeset/long-baboons-wait.md new file mode 100644 index 0000000000..a845151cc8 --- /dev/null +++ b/.changeset/long-baboons-wait.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml index 14b2441e9d..cc22a0cb20 100644 --- a/.github/workflows/build-test.yml +++ b/.github/workflows/build-test.yml @@ -20,14 +20,6 @@ jobs: steps: - name: Clone airnode uses: actions/checkout@v3 - - name: Update latest paths - run: | - wget https://raw.githubusercontent.com/api3dao/api3-docs/main/docs/.vuepress/config.js - for i in latestVersion latestOisVersion; do - path=$(grep $i: config.js | cut -d\' -f2); - echo "Renaming: $i --> $path"; - sed -i "s@$i@$path@" .github/workflows/mlc_config.json; - done - name: Check hyperlinks uses: gaurav-nelson/github-action-markdown-link-check@v1 with: diff --git a/.github/workflows/mlc_config.json b/.github/workflows/mlc_config.json index 00fba63f54..42270a3a6b 100644 --- a/.github/workflows/mlc_config.json +++ b/.github/workflows/mlc_config.json @@ -1,14 +1,5 @@ { - "replacementPatterns": [ - { - "pattern": "/airnode/latest/", - "replacement": "latestVersion" - }, - { - "pattern": "/ois/latest/", - "replacement": "latestOisVersion" - } - ], + "replacementPatterns": [], "retryOn429": true, "retryCount": 3, "fallbackRetryDelay": "10s" diff --git a/README.md b/README.md index 5d5700cf95..d631b46c7f 100644 --- a/README.md +++ b/README.md @@ -19,11 +19,11 @@ This is a monorepo managed by [Lerna](https://github.com/lerna/lerna). [**airnode-abi**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-abi) Encoding and decoding utilities for Airnode according to the -[Airnode ABI specifications](https://docs.api3.org/airnode/latest/reference/specifications/airnode-abi-specifications.html) +[Airnode ABI specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html) [**airnode-adapter**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-adapter) Used for building -requests from an [Oracle Integration Specification (OIS)](https://docs.api3.org/ois/latest/), executing them, parsing -the responses, but also converting and encoding them for on chain purposes +requests from an [Oracle Integration Specification (OIS)](https://docs.api3.org/reference/ois/latest/), executing them, +parsing the responses, but also converting and encoding them for on chain purposes [**airnode-admin**:](https://github.com/api3dao/airnode/tree/master/packages/airnode-admin) A package/CLI tool to interact with the Airnode contracts across chains diff --git a/packages/airnode-abi/README.md b/packages/airnode-abi/README.md index bfcff59ab0..02761dc08e 100644 --- a/packages/airnode-abi/README.md +++ b/packages/airnode-abi/README.md @@ -1,7 +1,7 @@ # `@api3/airnode-abi` > Encoding and decoding utilities for Airnode according to the -> [Airnode ABI specifications](https://docs.api3.org/airnode/latest/reference/specifications/airnode-abi-specifications.html) +> [Airnode ABI specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html) ## Documentation @@ -11,5 +11,5 @@ then grouped and encoded as the rest of the body. For more information see the API3 Documentation. -- [Airnode ABI Reference](https://docs.api3.org/airnode/latest/reference/packages/airnode-abi.html) -- [Airnode ABI Specifications](https://docs.api3.org/airnode/latest/reference/specifications/airnode-abi-specifications.html) +- [Airnode ABI Reference](https://docs.api3.org/reference/airnode/latest/packages/airnode-abi.html) +- [Airnode ABI Specifications](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html) diff --git a/packages/airnode-adapter/README.md b/packages/airnode-adapter/README.md index d805b811ae..7dbae3d81b 100644 --- a/packages/airnode-adapter/README.md +++ b/packages/airnode-adapter/README.md @@ -1,9 +1,10 @@ # `@api3/airnode-adapter` -> Used for building requests from an [Oracle Integration Specification (OIS)](https://docs.api3.org/ois/latest/), -> executing them, parsing the responses, but also converting and encoding them for on chain purposes +> Used for building requests from an +> [Oracle Integration Specification (OIS)](https://docs.api3.org/reference/ois/latest/), executing them, parsing the +> responses, but also converting and encoding them for on chain purposes ## Documentation The adapter documentation describing relevant user facing parts can be found in -[adapter docs](https://docs.api3.org/airnode/latest/reference/packages/adapter.html). +[adapter docs](https://docs.api3.org/reference/airnode/latest/packages/adapter.html). diff --git a/packages/airnode-admin/README.md b/packages/airnode-admin/README.md index 6f767e67bd..5801315e96 100644 --- a/packages/airnode-admin/README.md +++ b/packages/airnode-admin/README.md @@ -5,7 +5,7 @@ ## Documentation You can find documentation on how to use the admin CLI package in the -[admin CLI docs](https://docs.api3.org/airnode/latest/reference/packages/admin-cli.html). +[admin CLI docs](https://docs.api3.org/reference/airnode/latest/packages/admin-cli.html). ## For developers diff --git a/packages/airnode-admin/docker/README.md b/packages/airnode-admin/docker/README.md index 6137e286e8..f2fe2f552d 100644 --- a/packages/airnode-admin/docker/README.md +++ b/packages/airnode-admin/docker/README.md @@ -1,7 +1,7 @@ # Airnode admin CLI Docker image **This README is intended for the developers. Documentation on how to use the airnode-admin image is in the -[docs](https://docs.api3.org/airnode/latest/grp-providers/docker/admin-cli-image.html).** +[docs](https://docs.api3.org/reference/airnode/latest/docker/admin-cli-image.html).** This documentation focuses on the Airnode admin CLI Docker image, not the Airnode admin CLI itself. If you want to learn more about the admin CLI, please read [its documentation](../README.md). diff --git a/packages/airnode-deployer/README.md b/packages/airnode-deployer/README.md index 837e1b790f..8059da643a 100644 --- a/packages/airnode-deployer/README.md +++ b/packages/airnode-deployer/README.md @@ -5,7 +5,7 @@ ## Documentation You can find documentation on how to use the deployer in the -[deployer docs](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html). +[deployer docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html). ## For developers @@ -22,7 +22,7 @@ Instructions on how to build and use the deployer CLI from source: [required_version](https://github.com/api3dao/airnode/blob/master/packages/airnode-deployer/terraform/aws/backend.tf#L2) of terraform modules used. 2. Prepare necessary cloud credentials. See the - [instructions in the docs](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html#cloud-provider-credentials). + [instructions in the docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html#cloud-provider-credentials). 3. Make sure `config.json` and `secrets.env` are available in the `config` directory. You can use the provided example `config.json` and `secrets.env` templates to get started quickly, but you will need to edit these with your own API details and secrets. diff --git a/packages/airnode-deployer/docker/README.md b/packages/airnode-deployer/docker/README.md index b6f26da5e3..7e2181d5a0 100644 --- a/packages/airnode-deployer/docker/README.md +++ b/packages/airnode-deployer/docker/README.md @@ -1,7 +1,7 @@ # Airnode deployer Docker image **This README is intended for the developers. Documentation on how to use the deployer image is in the -[docs](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html).** +[docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html).** This documentation focuses on the Airnode deployer Docker image, not the Airnode deployer itself. If you want to learn more about the Deployer, please read [its documentation](../README.md). @@ -17,4 +17,4 @@ yarn docker:build:local > If building on windows ensure that the `entrypoint.sh` file uses `LF` line endings. Otherwise the image will not be > built correctly. -The usage is documented in the [docs](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html). +The usage is documented in the [docs](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html). diff --git a/packages/airnode-examples/README.md b/packages/airnode-examples/README.md index afd674509a..66042fa3d4 100644 --- a/packages/airnode-examples/README.md +++ b/packages/airnode-examples/README.md @@ -23,7 +23,8 @@ Currently, all of the examples utilize the RRP protocol. The example RRP flow co 2. Deploy Airnode on a cloud provider, or run locally in a docker container, and make a request using the deployed requester -If you would like to know more about RRP, read the [API3 docs](https://docs.api3.org/airnode/latest/concepts/). +If you would like to know more about RRP, read the +[API3 docs](https://docs.api3.org/reference/airnode/latest/concepts/). ### Available examples @@ -37,16 +38,16 @@ reserved parameters. The following list orders integrations alphabetically: - [coingecko](https://github.com/api3dao/airnode/blob/master/packages/airnode-examples/integrations/coingecko) - unauthenticated cryptocurrency price request. - [coingecko-cross-chain-authorizer](https://github.com/api3dao/airnode/blob/master/packages/airnode-examples/integrations/coingecko) - - demonstration of a cross-chain [authorizer](https://docs.api3.org/airnode/latest/concepts/authorizers.html). + demonstration of a cross-chain [authorizer](https://docs.api3.org/reference/airnode/latest/concepts/authorizers.html). - [coingecko-http-gateways](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-http-gateways) - demonstration of the - [HTTP gateway and HTTP signed data gateway](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/http-gateways.html). + [HTTP gateway and HTTP signed data gateway](https://docs.api3.org/reference/airnode/latest/understand/http-gateways.html). - [coingecko-post-processing](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-post-processing) - - demonstration of the [post-processing](https://docs.api3.org/ois/latest/processing.html) feature. + demonstration of the [post-processing](https://docs.api3.org/reference/ois/latest/processing.html) feature. - [coingecko-pre-processing](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-pre-processing) - - demonstration of the [pre-processing](https://docs.api3.org/ois/latest/processing.html) feature. + demonstration of the [pre-processing](https://docs.api3.org/reference/ois/latest/processing.html) feature. - [coingecko-template](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/coingecko-template) - - demonstration of [template](https://docs.api3.org/airnode/latest/grp-developers/using-templates.html) requests. + demonstration of [template](https://docs.api3.org/reference/airnode/latest/developers/using-templates.html) requests. - [failing-example](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/failing-example) - demonstration of Airnode error handling through an invalid request. - [relay-security-schemes](https://github.com/api3dao/airnode/tree/master/packages/airnode-examples/integrations/relay-security-schemes) - @@ -119,9 +120,9 @@ deploy the contracts and make transactions, so make sure it is funded. The recom #### 4. (Only if using local blockchain) Deploy the RRP contract -The [RRP contract](https://docs.api3.org/airnode/latest/concepts/#airnoderrp-sol) is a contract through which the -[requester](https://docs.api3.org/airnode/latest/concepts/requester.html) triggers a request for Airnode. This contract -is common for all Airnodes and requesters on a chain. +The [RRP contract](https://docs.api3.org/reference/airnode/latest/concepts/#airnoderrpv0-sol) is a contract through +which the [requester](https://docs.api3.org/reference/airnode/latest/concepts/requester.html) triggers a request for +Airnode. This contract is common for all Airnodes and requesters on a chain. If you are using a local blockchain, deploy the contact using the command below. Otherwise, the contract deployed by API3 on the chosen chain will be used automatically. @@ -135,7 +136,7 @@ yarn deploy-rrp If you intend to deploy Airnode on AWS, you will need to specify the credentials which will be used by the [deployer](https://github.com/api3dao/airnode/tree/master/packages/airnode-deployer). If you are not sure where to find these or how to create an AWS account, see -[the following docs section](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html#aws). +[the following docs section](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html#aws). After you know the secrets, run the following script to specify them: @@ -154,7 +155,7 @@ your project by pairing it with your credit card. The amount of resources used b within the free tier, which means no charges will be incurred. If you are not sure how to create a GCP service account, see or download the access key for it, -[the following docs section](https://docs.api3.org/airnode/latest/grp-providers/docker/deployer-image.html#gcp). +[the following docs section](https://docs.api3.org/reference/airnode/latest/docker/deployer-image.html#gcp). Store the access key file as `gcp.json` in the integration directory - e.g. if you have chosen the `coingecko` integration, store the file as `integrations/coingecko/gcp.json`. @@ -188,9 +189,8 @@ yarn create-airnode-secrets > > The `create-airnode-secrets` script will handle this for you on Mac, Windows, and WSL. -Refer to the -[documentation](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html) for -more details. +Refer to the [documentation](https://docs.api3.org/reference/airnode/latest/understand/configuring.html) for more +details. #### 9. (Only if deploying to a cloud provider) Deploy Airnode @@ -243,11 +243,11 @@ yarn deploy-requester #### 12. Derive and fund the sponsor wallet -Airnode requests require a [sponsor](https://docs.api3.org/airnode/latest/concepts/sponsor.html), which will pay for the -response transaction made by Airnode. Each sponsor has a dedicated wallet for a given Airnode. This wallet is called a -"sponsor wallet" and can be derived from a sponsor address and Airnode's extended public key with the +Airnode requests require a [sponsor](https://docs.api3.org/reference/airnode/latest/concepts/sponsor.html), which will +pay for the response transaction made by Airnode. Each sponsor has a dedicated wallet for a given Airnode. This wallet +is called a "sponsor wallet" and can be derived from a sponsor address and Airnode's extended public key with the [admin CLI package](https://github.com/api3dao/airnode/tree/master/packages/airnode-admin). Refer to the -[documentation](https://docs.api3.org/airnode/latest/grp-developers/requesters-sponsors.html#how-to-derive-a-sponsor-wallet) +[documentation](https://docs.api3.org/reference/airnode/latest/developers/requesters-sponsors.html#how-to-derive-a-sponsor-wallet) for more details. To derive and fund the sponsor wallet, run: diff --git a/packages/airnode-examples/aws.example.env b/packages/airnode-examples/aws.example.env index 3cac4dc3c5..e305909720 100644 --- a/packages/airnode-examples/aws.example.env +++ b/packages/airnode-examples/aws.example.env @@ -1,5 +1,5 @@ # For further information see: -# https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html#aws-setup-aws-deployment-only +# https://docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_SESSION_TOKEN= diff --git a/packages/airnode-examples/integrations/README.md b/packages/airnode-examples/integrations/README.md index d04f96bb6a..e8b983b0c9 100644 --- a/packages/airnode-examples/integrations/README.md +++ b/packages/airnode-examples/integrations/README.md @@ -8,13 +8,11 @@ Each integration consist of a these files: - `config.example.json` - An example configuration file for this integration. - `create-config.ts` - A file that will be called by `create-airnode-config.ts` to create the `config.json` file. See - the - [docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html#creating-config-json) - for details. + the [docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-config-json) for + details. - `create-secrets.ts` - A file that will be called by `create-airnode-secrets.ts` to create the `secrets.env` file. See - the - [docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html#creating-secrets-env) - for details. + the [docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html#creating-secrets-env) for + details. - `README.md` - Should explain what the particular integration is about. - `request-utils.ts` - This file contains functions which are necessary to make the Airnode request. - `secrets.example.env` - An example file listing the necessary secret values of `secrets.env` file. diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/README.md b/packages/airnode-examples/integrations/authenticated-coinmarketcap/README.md index 4e2e988d6c..f6d2031a66 100644 --- a/packages/airnode-examples/integrations/authenticated-coinmarketcap/README.md +++ b/packages/airnode-examples/integrations/authenticated-coinmarketcap/README.md @@ -12,4 +12,4 @@ preferred method: a request header named `X-CMC_PRO_API_KEY`. Your API key, whic is provided as a value via interpolation of the `CMC_PRO_API_KEY` variable defined in `secrets.env`. For more information about how the Airnode is configured refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html). diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/README.md b/packages/airnode-examples/integrations/coingecko-http-gateways/README.md index 2ae65ede79..a81c6b030f 100644 --- a/packages/airnode-examples/integrations/coingecko-http-gateways/README.md +++ b/packages/airnode-examples/integrations/coingecko-http-gateways/README.md @@ -6,7 +6,7 @@ The only difference is that this integration allows the endpoint to return eithe gateway or HTTP signed data gateway, respectively. For more details, see the documentation for the -[HTTP gateways](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/http-gateways.html). +[HTTP gateways](https://docs.api3.org/reference/airnode/latest/understand/http-gateways.html). ## HTTP gateway @@ -47,7 +47,7 @@ curl -X POST -H 'Content-Type: application/json' -d '{"parameters": {"coinId": " ### Encode parameters The coingecko endpoint expects a parameter `coinId` which needs to be passed to the signed data gateway encoded using -[Airnode ABI](https://docs.api3.org/airnode/latest/reference/specifications/airnode-abi-specifications.html). +[Airnode ABI](https://docs.api3.org/reference/airnode/latest/specifications/airnode-abi.html). We have encoded two basic parameter types: @@ -74,7 +74,7 @@ Before making the request, you need to replace the following placeholders: command - `` - You can find this value in `config.json` under `triggers.httpSignedData[0].endpointId` path. It can be derived using the Admin CLI command `derive-endpoint-id` described further - [here](https://docs.api3.org/airnode/latest/reference/packages/admin-cli.html#derive-endpoint-id) + [here](https://docs.api3.org/reference/airnode/latest/packages/admin-cli.html#derive-endpoint-id) The correct command may look like this: diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/README.md b/packages/airnode-examples/integrations/coingecko-post-processing/README.md index 4917b1076f..5296b69274 100644 --- a/packages/airnode-examples/integrations/coingecko-post-processing/README.md +++ b/packages/airnode-examples/integrations/coingecko-post-processing/README.md @@ -1,8 +1,8 @@ # Coingecko post-processing integration example This is a basic example showcasing how to use -[postprocessing](https://docs.api3.org/ois/v1.0/ois.html#_5-10-postprocessingspecifications) to enable an advanced use -case which modifies the CoinGecko API response before sending the response on chain. +[postprocessing](https://docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case which +modifies the CoinGecko API response before sending the response on chain. The `config.json` defines a single callable endpoint, called `coinsMarketData` which you can call with different coin IDs to determine the average current price and average 30 days percentage change. @@ -18,4 +18,4 @@ Overall the process looks like this: 5. Airnode submits the encoded value on chain. For more information about how the Airnode is configured refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html). diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/README.md b/packages/airnode-examples/integrations/coingecko-pre-processing/README.md index 0df82009fb..69d1447e34 100644 --- a/packages/airnode-examples/integrations/coingecko-pre-processing/README.md +++ b/packages/airnode-examples/integrations/coingecko-pre-processing/README.md @@ -1,8 +1,8 @@ # Coingecko pre-processing integration example This is a basic example showcasing how to use -[preprocessing](https://docs.api3.org/ois/v1.0/ois.html#_5-9-preprocessingspecifications) to enable an advanced use case -which modifies the endpoint parameters before making the API request to CoinGecko API. +[preprocessing](https://docs.api3.org/reference/ois/latest/processing.html) to enable an advanced use case which +modifies the endpoint parameters before making the API request to CoinGecko API. The `config.json` defines a single callable endpoint, called `coinHistoryData` which you can call with different coin ID and date to determine the historical price at the given date. As a requester you specify the date as UNIX timestamp and @@ -16,4 +16,4 @@ Overall the process looks like this: 4. Airnode makes the API call, waits for response, encodes the value and finally submits it on chain. For more information about how the Airnode is configured refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html). diff --git a/packages/airnode-examples/integrations/coingecko-template/README.md b/packages/airnode-examples/integrations/coingecko-template/README.md index 575cc4d257..81e966244f 100644 --- a/packages/airnode-examples/integrations/coingecko-template/README.md +++ b/packages/airnode-examples/integrations/coingecko-template/README.md @@ -1,10 +1,10 @@ # Coingecko example showing Airnode template request -This example showcases how to use Airnode [template](https://docs.api3.org/airnode/latest/concepts/template.html) -requests. This example defines a template inside `config.json`, which is used to call the Airnode endpoint called -`coinMarketData`. This endpoint can be called to determine the current price of some crypto currency. This template -defines parameters to retrieve the current price of Ethereum. See the `create-template-on-chain.ts` and -`create-config.ts` files for more details. +This example showcases how to use Airnode +[template](https://docs.api3.org/reference/airnode/latest/concepts/template.html) requests. This example defines a +template inside `config.json`, which is used to call the Airnode endpoint called `coinMarketData`. This endpoint can be +called to determine the current price of some crypto currency. This template defines parameters to retrieve the current +price of Ethereum. See the `create-template-on-chain.ts` and `create-config.ts` files for more details. To run this example, follow the generic examples README. However, before making a template request (before running `yarn make-request`), you must make sure the template is deployed. The easiest way to ensure this is to re-deploy the diff --git a/packages/airnode-examples/integrations/coingecko/README.md b/packages/airnode-examples/integrations/coingecko/README.md index 9e56e8e412..a727dffd3e 100644 --- a/packages/airnode-examples/integrations/coingecko/README.md +++ b/packages/airnode-examples/integrations/coingecko/README.md @@ -11,4 +11,4 @@ multiply the asset price returned from the API. This is necessary to preserve th contract, since solidity only allows to use integers. For more information about how the Airnode is configured refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html). diff --git a/packages/airnode-examples/integrations/failing-example/README.md b/packages/airnode-examples/integrations/failing-example/README.md index 7c3d62c050..3f4ea4f2ad 100644 --- a/packages/airnode-examples/integrations/failing-example/README.md +++ b/packages/airnode-examples/integrations/failing-example/README.md @@ -6,4 +6,4 @@ invalid, causing the request to fail everytime one tries to make it. This is to like in case of failure. For more information about how the Airnode is configured, refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/configuring.html). diff --git a/packages/airnode-examples/integrations/relay-security-schemes/README.md b/packages/airnode-examples/integrations/relay-security-schemes/README.md index 708995eaee..a1fa162291 100644 --- a/packages/airnode-examples/integrations/relay-security-schemes/README.md +++ b/packages/airnode-examples/integrations/relay-security-schemes/README.md @@ -17,4 +17,4 @@ demonstrate how the value can be sent via `query`, `header`, and `cookie`: - relayRequestId For more information on supported security schemes, refer to the -[docs](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/api-security.html). +[docs](https://docs.api3.org/reference/airnode/latest/understand/api-security.html). diff --git a/packages/airnode-examples/integrations/weather-multi-value/README.md b/packages/airnode-examples/integrations/weather-multi-value/README.md index 88743465d3..c7b75f638a 100644 --- a/packages/airnode-examples/integrations/weather-multi-value/README.md +++ b/packages/airnode-examples/integrations/weather-multi-value/README.md @@ -33,6 +33,6 @@ by OpenWeather. Each of these reserved parameters has a corresponding mapping in `../../contracts/weather-multi-value/Requester.sol` requester contract. Refer to the docs for more information on -[how the Airnode is configured](https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html) -and [reserved parameters](https://docs.api3.org/airnode/latest/reference/specifications/reserved-parameters.html), -including encoding multiple values. +[how the Airnode is configured](https://docs.api3.org/reference/airnode/latest/understand/configuring.html) and +[reserved parameters](https://docs.api3.org/reference/airnode/latest/specifications/reserved-parameters.html), including +encoding multiple values. diff --git a/packages/airnode-examples/src/scripts/create-aws-secrets.ts b/packages/airnode-examples/src/scripts/create-aws-secrets.ts index f9b4047b0d..7e0fea4f8e 100644 --- a/packages/airnode-examples/src/scripts/create-aws-secrets.ts +++ b/packages/airnode-examples/src/scripts/create-aws-secrets.ts @@ -47,7 +47,7 @@ const main = async () => { `# This file was generated by: ${relative(__dirname, __filename)}`, '# ', '# For further information see:', - '# https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/configuring-airnode.html#aws-setup-aws-deployment-only', + '# https://docs.api3.org/reference/airnode/latest/understand/configuring.html#aws-setup-aws-deployment-only', `AWS_ACCESS_KEY_ID=${response.accessKeyId}`, `AWS_SECRET_ACCESS_KEY=${response.secretAccessKey}`, `AWS_SESSION_TOKEN=${response.sessionToken}`, diff --git a/packages/airnode-node/README.md b/packages/airnode-node/README.md index f951ad05be..38cb1c516f 100644 --- a/packages/airnode-node/README.md +++ b/packages/airnode-node/README.md @@ -75,7 +75,7 @@ src/ Before you can use or invoke Airnode locally, you must have a valid `config.json` in the `config` folder. You can find the specification in the -[config.json documentation](https://docs.api3.org/airnode/latest/reference/deployment-files/config-json.html). +[config.json documentation](https://docs.api3.org/reference/airnode/latest/deployment-files/config-json.html). For your convenience, example `config.json` and `secrets.env` files are provided in the `config` folder. You can simply copy these files and remove the `.example` from the filename. diff --git a/packages/airnode-node/config/secrets.example.env b/packages/airnode-node/config/secrets.example.env index 6b1712c185..dd2c4cceda 100644 --- a/packages/airnode-node/config/secrets.example.env +++ b/packages/airnode-node/config/secrets.example.env @@ -23,6 +23,6 @@ PROVIDER_URL="http://127.0.0.1:8545" # - myapi_scheme1 # - myapi_scheme2 # -# See: https://docs.api3.org/airnode/latest/grp-providers/guides/build-an-airnode/api-integration.html#ois-template +# See: https://docs.api3.org/reference/airnode/latest/understand/api-integration.html#ois-template # for more information SS_CURRENCY_CONVERTER_API_KEY= diff --git a/packages/airnode-node/docker/README.md b/packages/airnode-node/docker/README.md index e57c008822..497899fc85 100644 --- a/packages/airnode-node/docker/README.md +++ b/packages/airnode-node/docker/README.md @@ -1,7 +1,7 @@ # Airnode Docker image **This README is intended for the developers. Documentation on how to use the client image is in the -[docs](https://docs.api3.org/airnode/latest/grp-providers/docker/client-image.html).** +[docs](https://docs.api3.org/reference/airnode/latest/docker/client-image.html).** This documentation focuses on the Airnode Docker image, not the Airnode itself. If you want to learn more about Airnode, please read [its documentation](../README.md). @@ -18,4 +18,4 @@ yarn docker:build:local > the image will not be built correctly. The configuration and usage is documented in the -[docs](https://docs.api3.org/airnode/latest/grp-providers/docker/client-image.html). +[docs](https://docs.api3.org/reference/airnode/latest/docker/client-image.html). diff --git a/packages/airnode-validator/README.md b/packages/airnode-validator/README.md index 2b6b701899..ab20471f0e 100644 --- a/packages/airnode-validator/README.md +++ b/packages/airnode-validator/README.md @@ -5,7 +5,7 @@ ## Documentation You can find documentation on how to use validator in the -[validator docs](https://docs.api3.org/airnode/latest/reference/packages/validator.html). +[validator docs](https://docs.api3.org/reference/airnode/latest/packages/validator.html). ## For developers diff --git a/packages/airnode-validator/src/config/config.ts b/packages/airnode-validator/src/config/config.ts index f7eec806e9..90ad9c6845 100644 --- a/packages/airnode-validator/src/config/config.ts +++ b/packages/airnode-validator/src/config/config.ts @@ -13,7 +13,7 @@ export const evmIdSchema = z.string().regex(/^0x[a-fA-F0-9]{64}$/); // We use a convention for deriving endpoint ID from OIS title and endpoint name, // but we are not enforcing the convention in docs: -// https://docs.api3.org/airnode/latest/concepts/endpoint.html#endpointid +// https://docs.api3.org/reference/airnode/latest/concepts/endpoint.html#endpointid export const endpointIdSchema = z.string(); export const triggerSchema = z