refactor(entities): remove config.requestHeaders [KM-43] (#1302)

BREAKING CHANGE: Now `config.requestHeaders` is removed. Use `config.axiosRequestConfig` instead.
Kong · Apr 2, 2024 · 144c9d8 · 144c9d8
1 parent 8de453e
commit 144c9d8
Show file tree

Hide file tree

Showing 82 changed files with 165 additions and 255 deletions.
diff --git a/packages/entities/entities-certificates/docs/ca-certificate-config-card.md b/packages/entities/entities-certificates/docs/ca-certificate-config-card.md
@@ -43,11 +43,11 @@ A config card component for CA certificates.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`

diff --git a/packages/entities/entities-certificates/docs/ca-certificate-form.md b/packages/entities/entities-certificates/docs/ca-certificate-form.md
@@ -43,11 +43,11 @@ A form component for CA Certificates.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `cancelRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-certificates/docs/ca-certificate-list.md b/packages/entities/entities-certificates/docs/ca-certificate-list.md
@@ -43,11 +43,11 @@ A table component for ca-certificates.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-certificates/docs/certificate-config-card.md b/packages/entities/entities-certificates/docs/certificate-config-card.md
@@ -43,11 +43,11 @@ A form component for Certificate.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`

diff --git a/packages/entities/entities-certificates/docs/certificate-form.md b/packages/entities/entities-certificates/docs/certificate-form.md
@@ -43,11 +43,11 @@ A form component for Certificates.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `cancelRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-certificates/docs/certificate-list.md b/packages/entities/entities-certificates/docs/certificate-list.md
@@ -43,11 +43,11 @@ A table component for certificates.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-certificates/src/components/CACertificateForm.vue b/packages/entities/entities-certificates/src/components/CACertificateForm.vue
@@ -107,9 +107,7 @@ const router = useRouter()
 const { i18n: { t } } = composables.useI18n()
 const { getMessageFromError } = useErrors()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 
 const fetchUrl = computed<string>(() => endpoints.form[props.config.app].edit)
 const formType = computed((): EntityBaseFormType => props.certificateId ? EntityBaseFormType.Edit : EntityBaseFormType.Create)

diff --git a/packages/entities/entities-certificates/src/components/CACertificateList.vue b/packages/entities/entities-certificates/src/components/CACertificateList.vue
@@ -234,9 +234,7 @@ const props = defineProps({
 const { i18n: { t, formatUnixTimeStamp }, i18nT } = composables.useI18n()
 const router = useRouter()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetcherCacheKey = ref<number>(1)
 
 /**

diff --git a/packages/entities/entities-certificates/src/components/CertificateForm.vue b/packages/entities/entities-certificates/src/components/CertificateForm.vue
@@ -169,9 +169,7 @@ const router = useRouter()
 const { i18nT, i18n: { t } } = composables.useI18n()
 const { getMessageFromError } = useErrors()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 
 const fetchUrl = computed<string>(() => endpoints.form[props.config.app].edit)
 const formType = computed((): EntityBaseFormType => props.certificateId ? EntityBaseFormType.Edit : EntityBaseFormType.Create)

diff --git a/packages/entities/entities-certificates/src/components/CertificateList.vue b/packages/entities/entities-certificates/src/components/CertificateList.vue
@@ -264,9 +264,7 @@ const props = defineProps({
 const { i18n: { t, formatUnixTimeStamp }, i18nT } = composables.useI18n()
 const router = useRouter()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetcherCacheKey = ref<number>(1)
 
 /**

diff --git a/packages/entities/entities-consumer-credentials/docs/consumer-credential-list.md b/packages/entities/entities-consumer-credentials/docs/consumer-credential-list.md
@@ -43,11 +43,11 @@ A table component for consumer credentials.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-consumer-credentials/src/components/ConsumerCredentialList.vue b/packages/entities/entities-consumer-credentials/src/components/ConsumerCredentialList.vue
@@ -268,9 +268,7 @@ const props = defineProps({
 
 const { i18n: { t, formatUnixTimeStamp } } = composables.useI18n()
 
-const { axiosInstance } = useAxios({
-  headers: props.config.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetcherCacheKey = ref<number>(1)
 
 /**

diff --git a/packages/entities/entities-consumer-groups/docs/consumer-group-config-card.md b/packages/entities/entities-consumer-groups/docs/consumer-group-config-card.md
@@ -43,11 +43,11 @@ A config card component for consumer groups.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`

diff --git a/packages/entities/entities-consumer-groups/docs/consumer-group-form.md b/packages/entities/entities-consumer-groups/docs/consumer-group-form.md
@@ -40,11 +40,11 @@ A form component to create/edit Consumer Group.
         - required: `true`
         - default: `undefined`
         - Base URL for API requests.
-    - `requestHeaders`:
-        - type: `RawAxiosRequestHeaders | AxiosHeaders`
+    - `axiosRequestConfig`:
+        - type: `AxiosRequestConfig`
         - required: `false`
         - default: `undefined`
-        - Additional headers to send with all Axios requests.
+        - An optional configuration object for the underlying Axios request.
     - `cancelRoute`:
         - type: `RouteLocationRaw`
         - required: `true`

diff --git a/packages/entities/entities-consumer-groups/docs/consumer-group-list.md b/packages/entities/entities-consumer-groups/docs/consumer-group-list.md
@@ -43,11 +43,11 @@ A table component for consumer groups.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-consumer-groups/src/components/AddToGroupModal.vue b/packages/entities/entities-consumer-groups/src/components/AddToGroupModal.vue
@@ -92,9 +92,7 @@ const emit = defineEmits<{
   (e: 'error', msg: string): void
 }>()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 
 /**
  * ------------------------------

diff --git a/packages/entities/entities-consumer-groups/src/components/ConsumerGroupForm.vue b/packages/entities/entities-consumer-groups/src/components/ConsumerGroupForm.vue
@@ -160,9 +160,7 @@ const {
   searchKeys: ['username', 'custom_id', 'id'],
 })
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const { getMessageFromError } = useErrors()
 const validators = useValidators()
 

diff --git a/packages/entities/entities-consumer-groups/src/components/ConsumerGroupList.vue b/packages/entities/entities-consumer-groups/src/components/ConsumerGroupList.vue
@@ -271,9 +271,7 @@ const props = defineProps({
 const { i18nT, i18n: { t } } = composables.useI18n()
 const router = useRouter()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetcherCacheKey = ref<number>(1)
 const isConsumerPage = computed<boolean>(() => !!props.config.consumerId)
 const preferencesStorageKey = computed<string>(

diff --git a/packages/entities/entities-consumers/docs/consumer-config-card.md b/packages/entities/entities-consumers/docs/consumer-config-card.md
@@ -43,11 +43,11 @@ A form component for consumer.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`

diff --git a/packages/entities/entities-consumers/docs/consumer-form.md b/packages/entities/entities-consumers/docs/consumer-form.md
@@ -40,11 +40,11 @@ A form component to create/edit Consumer.
         - required: `true`
         - default: `undefined`
         - Base URL for API requests.
-    - `requestHeaders`:
-        - type: `RawAxiosRequestHeaders | AxiosHeaders`
+    - `axiosRequestConfig`:
+        - type: `AxiosRequestConfig`
         - required: `false`
         - default: `undefined`
-        - Additional headers to send with all Axios requests.
+        - An optional configuration object for the underlying Axios request.
     - `cancelRoute`:
       - type: `RouteLocationRaw`
       - required: `true`

diff --git a/packages/entities/entities-consumers/docs/consumer-list.md b/packages/entities/entities-consumers/docs/consumer-list.md
@@ -43,11 +43,11 @@ A table component for consumers.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-consumers/src/components/AddConsumerModal.vue b/packages/entities/entities-consumers/src/components/AddConsumerModal.vue
@@ -104,9 +104,7 @@ const emit = defineEmits<{
   (e: 'error', msg: string): void
 }>()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 
 /**
  * ------------------------------

diff --git a/packages/entities/entities-consumers/src/components/ConsumerForm.vue b/packages/entities/entities-consumers/src/components/ConsumerForm.vue
@@ -150,9 +150,7 @@ const emit = defineEmits<{
 
 const { i18nT, i18n: { t } } = composables.useI18n()
 const router = useRouter()
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const { getMessageFromError } = useErrors()
 const uuid = uuidv4()
 

diff --git a/packages/entities/entities-consumers/src/components/ConsumerList.vue b/packages/entities/entities-consumers/src/components/ConsumerList.vue
@@ -271,9 +271,7 @@ const props = defineProps({
 const { i18nT, i18n: { t } } = composables.useI18n()
 const router = useRouter()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetcherCacheKey = ref<number>(1)
 const isConsumerGroupPage = computed<boolean>(() => !!props.config.consumerGroupId)
 const preferencesStorageKey = computed<string>(

diff --git a/packages/entities/entities-gateway-services/docs/gateway-service-config-card.md b/packages/entities/entities-gateway-services/docs/gateway-service-config-card.md
@@ -43,11 +43,11 @@ A config card component for gateway services.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`

diff --git a/packages/entities/entities-gateway-services/docs/gateway-service-form.md b/packages/entities/entities-gateway-services/docs/gateway-service-form.md
@@ -44,11 +44,11 @@ A form component for gateway services.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `cancelRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-gateway-services/docs/gateway-service-list.md b/packages/entities/entities-gateway-services/docs/gateway-service-list.md
@@ -43,11 +43,11 @@ A table component for gateway services.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `createRoute`:
     - type: `RouteLocationRaw`

diff --git a/packages/entities/entities-gateway-services/src/components/GatewayServiceForm.vue b/packages/entities/entities-gateway-services/src/components/GatewayServiceForm.vue
@@ -406,9 +406,7 @@ const isCollapsed = ref(true)
 const router = useRouter()
 const { i18nT, i18n: { t } } = composables.useI18n()
 const { getMessageFromError } = useErrors()
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const validators = useValidators()
 
 const fetchUrl = computed<string>(() => endpoints.form[props.config.app].edit)

diff --git a/packages/entities/entities-gateway-services/src/components/GatewayServiceList.vue b/packages/entities/entities-gateway-services/src/components/GatewayServiceList.vue
@@ -257,9 +257,7 @@ const props = defineProps({
 const { i18n: { t } } = composables.useI18n()
 const router = useRouter()
 
-const { axiosInstance } = useAxios({
-  headers: props.config?.requestHeaders,
-})
+const { axiosInstance } = useAxios(props.config?.axiosRequestConfig)
 const fetchCacheKey = ref<number>(1)
 
 /**

diff --git a/packages/entities/entities-key-sets/docs/key-set-config-card.md b/packages/entities/entities-key-sets/docs/key-set-config-card.md
@@ -43,11 +43,11 @@ A config card component for Key Sets.
     - default: `undefined`
     - Base URL for API requests.
 
-  - `requestHeaders`:
-    - type: `RawAxiosRequestHeaders | AxiosHeaders`
+  - `axiosRequestConfig`:
+    - type: `AxiosRequestConfig`
     - required: `false`
     - default: `undefined`
-    - Additional headers to send with all Axios requests.
+    - An optional configuration object for the underlying Axios request.
 
   - `workspace`:
     - type: `string`