feat: make operationParameter optional within endpoint parameters (#1888

) * Bump @api3/ois to v2.2.0 and zod to v3.22.2 * Bump oisFormat in configs and test files * feat: make operationParameter optional within endpoint parameters
api3dao · Jan 18, 2024 · b335b35 · b335b35
1 parent 283e2b3
commit b335b35
Show file tree

Hide file tree

Showing 39 changed files with 86 additions and 47 deletions.
diff --git a/.changeset/hungry-clouds-grow.md b/.changeset/hungry-clouds-grow.md
@@ -0,0 +1,9 @@
+---
+'@api3/airnode-validator': minor
+'@api3/airnode-deployer': minor
+'@api3/airnode-examples': minor
+'@api3/airnode-adapter': minor
+'@api3/airnode-node': minor
+---
+
+Bump OIS to v2.2.0 and make operationParameter optional within endpoint parameters
diff --git a/packages/airnode-adapter/package.json b/packages/airnode-adapter/package.json
@@ -19,7 +19,7 @@
     "test:watch": "yarn test:ts --watch"
   },
   "dependencies": {
-    "@api3/ois": "2.1.0",
+    "@api3/ois": "2.2.0",
     "@api3/promise-utils": "^0.4.0",
     "axios": "^1.5.0",
     "bignumber.js": "^9.1.2",

diff --git a/packages/airnode-adapter/src/request-building/parameters.test.ts b/packages/airnode-adapter/src/request-building/parameters.test.ts
@@ -81,6 +81,33 @@ describe('fixed parameters', () => {
       headers: {},
     });
   });
+
+  it('ignores parameters without operationParameter', () => {
+    const ois = fixtures.buildOIS();
+    ois.apiSpecifications.paths['/convert'].get!.parameters.push({ in: 'query', name: 'noOperationParameter' });
+    const options = fixtures.buildCacheRequestOptions({
+      ois,
+      parameters: { f: 'ETH', amount: '1', no_op: 'myValue' },
+    });
+    options.endpoint.parameters.push({
+      name: 'no_op',
+      // operationParameter is absent
+    });
+    options.operation.parameters.push({ name: 'noOperationParameter', in: 'query' });
+    const res = parameters.buildParameters(options);
+    expect(res).toEqual({
+      paths: {},
+      query: {
+        // Expectedly absent:
+        // noOperationParameter: 'myValue',
+        access_key: 'super-secret-key',
+        amount: '1',
+        from: 'ETH',
+        to: 'USD',
+      },
+      headers: {},
+    });
+  });
 });
 
 describe('user parameters', () => {

diff --git a/packages/airnode-adapter/src/request-building/parameters.ts b/packages/airnode-adapter/src/request-building/parameters.ts
@@ -3,7 +3,7 @@ import * as authentication from './authentication';
 import * as cookies from './cookies';
 import { BuilderParameters, CachedBuildRequestOptions, RequestParameters } from '../types';
 
-function initalParameters(): BuilderParameters {
+function initialParameters(): BuilderParameters {
   return {
     paths: {},
     query: {},
@@ -49,7 +49,7 @@ function buildFixedParameters(options: CachedBuildRequestOptions): BuilderParame
     }
 
     return appendParameter(acc, target, name, parameter.value);
-  }, initalParameters());
+  }, initialParameters());
 }
 
 function buildUserParameters(options: CachedBuildRequestOptions): BuilderParameters {
@@ -66,16 +66,19 @@ function buildUserParameters(options: CachedBuildRequestOptions): BuilderParamet
 
     // Double check that the parameter exists in the API specification
     const apiParameter = operation.parameters.find(
-      (p) => p.name === parameter.operationParameter.name && p.in === parameter.operationParameter.in
+      (p) =>
+        parameter.operationParameter &&
+        p.name === parameter.operationParameter.name &&
+        p.in === parameter.operationParameter.in
     );
-    if (!apiParameter) {
+    if (!apiParameter || !parameter.operationParameter) {
       return acc;
     }
 
     const { name, in: target } = parameter.operationParameter;
 
     return appendParameter(acc, target, name, parameters[key]);
-  }, initalParameters());
+  }, initialParameters());
 }
 
 export function buildParameters(options: CachedBuildRequestOptions): RequestParameters {

diff --git a/packages/airnode-adapter/test/fixtures/ois.ts b/packages/airnode-adapter/test/fixtures/ois.ts
@@ -2,7 +2,7 @@ import { OIS } from '@api3/ois';
 
 export function buildOIS(overrides?: Partial<OIS>): OIS {
   return {
-    oisFormat: '2.1.0',
+    oisFormat: '2.2.0',
     version: '1.2.3',
     title: 'Currency Converter API',
     apiSpecifications: {

diff --git a/packages/airnode-deployer/config/config.example.json b/packages/airnode-deployer/config/config.example.json
@@ -94,7 +94,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-deployer/package.json b/packages/airnode-deployer/package.json
@@ -43,7 +43,7 @@
     "lodash": "^4.17.21",
     "ora": "^5.4.1",
     "yargs": "^17.7.2",
-    "zod": "^3.21.4"
+    "zod": "^3.22.2"
   },
   "devDependencies": {
     "@aws-sdk/util-stream-node": "^3.370.0",

diff --git a/packages/airnode-deployer/test/fixtures/config.aws.valid.json b/packages/airnode-deployer/test/fixtures/config.aws.valid.json
@@ -95,7 +95,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-deployer/test/fixtures/config.gcp.valid.json b/packages/airnode-deployer/test/fixtures/config.gcp.valid.json
@@ -93,7 +93,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json b/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinMarketCap Basic Authenticated Request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts b/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinMarketCap Basic Authenticated Request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json
@@ -111,7 +111,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts
@@ -119,7 +119,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json b/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json
@@ -99,7 +99,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts b/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts
@@ -106,7 +106,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko coins markets request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko coins markets request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko history data request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko history data request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko-template/config.example.json b/packages/airnode-examples/integrations/coingecko-template/config.example.json
@@ -89,7 +89,7 @@
   ],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko-template/create-config.ts b/packages/airnode-examples/integrations/coingecko-template/create-config.ts
@@ -98,7 +98,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   ],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/coingecko/config.example.json b/packages/airnode-examples/integrations/coingecko/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/coingecko/create-config.ts b/packages/airnode-examples/integrations/coingecko/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/failing-example/config.example.json b/packages/airnode-examples/integrations/failing-example/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "Failure Example",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/failing-example/create-config.ts b/packages/airnode-examples/integrations/failing-example/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'Failure Example',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/relay-security-schemes/config.example.json b/packages/airnode-examples/integrations/relay-security-schemes/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "Relay Security Schemes via httpbin",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts b/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'Relay Security Schemes via httpbin',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-examples/integrations/weather-multi-value/config.example.json b/packages/airnode-examples/integrations/weather-multi-value/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "OpenWeather Multiple Encoded Values",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-examples/integrations/weather-multi-value/create-config.ts b/packages/airnode-examples/integrations/weather-multi-value/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.1.0',
+      oisFormat: '2.2.0',
       title: 'OpenWeather Multiple Encoded Values',
       version: '1.0.0',
       apiSpecifications: {

diff --git a/packages/airnode-node/config/config.example.json b/packages/airnode-node/config/config.example.json
@@ -113,7 +113,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "version": "1.2.3",
       "title": "Currency Converter API",
       "apiSpecifications": {

diff --git a/packages/airnode-node/package.json b/packages/airnode-node/package.json
@@ -29,7 +29,7 @@
     "@api3/airnode-protocol": "^0.12.0",
     "@api3/airnode-utilities": "^0.12.0",
     "@api3/airnode-validator": "^0.12.0",
-    "@api3/ois": "2.1.0",
+    "@api3/ois": "2.2.0",
     "@api3/promise-utils": "^0.4.0",
     "@aws-sdk/client-lambda": "^3.418.0",
     "date-fns": "^2.30.0",
@@ -39,7 +39,7 @@
     "google-auth-library": "^9.0.0",
     "lodash": "^4.17.21",
     "yargs": "^17.7.2",
-    "zod": "^3.21.4"
+    "zod": "^3.22.2"
   },
   "devDependencies": {
     "@api3/airnode-operation": "^0.12.0",

diff --git a/packages/airnode-node/test/fixtures/config/config.valid.json b/packages/airnode-node/test/fixtures/config/config.valid.json
@@ -84,7 +84,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-node/test/fixtures/config/ois.ts b/packages/airnode-node/test/fixtures/config/ois.ts
@@ -2,7 +2,7 @@ import { OIS } from '@api3/ois';
 
 export function buildOIS(ois?: Partial<OIS>): OIS {
   return {
-    oisFormat: '2.1.0',
+    oisFormat: '2.2.0',
     version: '1.2.3',
     title: 'Currency Converter API',
     apiSpecifications: {

diff --git a/packages/airnode-validator/package.json b/packages/airnode-validator/package.json
@@ -22,14 +22,14 @@
   },
   "dependencies": {
     "@api3/airnode-protocol": "^0.12.0",
-    "@api3/ois": "2.1.0",
+    "@api3/ois": "2.2.0",
     "@api3/promise-utils": "^0.4.0",
     "dotenv": "^16.3.1",
     "ethers": "^5.7.2",
     "lodash": "^4.17.21",
     "ora": "^5.4.1",
     "yargs": "^17.7.2",
-    "zod": "^3.21.4"
+    "zod": "^3.22.2"
   },
   "devDependencies": {
     "@types/yargs": "^17.0.25",

diff --git a/packages/airnode-validator/test/fixtures/config.valid.json b/packages/airnode-validator/test/fixtures/config.valid.json
@@ -102,7 +102,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {

diff --git a/packages/airnode-validator/test/fixtures/interpolated-config.valid.json b/packages/airnode-validator/test/fixtures/interpolated-config.valid.json
@@ -106,7 +106,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.1.0",
+      "oisFormat": "2.2.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {