fix the description of queue sendMessage's VisibilityTimeout option's…

[ljian3377]

… description

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

• I commit to follow the Breaking Change Policy of “no breaking changes
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

• Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

  • Adding new API(s)
  • Adding a new API version
  • Adding a new service

• Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

• Removing API(s) in stable version
• Removing properties in stable version
• Removing API version(s) in stable version
• Updating API in stable version with Breaking Change Validation errors
• Updating API(s) in preview over 1 year

Please follow the link to find more details on PR review process.

[openapi-pipeline-app]

[Staging] Swagger Validation Report

️️✔️BreakingChange [Detail]

 There are no breaking changes. 

️️✔️LintDiff [Detail]

 Validation passes for LintDiff. 

️️✔️Avocado [Detail]

 Validation passes for Avocado. 

️️✔️ModelValidation [Detail]

 Validation passes for ModelValidation. 

️❌SemanticValidation: 19 Errors, 0 Warnings [Detail] [Expand]

Only 10 items are listed, please refer to log for more details.

Rule	Message
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L397
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: visibilityTimeout JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L821
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L452
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L514
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L582
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L637
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L705
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L766
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L821
❌ MISSING_PATH_PARAMETER_DEFINITION	Path parameter is declared but is not defined: queueName JsonUrl: Microsoft.QueueStorage/preview/2018-03-28/queue.json#L322

_{Posted by Swagger Pipeline | How to fix these errors?}

[azure-pipelines]

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

[azure-pipelines]

Azure Pipelines could not run because the pipeline triggers exclude this branch/path.

[ljian3377]

Reference: https://docs.microsoft.com/en-us/rest/api/storageservices/put-message#uri-parameters

[alzimmermsft]

This is using a different casing than previously, visibility**T**imeout vs visibility**t**imeout, is that going to cause an issue with generation?

[ljian3377]

I first went without "x-ms-client-name": "visibilityTimeout" but it turned out to be named visibilitytimeout in JavaScript generated code, while before this change, the original name has camel case - visibilityTimeout.

I don't want to change the name here, i.e. want to keep the camel case as it was; so add the x-ms-client-name to enforce it. Worked in JavaScript. May need to verify in other languages.

[ljian3377]

Turns out we have this transform in JavaScript README.md

Rename visibilitytimeout -> visibilityTimeout

directive:
  - from: swagger-document
    where: $.parameters.VisibilityTimeout
    transform: >
      $["x-ms-client-name"] = "visibilityTimeout";
  - from: swagger-document
    where: $.parameters.VisibilityTimeoutRequired
    transform: >
      $["x-ms-client-name"] = "visibilityTimeout";

[ljian3377]

Hmm, looks like .NET don't have this transform.
https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/storage/Azure.Storage.Queues/swagger

I will remove "x-ms-client-name": "visibilityTimeout" in the swagger and add another transform in JavaScript.

[kasobol-msft]

I think "name": "visibilityTimeout" is enough x-ms-client-name would be to override it.

[kasobol-msft]

But to @alzimmermsft 's comment we should fix casing in name. Otherwise compilation may fail in .NET/Java

[kasobol-msft]

Sorry my bad. looks like in other versions of this parameter it's all lower-case. Plz disregard previous comment.

[alzimmermsft]

From my understanding this should use visibilitytimeout as that is what it would previously generate with: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Queues/src/Generated/QueueRestClient.cs#L1868

[ljian3377]

Removed "x-ms-client-name": "visibilityTimeout" in #11461