Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Will <[email protected]>
Signed-off-by: jasonviviano <[email protected]>
  • Loading branch information
jasonviviano and willtsai authored Nov 27, 2023
1 parent bfc9285 commit 848b381
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 24 deletions.
8 changes: 4 additions & 4 deletions typespec/Applications.Core/extensions.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ model KubernetesMetadataExtension extends Extension {
@doc("The Kubernetes annotations to set on your application and its resources.")
annotations?: Record<string>;

@doc("The Kubernetes labels to be set on the application and its resources")
@doc("The Kubernetes labels to be set on the application and its resources.")
labels?: Record<string>;
}

Expand All @@ -48,7 +48,7 @@ model ManualScalingExtension extends Extension {
@doc("The kind of extension.")
kind: "manualScaling";

@doc("The number of replicas to run")
@doc("The number of replicas to run.")
replicas: int32;
}

Expand All @@ -57,13 +57,13 @@ model DaprSidecarExtension extends Extension {
@doc("The kind of extension.")
kind: "daprSidecar";

@doc("The port your service exposes to Dapr")
@doc("The port your service exposes to Dapr.")
appPort?: int32;

@doc("The appId of the Dapr sidecar.")
appId: string;

@doc("The configuration to use for the Dapr sidecar")
@doc("The configuration to use for the Dapr sidecar.")
config?: string;

@doc("Specifies the Dapr app-protocol to use for the resource.")
Expand Down
2 changes: 1 addition & 1 deletion typespec/Applications.Core/gateways.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ model GatewayRoute {
@doc("The path to match the incoming request path on. Not required when `tls.sslPassthrough` is set to `'true'`.")
path?: string;

@doc("The service to route traffic to, in the form `'[scheme]://[serviceName]:[port]'`")
@doc("The service to route traffic to, in the form `'[scheme]://[serviceName]:[port]'`.")
destination?: string;

@doc("The prefix to replace in the incoming request path that is sent to the destination route.")
Expand Down
32 changes: 16 additions & 16 deletions typespec/Applications.Core/volumes.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -53,40 +53,40 @@ model VolumeProperties {

@doc("Represents Azure Key Vault Volume properties")
model AzureKeyVaultVolumeProperties extends VolumeProperties {
@doc("The kind of persistent volume. Should be 'azure.com.keyvault' for Azure Key Vault persistent volumes")
@doc("The kind of persistent volume. Should be 'azure.com.keyvault' for Azure Key Vault persistent volumes.")
kind: "azure.com.keyvault";

@doc("Map specify certificate object name and [certificate properties]. See [certificate properties](#certificate)")
@doc("Map specify certificate object name and [certificate properties]. See [certificate properties](#certificate).")
certificates?: Record<CertificateObjectProperties>;

@doc("Map specify key object name and key properties. See [key properties](#keys)")
@doc("Map specify key object name and key properties. See [key properties](#keys).")
keys?: Record<KeyObjectProperties>;

@doc("Resource ID for the Azure KeyVault resource.")
resource: string;

@doc("Map specify secret object name and secret properties. See [secret properties](#secrets)")
@doc("Map specify secret object name and secret properties. See [secret properties](#secrets).")
secrets?: Record<SecretObjectProperties>;
}

@doc("Represents certificate object properties")
model CertificateObjectProperties {
@doc("File name when written to disk. Same as object name if not specified")
@doc("File name when written to disk. Same as object name if not specified.")
`alias`?: string;

@doc("Encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8' and this field can be specificed only when value is 'privatekey'")
@doc("Encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8' and this field can be specificed only when value is 'privatekey'.")
encoding?: VolumeSecretEncodings = VolumeSecretEncodings.utf8;

@doc("Certificate format 'pfx', 'pem'. Default is 'pfx'")
@doc("Certificate format 'pfx', 'pem'. Default is 'pfx'.")
format?: CertificateFormats = CertificateFormats.pem;

@doc("Certificate name in Azure Key Vault")
@doc("Certificate name in Azure Key Vault.")
name: string;

@doc("Certificate object type to be downloaded - the certificate itself, private key or public key of the certificate")
certType?: CertificateTypes;

@doc("Specific certificate version. Default is latest")
@doc("Specific certificate version. Default is latest.")
version?: string;
}

Expand Down Expand Up @@ -125,28 +125,28 @@ enum CertificateTypes {

@doc("Represents secret object properties")
model SecretObjectProperties {
@doc("File name when written to disk. Same as object name if not specified")
@doc("File name when written to disk. Same as object name if not specified.")
`alias`?: string;

@doc("Encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8'")
@doc("Encoding format 'utf-8', 'hex', 'base64'. Default is 'utf-8'.")
encoding?: VolumeSecretEncodings = VolumeSecretEncodings.utf8;

@doc("Secret name in Azure Key Vault")
@doc("Secret name in Azure Key Vault.")
name: string;

@doc("Specific secret version. Default is latest")
@doc("Specific secret version. Default is latest.")
version?: string;
}

@doc("Represents key object properties")
model KeyObjectProperties {
@doc("File name when written to disk. Same as object name if not specified")
@doc("File name when written to disk. Same as object name if not specified.")
`alias`?: string;

@doc("Key name in Azure Key Vault")
@doc("Key name in Azure Key Vault.")
name: string;

@doc("Specific key version. Default is latest")
@doc("Specific key version. Default is latest.")
version?: string;
}

Expand Down
2 changes: 1 addition & 1 deletion typespec/Applications.Datastores/mongoDatabases.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ model MongoDatabaseProperties {
@doc("The MongoDB port.")
port?: int32;

@doc("Database name of the target MongoDB")
@doc("Database name of the target MongoDB.")
database?: string;

@doc("An array of resources which underlay this resource. For example, an Azure CosmosDB database ID if the MongoDB resource is leveraging CosmosDB.")
Expand Down
4 changes: 2 additions & 2 deletions typespec/Applications.Messaging/rabbitMQQueues.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ model RabbitMQSecrets {
@doc("The password used to connect to this RabbitMQ. Write only.")
password?: string;

@doc("The URI to the Rabbit MQ Message Queue. Write only")
@doc("The URI to the Rabbit MQ Message Queue. Write only.")
uri?: string;
}

Expand All @@ -79,7 +79,7 @@ model RabbitMQQueueProperties {
@doc("The RabbitMQ virtual host (vHost) the client will connect to. Defaults to no vHost.")
vHost?: string;

@doc("Username to use when connecting to the target rabbitMQ.")
@doc("Username to use when connecting to the target RabbitMQ.")
username?: string;

@doc(" An array of IDs of the underlying resources.")
Expand Down

0 comments on commit 848b381

Please sign in to comment.