Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve generated description from xml docs #1473

Merged
merged 8 commits into from
Dec 27, 2023
Merged

Improve generated description from xml docs #1473

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7ca28b9
Trim Property or Type namespace from summaries when generating descri…
kiapanahi Dec 20, 2023
57105e8
Rename method and regex capture group from namespace to member type
kiapanahi Dec 21, 2023
a21f36a
Update XmlDocument member type regex and corresponding tests#
kiapanahi Dec 22, 2023
6754c5d
Cache and reuse JsonSerializerOptions instead of new-ing up every time.
kiapanahi Dec 22, 2023
7bf02b6
Regenerate ConfigurationSchema.json files after the generator changes
kiapanahi Dec 22, 2023
cf2b012
Merge remote-tracking branch 'upstream/main' into issue_1428/improve-…
kiapanahi Dec 24, 2023
2bd9b06
Fix typo
kiapanahi Dec 24, 2023
c95eab0
Move config schema generation xml node formatting logic from using Re…
kiapanahi Dec 24, 2023
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
8 changes: 4 additions & 4 deletions src/Components/Aspire.Azure.Data.Tables/ConfigurationSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@
"properties": {
"ApplicationId": {
"type": "string",
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to P:Azure.Core.DiagnosticsOptions.DefaultApplicationId."
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to 'Azure.Core.DiagnosticsOptions.DefaultApplicationId'."
},
"DefaultApplicationId": {
"type": "string",
"description": "Gets or sets the default application id. Default application id would be set on all instances."
},
"IsDistributedTracingEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether distributed tracing activities ( T:System.Diagnostics.Activity ) are going to be created for the clients methods calls and HTTP calls."
"description": "Gets or sets value indicating whether distributed tracing activities ( 'System.Diagnostics.Activity' ) are going to be created for the clients methods calls and HTTP calls."
},
"IsLoggingContentEnabled": {
"type": "boolean",
Expand All @@ -55,7 +55,7 @@
},
"IsTelemetryEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing P:Azure.Core.DiagnosticsOptions.ApplicationId , client library package name and version, P:System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription and P:System.Runtime.InteropServices.RuntimeInformation.OSDescription should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing 'Azure.Core.DiagnosticsOptions.ApplicationId' , client library package name and version, 'System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription' and 'System.Runtime.InteropServices.RuntimeInformation.OSDescription' should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
},
"LoggedContentSizeLimit": {
"type": "integer",
Expand Down Expand Up @@ -115,7 +115,7 @@
"ServiceUri": {
"type": "string",
"format": "uri",
"description": "A T:System.Uri referencing the table service account.\nThis is likely to be similar to \"https://{account_name}.table.core.windows.net/\" or \"https://{account_name}.table.cosmos.azure.com/\"."
"description": "A 'System.Uri' referencing the table service account.\nThis is likely to be similar to \"https://{account_name}.table.core.windows.net/\" or \"https://{account_name}.table.cosmos.azure.com/\"."
},
"Tracing": {
"type": "boolean",
Expand Down
4 changes: 2 additions & 2 deletions src/Components/Aspire.Azure.Messaging.ServiceBus/ConfigurationSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
},
"Identifier": {
"type": "string",
"description": "A property used to set the T:Azure.Messaging.ServiceBus.ServiceBusClient ID to identify the client. This can be used to correlate logs\nand exceptions. If null or empty, a random unique value will be used."
"description": "A property used to set the 'Azure.Messaging.ServiceBus.ServiceBusClient' ID to identify the client. This can be used to correlate logs\nand exceptions. If null or empty, a random unique value will be used."
},
"RetryOptions": {
"type": "object",
Expand Down Expand Up @@ -91,7 +91,7 @@
"description": "The type of protocol and transport that will be used for communicating with the Service Bus\nservice."
}
},
"description": "The set of options that can be specified when creating an T:Azure.Messaging.ServiceBus.ServiceBusConnection to configure its behavior."
"description": "The set of options that can be specified when creating an 'Azure.Messaging.ServiceBus.ServiceBusConnection' to configure its behavior."
},
"ConnectionString": {
"type": "string",
Expand Down
8 changes: 4 additions & 4 deletions src/Components/Aspire.Azure.Security.KeyVault/ConfigurationSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@
"properties": {
"ApplicationId": {
"type": "string",
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to P:Azure.Core.DiagnosticsOptions.DefaultApplicationId."
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to 'Azure.Core.DiagnosticsOptions.DefaultApplicationId'."
},
"DefaultApplicationId": {
"type": "string",
"description": "Gets or sets the default application id. Default application id would be set on all instances."
},
"IsDistributedTracingEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether distributed tracing activities ( T:System.Diagnostics.Activity ) are going to be created for the clients methods calls and HTTP calls."
"description": "Gets or sets value indicating whether distributed tracing activities ( 'System.Diagnostics.Activity' ) are going to be created for the clients methods calls and HTTP calls."
},
"IsLoggingContentEnabled": {
"type": "boolean",
Expand All @@ -55,7 +55,7 @@
},
"IsTelemetryEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing P:Azure.Core.DiagnosticsOptions.ApplicationId , client library package name and version, P:System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription and P:System.Runtime.InteropServices.RuntimeInformation.OSDescription should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing 'Azure.Core.DiagnosticsOptions.ApplicationId' , client library package name and version, 'System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription' and 'System.Runtime.InteropServices.RuntimeInformation.OSDescription' should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
},
"LoggedContentSizeLimit": {
"type": "integer",
Expand Down Expand Up @@ -116,7 +116,7 @@
"VaultUri": {
"type": "string",
"format": "uri",
"description": "A T:System.Uri to the vault on which the client operates. Appears as \"DNS Name\" in the Azure portal.\nIf you have a secret T:System.Uri , use T:Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier to parse the P:Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier.VaultUri and other information.\nYou should validate that this URI references a valid Key Vault resource. See https://aka.ms/azsdk/blog/vault-uri for details."
"description": "A 'System.Uri' to the vault on which the client operates. Appears as \"DNS Name\" in the Azure portal.\nIf you have a secret 'System.Uri' , use 'Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier' to parse the 'Azure.Security.KeyVault.Secrets.KeyVaultSecretIdentifier.VaultUri' and other information.\nYou should validate that this URI references a valid Key Vault resource. See https://aka.ms/azsdk/blog/vault-uri for details."
}
},
"description": "Provides the client configuration settings for connecting to Azure Key Vault."
Expand Down
16 changes: 8 additions & 8 deletions src/Components/Aspire.Azure.Storage.Blobs/ConfigurationSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@
"properties": {
"ApplicationId": {
"type": "string",
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to P:Azure.Core.DiagnosticsOptions.DefaultApplicationId."
"description": "Gets or sets the value sent as the first part of \"User-Agent\" headers for all requests issues by this client. Defaults to 'Azure.Core.DiagnosticsOptions.DefaultApplicationId'."
},
"DefaultApplicationId": {
"type": "string",
"description": "Gets or sets the default application id. Default application id would be set on all instances."
},
"IsDistributedTracingEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether distributed tracing activities ( T:System.Diagnostics.Activity ) are going to be created for the clients methods calls and HTTP calls."
"description": "Gets or sets value indicating whether distributed tracing activities ( 'System.Diagnostics.Activity' ) are going to be created for the clients methods calls and HTTP calls."
},
"IsLoggingContentEnabled": {
"type": "boolean",
Expand All @@ -55,7 +55,7 @@
},
"IsTelemetryEnabled": {
"type": "boolean",
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing P:Azure.Core.DiagnosticsOptions.ApplicationId , client library package name and version, P:System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription and P:System.Runtime.InteropServices.RuntimeInformation.OSDescription should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
"description": "Gets or sets value indicating whether the \"User-Agent\" header containing 'Azure.Core.DiagnosticsOptions.ApplicationId' , client library package name and version, 'System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription' and 'System.Runtime.InteropServices.RuntimeInformation.OSDescription' should be sent.\nThe default value can be controlled process wide by setting AZURE_TELEMETRY_DISABLED to true , false , 1 or 0."
},
"LoggedContentSizeLimit": {
"type": "integer",
Expand All @@ -70,12 +70,12 @@
},
"EncryptionScope": {
"type": "string",
"description": "Gets the P:Azure.Storage.Blobs.BlobClientOptions.EncryptionScope to be used when making requests."
"description": "Gets the 'Azure.Storage.Blobs.BlobClientOptions.EncryptionScope' to be used when making requests."
},
"GeoRedundantSecondaryUri": {
"type": "string",
"format": "uri",
"description": "Gets or sets the secondary storage T:System.Uri that can be read from for the storage account if the\naccount is enabled for RA-GRS.\n\nIf this property is set, the secondary Uri will be used for GET or HEAD requests during retries.\nIf the status of the response from the secondary Uri is a 404, then subsequent retries for\nthe request will not use the secondary Uri again, as this indicates that the resource\nmay not have propagated there yet. Otherwise, subsequent retries will alternate back and forth\nbetween primary and secondary Uri."
"description": "Gets or sets the secondary storage 'System.Uri' that can be read from for the storage account if the\naccount is enabled for RA-GRS.\n\nIf this property is set, the secondary Uri will be used for GET or HEAD requests during retries.\nIf the status of the response from the secondary Uri is a 404, then subsequent retries for\nthe request will not use the secondary Uri again, as this indicates that the resource\nmay not have propagated there yet. Otherwise, subsequent retries will alternate back and forth\nbetween primary and secondary Uri."
},
"Retry": {
"type": "object",
Expand Down Expand Up @@ -117,7 +117,7 @@
"properties": {
"AutoValidateChecksum": {
"type": "boolean",
"description": "Defaults to true. False can only be specified on specific operations and not at the client level.\nIndicates whether the SDK should validate the content\nbody against the content hash before returning contents to the caller.\nIf set to false, caller is responsible for extracting the hash out\nof the T:Azure.Response`1 and validating the hash themselves."
"description": "Defaults to true. False can only be specified on specific operations and not at the client level.\nIndicates whether the SDK should validate the content\nbody against the content hash before returning contents to the caller.\nIf set to false, caller is responsible for extracting the hash out\nof the 'Azure.Response`1' and validating the hash themselves."
},
"ChecksumAlgorithm": {
"enum": [
Expand Down Expand Up @@ -151,7 +151,7 @@
},
"TrimBlobNameSlashes": {
"type": "boolean",
"description": "Whether to trim leading and trailing slashes on a blob name when using M:Azure.Storage.Blobs.BlobContainerClient.GetBlobClient(System.String) and similar methods.\nDefaults to true for backwards compatibility."
"description": "Whether to trim leading and trailing slashes on a blob name when using 'Azure.Storage.Blobs.BlobContainerClient.GetBlobClient(System.String)' and similar methods.\nDefaults to true for backwards compatibility."
}
},
"description": "Provides the client configuration options for connecting to Azure Blob\nStorage."
Expand All @@ -168,7 +168,7 @@
"ServiceUri": {
"type": "string",
"format": "uri",
"description": "A T:System.Uri referencing the blob service.\nThis is likely to be similar to \"https://{account_name}.blob.core.windows.net\"."
"description": "A 'System.Uri' referencing the blob service.\nThis is likely to be similar to \"https://{account_name}.blob.core.windows.net\"."
},
"Tracing": {
"type": "boolean",
Expand Down
Loading