@azure-tools/typespec-azure-core 0.71.0-dev.4 → 0.71.0-dev.5

package/lib/auth.tsp

@@ -19,9 +19,16 @@ namespace Azure.Core;
  */
 model AadTokenAuthFlow<Scopes extends string[], AuthUrl extends string, TokenUrl extends string>
   extends TypeSpec.Http.AuthorizationCodeFlow {
+  /** The OAuth2 flow type, always the authorization code flow. */
   type: OAuth2FlowType.authorizationCode;
+
+  /** The authorization URL used to obtain an authorization code. */
   authorizationUrl: AuthUrl;
+
+  /** The token URL used to exchange the authorization code for a token. */
   tokenUrl: TokenUrl;
+
+  /** The list of scopes the token applies to. */
   scopes: Scopes;
 }
 

package/lib/foundations.tsp

@@ -80,7 +80,7 @@ alias ResourceCreatedOrOkResponse<Resource extends TypeSpec.Reflection.Model> =
 
 /**
  * Response describing the location of a created resource.
- * @template T The type of the created resource.
+ * @template Resource The type of the created resource.
  */
 model LocationOfCreatedResourceResponse<Resource extends TypeSpec.Reflection.Model>
   is TypeSpec.Http.CreatedResponse {
@@ -91,7 +91,7 @@ model LocationOfCreatedResourceResponse<Resource extends TypeSpec.Reflection.Mod
 
 /**
  * Response describing the location of a resource created with a service-provided name.
- * @template T The type of the created resource.
+ * @template Resource The type of the created resource.
  */
 model LocationOfCreatedResourceWithServiceProvidedNameResponse<Resource extends TypeSpec.Reflection.Model>
   is TypeSpec.Http.AcceptedResponse {

package/lib/legacy.tsp

@@ -18,6 +18,8 @@ namespace Azure.Core.Legacy;
  *   @nextLink nextLink: Azure.Core.Legacy.parameterizedNextLink<[ListCertificateOptions.includePending]>;
  * }
  * ```
+ *
+ * @template ParameterizedParams The model properties whose values must be reapplied to the next link.
  */
 @Azure.Core.Foundations.Private.parameterizedNextLinkConfig(ParameterizedParams)
 scalar parameterizedNextLink<ParameterizedParams extends TypeSpec.Reflection.ModelProperty[]>

package/lib/models.tsp

@@ -38,11 +38,12 @@ model RequestParameter<Name extends valueof string> {}
 model ResponseProperty<Name extends valueof string> {}
 
 /**
- * @dev Provides the status of a resource operation.
+ * Provides the status of a resource operation.
  * @template Resource The resource type.
  * @template StatusResult Model describing the status result object. If not specified, the default is the resource type.
  * @template StatusError Model describing the status error object. If not specified, the default is the Foundations.Error.
  */
+@doc("Provides status details for long running operations.")
 @resource("operations")
 @parentResource(Resource)
 model ResourceOperationStatus<
@@ -383,6 +384,7 @@ scalar armResourceIdentifier<AllowedResourceTypes extends ArmResourceIdentifierA
   extends string;
 
 // Consider replacing `*`
+/** The deployment scopes in which an Azure Resource Manager resource identifier may be used. */
 union ArmResourceDeploymentScope {
   "Tenant",
   "Subscription",
@@ -401,6 +403,7 @@ alias AllArmResourceDeploymentScopes = [
   "Extension"
 ];
 
+/** Describes a resource type, and the scopes it applies to, that an `armResourceIdentifier` is allowed to refer to. */
 model ArmResourceIdentifierAllowedResource {
   /** The type of resource that is being referred to. For example Microsoft.Network/virtualNetworks or Microsoft.Network/virtualNetworks/subnets. See Example Types for more examples. */
   type: armResourceType;

package/lib/traits.tsp

@@ -62,6 +62,7 @@ model TraitOverride<Trait extends Model> {}
 @trait
 @Private.ensureAllQueryParams(Parameters)
 model QueryParametersTrait<Parameters extends Model, Contexts = unknown> {
+  /** The query parameters contributed by this trait. */
   @traitContext(Contexts)
   queryParams: {
     @traitLocation(TraitLocation.Parameters)
@@ -87,6 +88,7 @@ model ListQueryParametersTrait<Parameters extends Model> is QueryParametersTrait
 @trait
 @Private.ensureAllHeaderParams(Headers)
 model RequestHeadersTrait<Headers extends Model, Contexts = unknown> {
+  /** The request headers contributed by this trait. */
   @traitContext(Contexts)
   requestHeaders: {
     @traitLocation(TraitLocation.Parameters)
@@ -102,6 +104,7 @@ model RequestHeadersTrait<Headers extends Model, Contexts = unknown> {
 @trait
 @Private.ensureAllHeaderParams(Headers)
 model ResponseHeadersTrait<Headers extends Model, Contexts = unknown> {
+  /** The response headers contributed by this trait. */
   @traitContext(Contexts)
   responseHeaders: {
     @traitLocation(TraitLocation.Response)
@@ -115,6 +118,7 @@ model ResponseHeadersTrait<Headers extends Model, Contexts = unknown> {
  */
 @trait("VersionParameter")
 model VersionParameterTrait<VersionParameter> {
+  /** The API version parameter contributed by this trait. */
   versionParameter: {
     @traitLocation(TraitLocation.ApiVersionParameter)
     apiVersionParam: VersionParameter;
@@ -129,6 +133,7 @@ model VersionParameterTrait<VersionParameter> {
 @trait("ClientRequestId")
 @traitAdded(VersionAdded)
 model SupportsClientRequestId<VersionAdded extends EnumMember | null = null> {
+  /** The client request id headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   clientRequestId: {
     @traitLocation(TraitLocation.Parameters)
@@ -144,6 +149,7 @@ model SupportsClientRequestId<VersionAdded extends EnumMember | null = null> {
  */
 @trait("ClientRequestId")
 model NoClientRequestId {
+  /** Empty, indicating that client request id headers are not supported. */
   clientRequestId: {};
 }
 
@@ -155,6 +161,7 @@ model NoClientRequestId {
 @trait("ConditionalRequests")
 @traitAdded(VersionAdded)
 model SupportsConditionalRequests<VersionAdded extends EnumMember | null = null> {
+  /** The conditional request headers and ETag headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   conditionalRequests: {
     @traitContext(
@@ -174,6 +181,7 @@ model SupportsConditionalRequests<VersionAdded extends EnumMember | null = null>
  */
 @trait("ConditionalRequests")
 model NoConditionalRequests {
+  /** Empty, indicating that conditional requests are not supported. */
   conditionalRequests: {};
 }
 
@@ -185,6 +193,7 @@ model NoConditionalRequests {
 @trait("RepeatableRequests")
 @traitAdded(VersionAdded)
 model SupportsRepeatableRequests<VersionAdded extends EnumMember | null = null> {
+  /** The repeatable request headers contributed by this trait. */
   #suppress "@azure-tools/typespec-providerhub/no-inline-model" "This inline model is never used directly in operations."
   @traitContext(
     TraitContext.Create | TraitContext.Update | TraitContext.Delete | TraitContext.Action
@@ -203,6 +212,7 @@ model SupportsRepeatableRequests<VersionAdded extends EnumMember | null = null>
  */
 @trait("RepeatableRequests")
 model NoRepeatableRequests {
+  /** Empty, indicating that repeatable requests are not supported. */
   repeatableRequests: {};
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-tools/typespec-azure-core",
-  "version": "0.71.0-dev.4",
+  "version": "0.71.0-dev.5",
   "author": "Microsoft Corporation",
   "description": "TypeSpec Azure Core library",
   "homepage": "https://azure.github.io/typespec-azure",
@@ -59,11 +59,11 @@
     "typescript": "~6.0.2",
     "vitest": "^4.1.3",
     "@typespec/compiler": "^1.14.0",
-    "@typespec/http": "^1.14.0",
-    "@typespec/openapi": "^1.14.0",
     "@typespec/library-linter": "^0.84.0",
-    "@typespec/tspd": "^0.76.0",
+    "@typespec/openapi": "^1.14.0",
+    "@typespec/http": "^1.14.0",
     "@typespec/rest": "^0.84.0",
+    "@typespec/tspd": "^0.76.0",
     "@typespec/versioning": "^0.84.0"
   },
   "scripts": {