Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
using Microsoft.TypeSpec.Generator.Statements;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using static Microsoft.TypeSpec.Generator.Snippets.Snippet;

Expand Down Expand Up @@ -83,7 +84,7 @@ public ResourceOperationMethodProvider(
ref _isFakeLongRunningOperation);
IsLongRunningOperation = isLongRunningOperation;
_methodName = methodName ?? _convenienceMethod.Signature.Name;
_description = description ?? _convenienceMethod.Signature.Description;
_description = description ?? BuildEnhancedDescription(_serviceMethod, _convenienceMethod.Signature.Description, enclosingType);
InitializeTypeInfo(
_serviceMethod,
ref _originalBodyType,
Expand All @@ -95,6 +96,52 @@ public ResourceOperationMethodProvider(
_bodyStatements = BuildBodyStatements();
}

/// <summary>
/// Builds enhanced XML documentation description with operation metadata.
/// </summary>
private static FormattableString? BuildEnhancedDescription(InputServiceMethod serviceMethod, FormattableString? baseDescription, TypeProvider enclosingType)
{
var operation = serviceMethod.Operation;

// Find API version parameter if it exists
var apiVersionParam = operation.Parameters.FirstOrDefault(p => p.IsApiVersion);
var apiVersionItem = apiVersionParam != null && apiVersionParam.DefaultValue?.Value != null
? $@"
<item>
<term>Default Api Version</term>
<description>{apiVersionParam.DefaultValue.Value}</description>
</item>"
: "";

// Build resource item if the enclosing type is a ResourceClientProvider
var resourceItem = enclosingType is ResourceClientProvider resourceClient
? $@"
<item>
<term>Resource</term>
<description>{resourceClient.Type:C}</description>
</item>"
: "";

// Combine all items into a single formattable string
FormattableString metadataList = (FormattableString)$@"<list type=""bullet"">
<item>
<term>Request Path</term>
<description>{operation.Path}</description>
</item>
<item>
<term>Operation Id</term>
<description>{operation.Name}</description>
</item>{apiVersionItem}{resourceItem}
</list>";

// Combine base description with metadata
if (baseDescription != null)
{
return (FormattableString)$"{baseDescription}{Environment.NewLine}{metadataList}";
}
return metadataList;
}

private static void InitializeLroFlags(
in InputServiceMethod serviceMethod,
in bool forceLro,
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading