diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 0cbc77fc4..232742bf1 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -90,6 +90,7 @@ NodeJS OAuth OCI OIDC +OpenAPI OUTRESOURCE OUTVALUES PARAMS @@ -103,6 +104,8 @@ RBAC RabbitMQ ResourceDeploymentClient resourceGroup +ResourceType +resourceTypeName Rollout SaaS SDKs @@ -122,6 +125,7 @@ Swappable TBD TCP Terraform +testResources TLS ToCs UCP diff --git a/docs/content/reference/cli/rad_resource-type.md b/docs/content/reference/cli/rad_resource-type.md index 8689e7ba7..d2ec2bf92 100644 --- a/docs/content/reference/cli/rad_resource-type.md +++ b/docs/content/reference/cli/rad_resource-type.md @@ -32,7 +32,7 @@ Manage resource types * [rad]({{< ref rad.md >}}) - Radius CLI * [rad resource-type create]({{< ref rad_resource-type_create.md >}}) - Create or update a resource type -* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource type +* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete a resource type * [rad resource-type list]({{< ref rad_resource-type_list.md >}}) - List resource resource types * [rad resource-type show]({{< ref rad_resource-type_show.md >}}) - Show resource resource type diff --git a/docs/content/reference/cli/rad_resource-type_create.md b/docs/content/reference/cli/rad_resource-type_create.md index a7c51a0fc..f9c421b77 100644 --- a/docs/content/reference/cli/rad_resource-type_create.md +++ b/docs/content/reference/cli/rad_resource-type_create.md @@ -12,36 +12,35 @@ Create or update a resource type ### Synopsis -Create or update a resource type from a resource type manifest. - - Resource types are user defined types such as 'Mycompany.Messaging/plaid'. - - Creating a resource type defines a new type that can be used in applications. - - Input can be passed in using a JSON or YAML file using the --from-file option. - - resource-type name argument is optional. If specified, only the specified type is created/updated. - If not specified, all resource types in the referenced file are created/updated. - +Create or update a resource type from a resource type definition file. + +Resource types define the resources that Radius can deploy and the API for those resources. They are defined by a name, one or more API versions, and an OpenAPI schema. + +Input can be passed in using a JSON or YAML file using the --from-file option. + +The resource type name argument is optional. If specified, only the specified type is created/updated. If not specified, all resource types in the referenced file are created/updated. + +The resource type name argument is the simple name (e.g., 'testResources') not the fully qualified name. + ``` -rad resource-type create [input] [flags] +rad resource-type create [resource-type-name] [flags] ``` ### Examples ``` -# Create a resource type from YAML file +# Create a specific resource type from a YAML file rad resource-type create myType --from-file /path/to/input.yaml -# Create a resource type from JSON file +# Create a specific resource type from a JSON file rad resource-type create myType --from-file /path/to/input.json -# Create all resource types from YAML file -rad resource-type create --from-file /path/to/input.yaml +# Create all resource types from a YAML file +rad resource-type create --from-file /path/to/input.yaml -# Create all resource types from JSON file +# Create all resource types from a JSON file rad resource-type create --from-file /path/to/input.json ``` diff --git a/docs/content/reference/cli/rad_resource-type_delete.md b/docs/content/reference/cli/rad_resource-type_delete.md index 1a936c755..424576207 100644 --- a/docs/content/reference/cli/rad_resource-type_delete.md +++ b/docs/content/reference/cli/rad_resource-type_delete.md @@ -8,26 +8,27 @@ description: "Details on the rad resource-type delete Radius CLI command" --- ## rad resource-type delete -Delete resource type +Delete a resource type ### Synopsis -Delete resource type - -Resource types are the entities that implement resource types such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource providers can be created and deleted by users. +Delete a resource type + +Deleting a resource type will delete the specified resource type. For example, deleting 'Applications.Core/containers' will delete that type (but not deployed instances of the type). + +The resource type name argument must be a fully qualified resource type name in the format 'ResourceType.Namespace/resourceTypeName' (e.g., 'Radius.Compute/containers'). -Deleting a resource type will delete all resources of the specified resource type. For example, deleting 'Applications.Core/containers' will delete all containers. ``` -rad resource-type delete [resource type] [flags] +rad resource-type delete [resource-type-name] [flags] ``` ### Examples ``` -# Delete a resource type -rad resource-type delete Applications.Core/containers +# Delete a resource type (fully qualified name required) +rad resource-type delete Radius.Compute/containers # Delete a resource type (bypass confirmation) rad resource-type delete Applications.Core/containers --yes