feat(core): update custom id schema (#204)

api7 · Nov 11, 2024 · fcbd0fd · fcbd0fd
1 parent a78ab95
commit fcbd0fd
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 0 deletions.
diff --git a/apps/cli/src/linter/schema.ts b/apps/cli/src/linter/schema.ts
@@ -1,5 +1,10 @@
 import { z } from 'zod';
 
+const idSchema = z
+  .string()
+  .min(1)
+  .max(64)
+  .regex(/^[a-zA-Z0-9-_.]+$/);
 const nameSchema = z
   .string()
   .min(1)
@@ -178,6 +183,7 @@ const upstreamSchema = z
 
 const routeSchema = z
   .object({
+    id: idSchema.optional(),
     name: nameSchema,
     description: descriptionSchema.optional(),
     labels: labelsSchema.optional(),
@@ -213,6 +219,7 @@ const routeSchema = z
 
 const streamRouteSchema = z
   .object({
+    id: idSchema.optional(),
     name: nameSchema,
     description: descriptionSchema.optional(),
     labels: labelsSchema.optional(),
@@ -228,6 +235,7 @@ const streamRouteSchema = z
 
 const serviceSchema = z
   .object({
+    id: idSchema.optional(),
     name: nameSchema,
     description: descriptionSchema.optional(),
     labels: labelsSchema.optional(),
@@ -261,6 +269,7 @@ const serviceSchema = z
 
 const sslSchema = z
   .object({
+    id: idSchema.optional(),
     labels: labelsSchema.optional(),
 
     type: z.enum(['server', 'client']).default('server').optional(),
@@ -294,6 +303,7 @@ const sslSchema = z
 
 const consumerCredentialSchema = z
   .object({
+    id: idSchema.optional(),
     name: nameSchema,
     description: descriptionSchema.optional(),
     labels: labelsSchema.optional(),
@@ -324,6 +334,7 @@ const consumerSchema = z
 
 const consumerGroupSchema = z
   .object({
+    id: idSchema.optional(),
     name: nameSchema,
     description: descriptionSchema.optional(),
     labels: labelsSchema.optional(),

diff --git a/apps/cli/src/linter/specs/common.spec.ts b/apps/cli/src/linter/specs/common.spec.ts
@@ -51,6 +51,25 @@ describe('Common Linter', () => {
         },
       ],
     },
+    {
+      name: 'should check custom resource id',
+      input: {
+        services: [
+          {
+            id: 'custom-service',
+            name: 'test',
+            routes: [
+              {
+                id: 'custom-route',
+                name: 'test',
+                uris: ['/test'],
+              },
+            ],
+          },
+        ],
+      } as ADCSDK.Configuration,
+      expect: true,
+    },
   ];
 
   // test cases runner

diff --git a/schema.json b/schema.json
@@ -6,6 +6,12 @@
       "items": {
         "type": "object",
         "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 64,
+            "pattern": "^[a-zA-Z0-9-_.]+$"
+          },
           "name": {
             "type": "string",
             "minLength": 1,
@@ -397,6 +403,9 @@
             "items": {
               "type": "object",
               "properties": {
+                "id": {
+                  "$ref": "#/properties/services/items/properties/id"
+                },
                 "name": {
                   "$ref": "#/properties/services/items/properties/name"
                 },
@@ -483,6 +492,9 @@
             "items": {
               "type": "object",
               "properties": {
+                "id": {
+                  "$ref": "#/properties/services/items/properties/id"
+                },
                 "name": {
                   "$ref": "#/properties/services/items/properties/name"
                 },
@@ -526,6 +538,9 @@
       "items": {
         "type": "object",
         "properties": {
+          "id": {
+            "$ref": "#/properties/services/items/properties/id"
+          },
           "labels": {
             "$ref": "#/properties/services/items/properties/labels"
           },
@@ -648,6 +663,9 @@
             "items": {
               "type": "object",
               "properties": {
+                "id": {
+                  "$ref": "#/properties/services/items/properties/id"
+                },
                 "name": {
                   "$ref": "#/properties/services/items/properties/name"
                 },
@@ -684,6 +702,9 @@
       "items": {
         "type": "object",
         "properties": {
+          "id": {
+            "$ref": "#/properties/services/items/properties/id"
+          },
           "name": {
             "$ref": "#/properties/services/items/properties/name"
           },