chore(*): update entity docs link (#89)

* chore(*): update entity docs link * chore(*): use EntityType * chore(*): remove computed
Kong · Sep 8, 2023 · e424786 · e424786
1 parent 7fe9172
commit e424786
Show file tree

Hide file tree

Showing 14 changed files with 74 additions and 31 deletions.
diff --git a/src/composables/useDocsLink.ts b/src/composables/useDocsLink.ts
@@ -1,25 +1,41 @@
-import { computed } from 'vue'
 import { formatVersion } from '@/utils'
-import { config } from 'config'
+import { config, type GatewayEdition } from 'config'
+import { EntityType } from '@/types'
 
-export const useDocsLink = (entity: string) => {
-  const version = computed(() => {
-    if (!config.GATEWAY_VERSION) {
-      return 'latest'
-    }
+const getVersionInPath = (edition: GatewayEdition) => {
+  if (!config.GATEWAY_VERSION) {
+    return 'latest'
+  }
 
-    return `${formatVersion(config.GATEWAY_VERSION)}.x`
-  })
+  return edition === 'enterprise'
+    // For Enterprise, the version has a pattern of <major>.<minor>.0.x where the 3rd digit
+    // will always be 0 regardless of the actual patch version
+    ? `${formatVersion(config.GATEWAY_VERSION)}.0.x`
+    // For OSS, the version has a pattern of <major>.<minor>.x
+    : `${formatVersion(config.GATEWAY_VERSION)}.x`
+}
+
+export const useDocsLink = (entityType: EntityType) => {
+  const edition = config.GATEWAY_EDITION ?? 'community'
+  const versionInPath = getVersionInPath(edition)
+  const docsBase = `https://docs.konghq.com/gateway/api/admin-${edition === 'enterprise' ? 'ee' : 'oss'}/${versionInPath}/#/`
 
-  const docsBase = computed(() => `https://docs.konghq.com/gateway/${version.value}/admin-api`)
-  const docsLink = computed(() => {
-    switch (entity) {
-      case 'key-set':
-        return `${docsBase.value}/#key-sets-entity`
-      default:
-        return `${docsBase.value}/#${entity}-object`
-    }
-  })
+  const entityTypeToSpecLinkMap = {
+    [EntityType.GatewayService]: 'Services',
+    [EntityType.Route]: 'Routes',
+    [EntityType.Consumer]: 'Consumers',
+    [EntityType.ConsumerGroup]: 'consumer_groups',
+    [EntityType.Plugin]: 'Plugins',
+    [EntityType.Upstream]: 'Upstreams',
+    [EntityType.Certificate]: 'Certificates',
+    [EntityType.CACertificate]: 'CA Certificates',
+    [EntityType.SNI]: 'SNIs',
+    [EntityType.Key]: 'Keys',
+    [EntityType.KeySet]: 'Key-sets',
+    [EntityType.Target]: 'Targets',
+    [EntityType.Vault]: 'Vaults',
+  }
+  const docsLink = `${docsBase}${entityTypeToSpecLinkMap[entityType] ?? ''}`
 
   return docsLink
 }
diff --git a/src/pages/ca-certificates/List.vue b/src/pages/ca-certificates/List.vue
@@ -30,6 +30,7 @@ import { useListGeneralConfig } from '@/composables/useListGeneralConfig'
 import { useListRedirect } from '@/composables/useListRedirect'
 import { useToaster } from '@/composables/useToaster'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'CACertificateList',
@@ -38,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('ca-certificate')
+const docsLink = useDocsLink(EntityType.CACertificate)
 
 const createRoute = computed(() => {
   return { name: 'ca-certificate-create' }

diff --git a/src/pages/certificates/List.vue b/src/pages/certificates/List.vue
@@ -30,6 +30,7 @@ import { useListGeneralConfig } from '@/composables/useListGeneralConfig'
 import { useListRedirect } from '@/composables/useListRedirect'
 import { useToaster } from '@/composables/useToaster'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'CertificateList',
@@ -38,7 +39,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('certificate')
+const docsLink = useDocsLink(EntityType.Certificate)
 
 const createRoute = computed(() => {
   return { name: 'certificate-create' }

diff --git a/src/pages/consumers/List.vue b/src/pages/consumers/List.vue
@@ -31,6 +31,7 @@ import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'ConsumerList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('consumer')
+const docsLink = useDocsLink(EntityType.Consumer)
 
 const createRoute = computed(() => {
   return { name: 'consumer-create' }

diff --git a/src/pages/key-sets/List.vue b/src/pages/key-sets/List.vue
@@ -31,6 +31,7 @@ import { useToaster } from '@/composables/useToaster'
 import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'KeySetList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('key-set')
+const docsLink = useDocsLink(EntityType.KeySet)
 
 const filterSchema = computed<FilterSchema>(() => {
   return {

diff --git a/src/pages/keys/List.vue b/src/pages/keys/List.vue
@@ -36,6 +36,7 @@ import { useToaster } from '@/composables/useToaster'
 import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'KeyList',
@@ -45,7 +46,7 @@ const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const route = useRoute()
 const { t } = useI18n()
-const docsLink = useDocsLink('keys')
+const docsLink = useDocsLink(EntityType.Key)
 
 const keySetId = computed(() => (route.params?.id ?? '') as string)
 const cacheIdentifier = computed(() => `routes-${keySetId.value}`)

diff --git a/src/pages/plugins/List.vue b/src/pages/plugins/List.vue
@@ -31,14 +31,15 @@
 <script setup lang="ts">
 import { computed, reactive } from 'vue'
 import { useRoute, type RouteLocationRaw } from 'vue-router'
-import { PluginList, type EntityRow, type ViewRouteType, type EntityType } from '@kong-ui-public/entities-plugins'
+import { PluginList, type EntityRow, type ViewRouteType, type EntityType as ScopedEntityType } from '@kong-ui-public/entities-plugins'
 import type { FilterSchema } from '@kong-ui-public/entities-shared'
 import { useListGeneralConfig } from '@/composables/useListGeneralConfig'
 import { useListRedirect } from '@/composables/useListRedirect'
 import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'PluginList',
@@ -47,10 +48,10 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('plugin')
+const docsLink = useDocsLink(EntityType.Plugin)
 const route = useRoute()
 const cacheIdentifier = computed(() => `plugins-${route.params?.id}`)
-const entityType = computed(() => route.meta?.scopedIn as EntityType)
+const entityType = computed(() => route.meta?.scopedIn as ScopedEntityType)
 const scopedQuery = computed(() => {
   switch (entityType.value) {
     case 'services':

diff --git a/src/pages/routes/List.vue b/src/pages/routes/List.vue
@@ -36,13 +36,14 @@ import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({ name: 'RouteList' })
 
 const toaster = useToaster()
 const route = useRoute()
 const { t } = useI18n()
-const docsLink = useDocsLink('route')
+const docsLink = useDocsLink(EntityType.Route)
 const { createRedirectRouteQuery } = useListRedirect()
 
 const serviceId = computed(() => (route.params?.id ?? '') as string)

diff --git a/src/pages/services/List.vue b/src/pages/services/List.vue
@@ -31,6 +31,7 @@ import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'ServiceList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('service')
+const docsLink = useDocsLink(EntityType.GatewayService)
 
 const createRoute = computed(() => {
   return { name: 'service-create' }

diff --git a/src/pages/snis/List.vue b/src/pages/snis/List.vue
@@ -31,6 +31,7 @@ import { useListGeneralConfig } from '@/composables/useListGeneralConfig'
 import { useListRedirect } from '@/composables/useListRedirect'
 import { useToaster } from '@/composables/useToaster'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'SniList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('sni')
+const docsLink = useDocsLink(EntityType.SNI)
 
 const createRoute = computed(() => {
   return { name: 'sni-create' }

diff --git a/src/pages/upstreams/List.vue b/src/pages/upstreams/List.vue
@@ -31,6 +31,7 @@ import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'UpstreamList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('upstream')
+const docsLink = useDocsLink(EntityType.Upstream)
 
 const createRoute = computed(() => {
   return { name: 'upstream-create' }

diff --git a/src/pages/vaults/List.vue b/src/pages/vaults/List.vue
@@ -31,6 +31,7 @@ import { useCopyEventHandlers } from '@/composables/useCopyEventHandlers'
 import { useToaster } from '@/composables/useToaster'
 import { useI18n } from '@/composables/useI18n'
 import { useDocsLink } from '@/composables/useDocsLink'
+import { EntityType } from '@/types'
 
 defineOptions({
   name: 'VaultList',
@@ -39,7 +40,7 @@ defineOptions({
 const { createRedirectRouteQuery } = useListRedirect()
 const toaster = useToaster()
 const { t } = useI18n()
-const docsLink = useDocsLink('vaults')
+const docsLink = useDocsLink(EntityType.Vault)
 
 const createRoute = computed(() => {
   return { name: 'vault-create' }

diff --git a/src/types/entity.ts b/src/types/entity.ts
@@ -0,0 +1,15 @@
+export enum EntityType {
+  GatewayService = 1,
+  Route,
+  Consumer,
+  ConsumerGroup,
+  Plugin,
+  Upstream,
+  Certificate,
+  CACertificate,
+  SNI,
+  Key,
+  KeySet,
+  Target,
+  Vault,
+}
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -0,0 +1 @@
+export * from './entity'