Merge branch 'master' into DOC-2183-API-Ocean-Spark-oceanSparkCluster…

…Config-schema-addition-NEW
spotinst · Jan 30, 2025 · faf3d7b · faf3d7b
2 parents 06970fd + c575b31
commit faf3d7b
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 5 deletions.
diff --git a/api/services/administration/general/schemas/createAccessPolicy.yaml b/api/services/administration/general/schemas/createAccessPolicy.yaml
@@ -6,7 +6,8 @@ properties:
     properties:
       name:
         type: string
-        description: Name of the Policy
+        description: >
+          Name of the Policy. Note: names cannot include these characters: + = @
         example: my policy
       description:
         type: string

diff --git a/api/services/administration/general/schemas/createProgrammaticUser.yaml b/api/services/administration/general/schemas/createProgrammaticUser.yaml
@@ -8,7 +8,8 @@ properties:
     example: test programmatic
   name:
     type: string
-    description: Name of the programmatic user.
+    description: >
+        Name of the programmatic user. Note: names cannot include these characters: + = @
     example: testProgrammaticApi
   accounts:
     type: array

diff --git a/api/services/administration/general/schemas/createUser.yaml b/api/services/administration/general/schemas/createUser.yaml
@@ -2,11 +2,13 @@ type: object
 properties:
   firstName:
     type: string
-    description: The first name of the user
+    description: >
+      The first name of the user. Note: names cannot include these characters: + = @
     example: Test
   lastName:
     type: string
-    description: The last name of the user
+    description: > 
+      The last name of the user. Note: names cannot include these characters: + = @
     example: Test
   email:
     type: string

diff --git a/api/services/administration/general/schemas/userGroup/createUserGroup.yaml b/api/services/administration/general/schemas/userGroup/createUserGroup.yaml
@@ -7,7 +7,8 @@ properties:
     example: "ugr-a1b2c3d4"
   name:
     type: string
-    description: user group name
+    description: >
+      Name of the user group. Note: names cannot include these characters: + = @
     example: "Developers"
   description:
     type: string