update examples

Signed-off-by: nithyatsu <[email protected]> wip Signed-off-by: nithyatsu <[email protected]> update description Signed-off-by: nithyatsu <[email protected]> nit Signed-off-by: nithyatsu <[email protected]> wip Signed-off-by: nithyatsu <[email protected]>
radius-project · Jul 3, 2024 · 259d384 · 259d384
1 parent b22efbb
commit 259d384
Show file tree

Hide file tree

Showing 24 changed files with 578 additions and 24 deletions.
diff --git a/pkg/ucp/api/v20231001preview/zz_generated_constants.go b/pkg/ucp/api/v20231001preview/zz_generated_constants.go
diff --git a/pkg/ucp/api/v20231001preview/zz_generated_models.go b/pkg/ucp/api/v20231001preview/zz_generated_models.go
diff --git a/...preview/AWSCredential_CreateOrUpdate.json → ...SCredential_AccessKey_CreateOrUpdate.json b/...preview/AWSCredential_CreateOrUpdate.json → ...SCredential_AccessKey_CreateOrUpdate.json
@@ -1,6 +1,6 @@
 {
     "operationId": "AwsCredentials_CreateOrUpdate",
-    "title": "Create or update an AWS credential",
+    "title": "Create or update an AWS AccessKey credential",
     "parameters": {
         "api-version": "2023-10-01-preview",
         "planeType": "aws",

diff --git a/...ource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_AccessKey_Delete.json b/...ource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_AccessKey_Delete.json
@@ -0,0 +1,14 @@
+{
+    "operationId": "AwsCredentials_Delete",
+    "title": "Delete an AWS AccessKey credential",
+    "parameters": {
+        "api-version": "2023-10-01-preview",
+        "planeType": "aws",
+        "planeName": "awscloud",
+        "credentialName": "default"
+    },
+    "responses": {
+        "200": {},
+        "204": {}
+    }
+}
diff --git a/...2023-10-01-preview/AWSCredential_Get.json → ...examples/AWSCredential_AccessKey_Get.json b/...2023-10-01-preview/AWSCredential_Get.json → ...examples/AWSCredential_AccessKey_Get.json
@@ -1,6 +1,6 @@
 {
     "operationId": "AwsCredentials_Get",
-    "title": "Get an AWS credential",
+    "title": "Get an AWS AccessKey credential",
     "parameters": {
         "api-version": "2023-10-01-preview",
         "planeType": "aws",

diff --git a/...023-10-01-preview/AWSCredential_List.json → ...xamples/AWSCredential_AccessKey_List.json b/...023-10-01-preview/AWSCredential_List.json → ...xamples/AWSCredential_AccessKey_List.json
@@ -1,6 +1,6 @@
 {
     "operationId": "AwsCredentials_List",
-    "title": "List AWS credentials",
+    "title": "List AWS AccessKey credential",
     "parameters": {
         "api-version": "2023-10-01-preview",
         "planeType": "aws",

diff --git a/...3-10-01-preview/AWSCredential_Update.json → ...mples/AWSCredential_AccessKey_Update.json b/...3-10-01-preview/AWSCredential_Update.json → ...mples/AWSCredential_AccessKey_Update.json
@@ -1,6 +1,6 @@
 {
     "operationId": "AwsCredentials_Update",
-    "title": "Update an AWS credential",
+    "title": "Update an AWS AccessKey credential",
     "parameters": {
         "api-version": "2023-10-01-preview",
         "planeType": "aws",

diff --git a/...ce-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_CreateOrUpdate.json b/...ce-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_CreateOrUpdate.json
@@ -0,0 +1,54 @@
+{
+    "operationId": "AwsCredentials_CreateOrUpdate",
+    "title": "Create or update an AWS IRSA credential",
+    "parameters": {
+        "api-version": "2023-10-01-preview",
+        "planeType": "aws",
+        "planeName": "aws",
+        "credentialName": "default",
+        "Credential": {
+            "location": "us-west-2",
+            "properties": {
+                "kind": "IRSA",
+                "roleARN": "enterRoleARN",
+                "storage": {
+                    "kind": "Internal"
+                }
+            }
+        }
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                "name": "default",
+                "type": "System.AWS/credentials",
+                "location": "us-west-2",
+                "properties": {
+                    "kind": "IRSA",
+                    "roleARN": "enterRoleARN",
+                    "storage": {
+                        "kind": "Internal",
+                        "secretName": "aws-awscloud-default"
+                    }
+                }
+            }
+        },
+        "201": {
+            "body": {
+                "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                "name": "default",
+                "type": "System.AWS/credentials",
+                "location": "us-west-2",
+                "properties": {
+                    "kind": "IRSA",
+                    "roleARN": "enterRoleARN",
+                    "storage": {
+                        "kind": "Internal",
+                        "secretName": "aws-awscloud-default"
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/...3-10-01-preview/AWSCredential_Delete.json → ...w/examples/AWSCredential_IRSA_Delete.json b/...3-10-01-preview/AWSCredential_Delete.json → ...w/examples/AWSCredential_IRSA_Delete.json
@@ -1,6 +1,6 @@
 {
     "operationId": "AwsCredentials_Delete",
-    "title": "Delete an AWS credential",
+    "title": "Delete an AWS IRSA credential",
     "parameters": {
         "api-version": "2023-10-01-preview",
         "planeType": "aws",

diff --git a/.../ucp/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_Get.json b/.../ucp/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_Get.json
@@ -0,0 +1,28 @@
+{
+    "operationId": "AwsCredentials_Get",
+    "title": "Get an AWS IRSA credential",
+    "parameters": {
+        "api-version": "2023-10-01-preview",
+        "planeType": "aws",
+        "planeName": "awscloud",
+        "credentialName": "default"
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                "name": "default",
+                "type": "System.AWS/credentials",
+                "location": "us-west-2",
+                "properties": {
+                    "kind": "IRSA",
+                    "roleArn": "enterRoleARN",
+                    "storage": {
+                        "kind": "Internal",
+                        "secretName": "aws-awscloud-default"
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/...ucp/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_List.json b/...ucp/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_List.json
@@ -0,0 +1,31 @@
+{
+    "operationId": "AwsCredentials_List",
+    "title": "List AWS IRSA credentials",
+    "parameters": {
+        "api-version": "2023-10-01-preview",
+        "planeType": "aws",
+        "planeName": "awscloud"
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "value": [
+                    {
+                        "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                        "name": "default",
+                        "type": "System.AWS/credentials",
+                        "location": "us-west-2",
+                        "properties": {
+                            "kind": "IRSA",
+                            "roleArn": "enterRoleARN",
+                            "storage": {
+                                "kind": "Internal",
+                                "secretName": "aws-awscloud-default"
+                            }
+                        }
+                    }
+                ]
+            }
+        }
+    }
+}
diff --git a/...p/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_Update.json b/...p/resource-manager/UCP/preview/2023-10-01-preview/examples/AWSCredential_IRSA_Update.json
@@ -0,0 +1,54 @@
+{
+    "operationId": "AwsCredentials_Update",
+    "title": "Update an AWS IRSA credential",
+    "parameters": {
+        "api-version": "2023-10-01-preview",
+        "planeType": "aws",
+        "planeName": "aws",
+        "credentialName": "default",
+        "Credential": {
+            "location": "us-west-2",
+            "properties": {
+                "kind": "IRSA",
+                "roleArn": "enterRoleARN",
+                "storage": {
+                    "kind": "Internal"
+                }
+            }
+        }
+    },
+    "responses": {
+        "200": {
+            "body": {
+                "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                "name": "default",
+                "type": "System.AWS/credentials",
+                "location": "us-west-2",
+                "properties": {
+                    "kind": "IRSA",
+                    "roleArn": "enterRoleARN",
+                    "storage": {
+                        "kind": "Internal",
+                        "secretName": "aws-awscloud-default"
+                    }
+                }
+            }
+        },
+        "201": {
+            "body": {
+                "id": "/planes/AWS/aws/providers/System.AWS/credentials/default",
+                "name": "default",
+                "type": "System.AWS/credentials",
+                "location": "us-west-2",
+                "properties": {
+                    "kind": "AccessKey",
+                    "roleArn": "enterRoleARN",
+                    "storage": {
+                        "kind": "Internal",
+                        "secretName": "aws-awscloud-default"
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/swagger/specification/ucp/resource-manager/UCP/preview/2023-10-01-preview/openapi.json b/swagger/specification/ucp/resource-manager/UCP/preview/2023-10-01-preview/openapi.json
@@ -375,8 +375,11 @@
           }
         },
         "x-ms-examples": {
-          "List AWS credentials": {
-            "$ref": "./examples/AWSCredential_List.json"
+          "List AWS AccessKey credential": {
+            "$ref": "./examples/AWSCredential_AccessKey_List.json"
+          },
+          "List AWS IRSA credentials": {
+            "$ref": "./examples/AWSCredential_IRSA_List.json"
           }
         },
         "x-ms-pageable": {
@@ -423,8 +426,11 @@
           }
         },
         "x-ms-examples": {
-          "Get an AWS credential": {
-            "$ref": "./examples/AWSCredential_Get.json"
+          "Get an AWS AccessKey credential": {
+            "$ref": "./examples/AWSCredential_AccessKey_Get.json"
+          },
+          "Get an AWS IRSA credential": {
+            "$ref": "./examples/AWSCredential_IRSA_Get.json"
           }
         }
       },
@@ -481,8 +487,11 @@
           }
         },
         "x-ms-examples": {
-          "Create or update an AWS credential": {
-            "$ref": "./examples/AWSCredential_CreateOrUpdate.json"
+          "Create or update an AWS AccessKey credential": {
+            "$ref": "./examples/AWSCredential_AccessKey_CreateOrUpdate.json"
+          },
+          "Create or update an AWS IRSA credential": {
+            "$ref": "./examples/AWSCredential_IRSA_CreateOrUpdate.json"
           }
         }
       },
@@ -533,8 +542,11 @@
           }
         },
         "x-ms-examples": {
-          "Update an AWS credential": {
-            "$ref": "./examples/AWSCredential_Update.json"
+          "Update an AWS AccessKey credential": {
+            "$ref": "./examples/AWSCredential_AccessKey_Update.json"
+          },
+          "Update an AWS IRSA credential": {
+            "$ref": "./examples/AWSCredential_IRSA_Update.json"
           }
         }
       },
@@ -576,8 +588,11 @@
           }
         },
         "x-ms-examples": {
-          "Delete an AWS credential": {
-            "$ref": "./examples/AWSCredential_Delete.json"
+          "Delete an AWS AccessKey credential": {
+            "$ref": "./examples/AWSCredential_AccessKey_Delete.json"
+          },
+          "Delete an AWS IRSA credential": {
+            "$ref": "./examples/AWSCredential_IRSA_Delete.json"
           }
         }
       }
@@ -1664,14 +1679,14 @@
           {
             "name": "IRSA",
             "value": "IRSA",
-            "description": "The AWS IRSA credential"
+            "description": "AWS IAM roles for service accounts. For more information, please see: https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"
           }
         ]
       }
     },
     "AwsAccessKeyCredentialProperties": {
       "type": "object",
-      "description": "AWS credential storage properties",
+      "description": "AWS credential properties for Access Key",
       "properties": {
         "accessKeyId": {
           "type": "string",
@@ -1780,7 +1795,7 @@
     },
     "AwsIRSACredentialProperties": {
       "type": "object",
-      "description": "AWS credential storage properties",
+      "description": "AWS credential properties for IAM Roles for Service Accounts (IRSA)",
       "properties": {
         "roleARN": {
           "type": "string",

diff --git a/typespec/UCP/aws-credentials.tsp b/typespec/UCP/aws-credentials.tsp
@@ -64,7 +64,7 @@ enum AWSCredentialKind {
   @doc("The AWS Access Key credential")
   AccessKey,
 
-  @doc("The AWS IRSA credential")
+  @doc("AWS IAM roles for service accounts. For more information, please see: https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html")
   IRSA,
 }
 
@@ -79,7 +79,7 @@ model AwsCredentialProperties {
   provisioningState?: ProvisioningState;
 }
 
-@doc("AWS credential storage properties")
+@doc("AWS credential properties for Access Key")
 model AwsAccessKeyCredentialProperties extends AwsCredentialProperties {
   @doc("Access Key kind")
   kind: AWSCredentialKind.AccessKey;
@@ -96,7 +96,7 @@ model AwsAccessKeyCredentialProperties extends AwsCredentialProperties {
   storage: CredentialStorageProperties;
 }
 
-@doc("AWS credential storage properties")
+@doc("AWS credential properties for IAM Roles for Service Accounts (IRSA)")
 model AwsIRSACredentialProperties extends AwsCredentialProperties {
   @doc("IRSA credential kind")
   kind: AWSCredentialKind.IRSA;