- adds display url to the CLI experience

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added support for multipart form data request body in PHP. [#3029](https://github.com/microsoft/kiota/issues/3029)
 - Added uri-form encoded serialization for PHP. [#2074](https://github.com/microsoft/kiota/issues/2074)
+- Added information message with base URL in the CLI experience. [#4635](https://github.com/microsoft/kiota/issues/4635)
 
 ### Changed
 

src/Kiota.Builder/KiotaBuilder.cs

@@ -397,7 +397,10 @@
     internal void SetApiRootUrl()
     {
         if (openApiDocument is not null && openApiDocument.GetAPIRootUrl(config.OpenAPIFilePath) is string candidateUrl)
+        {
             config.ApiRootUrl = candidateUrl;
+            logger.LogInformation("Client root URL set to {ApiRootUrl}", candidateUrl);
+        }
         else
             logger.LogWarning("No server url found in the OpenAPI document. The base url will need to be set when using the client.");
     }
@@ -656,7 +659,7 @@
         methodToAdd.AddParameter(new CodeParameter
         {
             Name = "rawUrl",
             Type = new CodeType { Name = "string", IsExternal = true },
             Optional = false,
             Documentation = new()
             {
@@ -770,7 +773,7 @@
             IsAsync = false,
             IsStatic = false,
             Documentation = new(new() {
                                 {"TypeName", new CodeType {
                                     IsExternal = false,
                                     TypeDefinition = currentClass,
                                 }
@@ -1012,7 +1015,7 @@
 
         if (!"string".Equals(parameter.Type.Name, StringComparison.OrdinalIgnoreCase) && config.IncludeBackwardCompatible)
         { // adding a second indexer for the string version of the parameter so we keep backward compatibility
             //TODO remove for v2
             var backCompatibleValue = (CodeIndexer)result[0].Clone();
             backCompatibleValue.Name += "-string";
             backCompatibleValue.IndexParameter.Type = DefaultIndexerParameterType;
@@ -1086,15 +1089,15 @@
             var primitiveTypeName = (typeName?.ToLowerInvariant(), format?.ToLowerInvariant()) switch
             {
                 ("string", "base64url") => "base64url",
                 ("file", _) => "binary",
                 ("string", "duration") => "TimeSpan",
                 ("string", "time") => "TimeOnly",
                 ("string", "date") => "DateOnly",
                 ("string", "date-time") => "DateTimeOffset",
                 ("string", "uuid") => "Guid",
                 ("string", _) => "string", // covers commonmark and html
                 ("number", "double" or "float" or "decimal") => format.ToLowerInvariant(),
                 ("number" or "integer", "int8") => "sbyte",
                 ("number" or "integer", "uint8") => "byte",
                 ("number" or "integer", "int64") => "int64",
                 ("number", "int32") => "integer",
@@ -1166,7 +1169,7 @@
             var suffix = $"{operationType}Response";
             var modelType = CreateModelDeclarations(currentNode, schema, operation, parentClass, suffix);
             if (modelType is not null && config.IncludeBackwardCompatible && config.Language is GenerationLanguage.CSharp or GenerationLanguage.Go && modelType.Name.EndsWith(suffix, StringComparison.Ordinal))
             { //TODO remove for v2
                 var obsoleteTypeName = modelType.Name[..^suffix.Length] + "Response";
                 if (modelType is CodeType codeType &&
                     codeType.TypeDefinition is CodeClass codeClass)
@@ -1299,7 +1302,7 @@
             executorMethod.AddParameter(cancellationParam);// Add cancellation token parameter
 
             if (returnTypes.Item2 is not null && config.IncludeBackwardCompatible)
             { //TODO remove for v2
                 var additionalExecutorMethod = (CodeMethod)executorMethod.Clone();
                 additionalExecutorMethod.ReturnType = returnTypes.Item2;
                 additionalExecutorMethod.OriginalMethod = executorMethod;
@@ -2309,7 +2312,7 @@
         if (!parameterClass.ContainsPropertyWithWireName(prop.WireName))
         {
             if (addBackwardCompatibleParameter && config.IncludeBackwardCompatible && config.Language is GenerationLanguage.CSharp or GenerationLanguage.Go)
             { //TODO remove for v2
                 var modernProp = (CodeProperty)prop.Clone();
                 modernProp.Name = $"{prop.Name}As{modernProp.Type.Name.ToFirstCharacterUpperCase()}";
                 modernProp.SerializationName = prop.WireName;

src/kiota/Handlers/BaseKiotaCommandHandler.cs

@@ -287,6 +287,11 @@ private static string GetSourceArg(string path, string manifest)
     {
         return string.IsNullOrEmpty(manifest) ? $"-d \"{path}\"" : $"-a \"{manifest}\"";
     }
+    protected void DisplayUrlInformation(string? apiRootUrl, bool isPlugin = false)
+    {
+        if (!string.IsNullOrEmpty(apiRootUrl))
+            DisplayInfo($"{(isPlugin ? "Plugin" : "Client")} base url set to {apiRootUrl}");
+    }
     protected void DisplayGenerateCommandHint()
     {
         DisplayHint("Hint: use the client generate command to generate the code.",

src/kiota/Handlers/Client/AddHandler.cs

@@ -121,7 +121,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var builder = new KiotaBuilder(logger, Configuration.Generation, httpClient, true);
                 var result = await builder.GenerateClientAsync(cancellationToken).ConfigureAwait(false);
                 if (result)
+                {
                     DisplaySuccess("Generation completed successfully");
+                    DisplayUrlInformation(Configuration.Generation.ApiRootUrl);
+                }
                 else if (skipGeneration)
                 {
                     DisplaySuccess("Generation skipped as --skip-generation was passed");

src/kiota/Handlers/Client/EditHandler.cs

@@ -136,7 +136,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var builder = new KiotaBuilder(logger, Configuration.Generation, httpClient, true);
                 var result = await builder.GenerateClientAsync(cancellationToken).ConfigureAwait(false);
                 if (result)
+                {
                     DisplaySuccess("Generation completed successfully");
+                    DisplayUrlInformation(Configuration.Generation.ApiRootUrl);
+                }
                 else if (skipGeneration)
                 {
                     DisplaySuccess("Generation skipped as --skip-generation was passed");

src/kiota/Handlers/Client/GenerateHandler.cs

@@ -62,6 +62,7 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                     if (result)
                     {
                         DisplaySuccess($"Update of {clientEntry.Key} client completed");
+                        DisplayUrlInformation(generationConfiguration.ApiRootUrl);
                         var manifestPath = $"{GetAbsolutePath(Path.Combine(WorkspaceConfigurationStorageService.KiotaDirectorySegment, WorkspaceConfigurationStorageService.ManifestFileName))}#{clientEntry.Key}";
                         DisplayInfoHint(generationConfiguration.Language, string.Empty, manifestPath);
                     }

src/kiota/Handlers/KiotaGenerateCommandHandler.cs

@@ -125,7 +125,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var builder = new KiotaBuilder(logger, Configuration.Generation, httpClient);
                 var result = await builder.GenerateClientAsync(cancellationToken).ConfigureAwait(false);
                 if (result)
+                {
                     DisplaySuccess("Generation completed successfully");
+                    DisplayUrlInformation(Configuration.Generation.ApiRootUrl);
+                }
                 else
                 {
                     DisplaySuccess("Generation skipped as no changes were detected");

src/kiota/Handlers/KiotaUpdateCommandHandler.cs

@@ -62,7 +62,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var results = await Task.WhenAll(configurations
                                                 .Select(x => GenerateClientAsync(context, x, cancellationToken)));
                 foreach (var (lockInfo, lockDirectoryPath) in locks)
+                {
                     DisplaySuccess($"Update of {lockInfo?.ClientClassName} client for {lockInfo?.Language} at {lockDirectoryPath} completed");
+                    DisplayUrlInformation(configurations.FirstOrDefault(x => lockDirectoryPath.Equals(x.OutputPath, StringComparison.OrdinalIgnoreCase))?.ApiRootUrl);
+                }
                 DisplaySuccess($"Update of {locks.Length} clients completed successfully");
                 foreach (var configuration in configurations)
                     DisplayInfoHint(configuration.Language, configuration.OpenAPIFilePath, string.Empty);

src/kiota/Handlers/Plugin/AddHandler.cs

@@ -73,7 +73,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var builder = new KiotaBuilder(logger, Configuration.Generation, httpClient, true);
                 var result = await builder.GeneratePluginAsync(cancellationToken).ConfigureAwait(false);
                 if (result)
+                {
                     DisplaySuccess("Generation completed successfully");
+                    DisplayUrlInformation(Configuration.Generation.ApiRootUrl);
+                }
                 else if (skipGeneration)
                 {
                     DisplaySuccess("Generation skipped as --skip-generation was passed");

src/kiota/Handlers/Plugin/EditHandler.cs

@@ -90,7 +90,10 @@ public override async Task<int> InvokeAsync(InvocationContext context)
                 var builder = new KiotaBuilder(logger, Configuration.Generation, httpClient, true);
                 var result = await builder.GeneratePluginAsync(cancellationToken).ConfigureAwait(false);
                 if (result)
+                {
                     DisplaySuccess("Generation completed successfully");
+                    DisplayUrlInformation(Configuration.Generation.ApiRootUrl);
+                }
                 else if (skipGeneration)
                 {
                     DisplaySuccess("Generation skipped as --skip-generation was passed");