@azure-tools/typespec-azure-core 0.30.0-dev.28 → 0.30.0-dev.29

package/lib/operations.tsp

@@ -62,6 +62,11 @@ interface ResourceOperations<
   InterfaceTraits,
   TErrorResponse = Azure.Core.Foundations.ErrorResponse
 > {
+  /**
+   * Create or replace operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @createsOrReplacesResource(TResource)
   ResourceCreateOrReplace<
     TResource extends object,
@@ -84,6 +89,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource create or replace operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @createsOrReplacesResource(TResource)
   LongRunningResourceCreateOrReplace<
     TResource extends object,
@@ -107,6 +117,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Create or update operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @createsOrUpdatesResource(TResource)
   ResourceCreateOrUpdate<
     TResource extends object,
@@ -134,6 +149,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource create or update operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @createsOrUpdatesResource(TResource)
   LongRunningResourceCreateOrUpdate<
     TResource extends object,
@@ -162,6 +182,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource update operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @updatesResource(TResource)
   ResourceUpdate<
     TResource extends object,
@@ -181,6 +206,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource create with service-provided name operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This operation signature is not used in Azure Resource Manager operations (yet)"
   @createsResource(TResource)
   ResourceCreateWithServiceProvidedName<
@@ -196,6 +226,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource create with service-provided name operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This operation signature is not used in Azure Resource Manager operations (yet)"
   @createsResource(TResource)
   LongRunningResourceCreateWithServiceProvidedName<
@@ -211,6 +246,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource read operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   @readsResource(TResource)
   ResourceRead<
     TResource extends object,
@@ -224,6 +264,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource delete operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This operation signature is not used in Azure Resource Manager operations (yet)"
   @deletesResource(TResource)
   ResourceDelete<
@@ -238,6 +283,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource delete operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "We do support bodies in data plane service APIs..."
   @deletesResource(TResource)
   LongRunningResourceDelete<
@@ -253,6 +303,11 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource list operation template.
+   * @template TResource Resource type.
+   * @template Traits Object describing the traits of the operation.
+   */
   ResourceList<TResource extends object, Traits extends object = {}> is Foundations.ResourceList<
     TResource,
     TraitProperties<Traits & InterfaceTraits, TraitLocation.Parameters, TraitContext.List>,
@@ -261,6 +316,13 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource action operation template.
+   * @template TResource Resource type.
+   * @template TParams Object describing the parameters of the operation.
+   * @template TResponse Object describing the response of the operation.
+   * @template Traits Object describing the traits of the operation.
+   */
   @action
   @actionSeparator(":")
   ResourceAction<
@@ -278,6 +340,13 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource collection action operation template.
+   * @template TResource Resource type.
+   * @template TParams Object describing the parameters of the operation.
+   * @template TResponse Object describing the response of the operation.
+   * @template Traits Object describing the traits of the operation.
+   */
   @collectionAction(TResource)
   @actionSeparator(":")
   ResourceCollectionAction<
@@ -295,6 +364,14 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource action operation template.
+   * @template TResource Resource type.
+   * @template TParams Object describing the parameters of the operation.
+   * @template TStatusResult Object describing the status result of the operation.
+   * @template TStatusError Object describing the status error of the operation.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This operation signature is not used in Azure Resource Manager operations (yet)"
   #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "This operation must return a status monitor in its response."
   @action
@@ -317,6 +394,14 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Long-running resource collection action operation template.
+   * @template TResource Resource type.
+   * @template TParams Object describing the parameters of the operation.
+   * @template TStatusResult Object describing the status result of the operation.
+   * @template TStatusError Object describing the status error of the operation.
+   * @template Traits Object describing the traits of the operation.
+   */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This operation signature is not used in Azure Resource Manager operations (yet)"
   #suppress "@azure-tools/typespec-azure-resource-manager/no-response-body" "This operation must return a status monitor in its response."
   @autoRoute
@@ -340,6 +425,13 @@ interface ResourceOperations<
     TErrorResponse
   >;
 
+  /**
+   * Resource operation status operation template.
+   * @template TResource Resource type.
+   * @template TStatusResult Object describing the status result of the operation.
+   * @template TStatusError Object describing the status error of the operation.
+   * @template Traits Object describing the traits of the operation.
+   */
   @readsResource(ResourceOperationStatus<TResource>)
   @Foundations.Private.ensureResourceType(TResource)
   GetResourceOperationStatus<

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-core",
-  "version": "0.30.0-dev.28",
+  "version": "0.30.0-dev.29",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Core library",
   "homepage": "https://azure.github.io/typespec-azure",