Add default values for API Key Authentication

wso2 · Apr 30, 2024 · c7ca062 · c7ca062
1 parent 3e7c0cd
commit c7ca062
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 16 deletions.
diff --git a/runtime/config-deployer-service/ballerina/APIClient.bal b/runtime/config-deployer-service/ballerina/APIClient.bal
@@ -361,16 +361,14 @@ public class APIClient {
  } else if authentication.authType == "JWT" {
  JWTAuthentication jwtAuthentication = check authentication.cloneWithType(JWTAuthentication);
  authTypes.jwt = {header: <string>jwtAuthentication.headerName, sendTokenToUpstream: <boolean>jwtAuthentication.sendTokenToUpstream, disabled: !jwtAuthentication.enabled, audience: jwtAuthentication.audience};
- } else if authentication.authType == "APIKey" {
+ } else if authentication.authType == "APIKey" && authentication is APIKeyAuthentication {
  APIKeyAuthentication apiKeyAuthentication = check authentication.cloneWithType(APIKeyAuthentication);
  model:APIKey[] apiKeys = [];
- boolean|() headerEnabled = apiKeyAuthentication.headerEnable;
- boolean|() queryEnabled = apiKeyAuthentication.queryParamEnable;
 
- if headerEnabled is boolean && headerEnabled {
+ if apiKeyAuthentication.headerEnable {
  apiKeys.push({'in: "Header", name: <string>apiKeyAuthentication.headerName, sendTokenToUpstream: apiKeyAuthentication.sendTokenToUpstream});
  }
- if queryEnabled is boolean && queryEnabled {
+ if apiKeyAuthentication.queryParamEnable {
  apiKeys.push({'in: "Query", name: <string>apiKeyAuthentication.queryParamName, sendTokenToUpstream: apiKeyAuthentication.sendTokenToUpstream});
  }
  authTypes.apiKey = apiKeys;

diff --git a/runtime/config-deployer-service/ballerina/resources/apk-conf-schema.yaml b/runtime/config-deployer-service/ballerina/resources/apk-conf-schema.yaml
@@ -150,7 +150,7 @@ components:
  headerEnable:
  type: boolean
  default: true
- audience: 
+ audience:
  type: array
  default: []
  items:
@@ -173,7 +173,7 @@ components:
  default: false
  headerName:
  type: string
- example: Authorization
+ example: apikey
  default: apikey
  queryParamName:
  type: string

diff --git a/runtime/config-deployer-service/ballerina/tests/resources/apiKeyOnly.apk-conf b/runtime/config-deployer-service/ballerina/tests/resources/apiKeyOnly.apk-conf
@@ -18,7 +18,6 @@ authentication:
  - authType: "APIKey"
  enabled: true
  queryParamEnable: true
- headerEnable: true
 corsConfiguration:
  corsConfigurationEnabled: false
  accessControlAllowOrigins:

diff --git a/runtime/config-deployer-service/ballerina/tests/resources/apk-schema.json b/runtime/config-deployer-service/ballerina/tests/resources/apk-schema.json
@@ -213,7 +213,7 @@
  },
  "headerName": {
  "type": "string",
- "example": "Authorization",
+ "example": "apikey",
  "default": "apikey"
  },
  "queryParamName": {

diff --git a/runtime/config-deployer-service/ballerina/tests/resources/jwtandAPIKey.apk-conf b/runtime/config-deployer-service/ballerina/tests/resources/jwtandAPIKey.apk-conf
@@ -20,7 +20,6 @@ authentication:
  - authType: "APIKey"
  enabled: true
  queryParamEnable: true
- headerEnable: true
 corsConfiguration:
  corsConfigurationEnabled: false
  accessControlAllowOrigins:

diff --git a/runtime/config-deployer-service/ballerina/types.bal b/runtime/config-deployer-service/ballerina/types.bal
@@ -277,8 +277,8 @@ public type APIKeyAuthentication record {|
  boolean sendTokenToUpstream = false;
  string headerName = "apiKey";
  string queryParamName = "apiKey";
- boolean headerEnable?;
- boolean queryParamEnable?;
+ boolean headerEnable = true;
+ boolean queryParamEnable = false;
 |};
 
 # Mutual SSL configuration of this API

diff --git a/runtime/config-deployer-service/docker/config-deployer/conf/apk-schema.json b/runtime/config-deployer-service/docker/config-deployer/conf/apk-schema.json
@@ -156,11 +156,16 @@
  "required": {
  "type": "string",
  "default": "mandatory",
- "enum": ["mandatory", "optional"]
+ "enum": [
+ "mandatory",
+ "optional"
+ ]
  },
  "authType": {
  "type": "string",
- "enum": ["JWT"]
+ "enum": [
+ "JWT"
+ ]
  },
  "sendTokenToUpstream": {
  "type": "boolean",
@@ -253,7 +258,7 @@
  },
  "headerName": {
  "type": "string",
- "example": "Authorization",
+ "example": "apikey",
  "default": "apikey"
  },
  "queryParamName": {
@@ -608,7 +613,7 @@
  }
  }
  },
- "required":[
+ "required": [
  "target",
  "verb"
  ],