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.

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

fix the description of visibilityTimeout in MessagesEnqueueOptionalPa… #12189

Merged
merged 2 commits into from
Nov 4, 2020

Conversation

ljian3377
Copy link
Member

…rams

Fixes #8302

@ghost ghost added the Storage Storage Service (Queues, Blobs, Files) label Oct 30, 2020
@@ -107,6 +107,10 @@ directive:
where: $.parameters.VisibilityTimeoutRequired
transform: >
$["x-ms-client-name"] = "visibilityTimeout";
- from: swagger-document
where: $.parameters.VisibilityTimeoutForEnqueue
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am a little surprised that without the swagger transformation, the codegen will pick the documentation from another parameter. @joheredi can you have a look to see whether it's expected behavior in autorest?

Copy link
Member Author

@ljian3377 ljian3377 Oct 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I also updated the swagger to fix this. We used the same paramter for the two parmeters in enqueue and dequeue in the swagger, while their descriptions should be different. So I think the codegen is working as expected.
Azure/azure-rest-api-specs#11459

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the Swagger already sets the x-ms-client-name to "visibilityTimeout". Do we need to have it here as well?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "x-ms-client-name": "visibilityTimeout" in swagger is removed in Azure/azure-rest-api-specs#11461.
Other languages use a different casing so we have to do it in our own README.md.

Copy link
Member

@jiacfan jiacfan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@ljian3377 ljian3377 merged commit c51b20d into Azure:master Nov 4, 2020
@ljian3377 ljian3377 deleted the storage/doc-fix branch November 4, 2020 04:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Storage Storage Service (Queues, Blobs, Files)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

QueueSendMessageOptions.visibilityTimeout causes message to start out 'invisible'
4 participants