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

fix the description of visibilityTimeout in MessagesEnqueueOptionalPa… #12189

Merged
merged 2 commits into from
Nov 4, 2020
Merged

fix the description of visibilityTimeout in MessagesEnqueueOptionalPa… #12189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
32889df
fix the description of visibilityTimeout in MessagesEnqueueOptionalPa…
ljian3377 Oct 30, 2020
43fc77d
rename
ljian3377 Oct 30, 2020
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
11 changes: 6 additions & 5 deletions sdk/storage/storage-queue/src/generated/src/models/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,11 +583,12 @@ export interface MessagesClearOptionalParams extends coreHttp.RequestOptionsBase
*/
export interface MessagesEnqueueOptionalParams extends coreHttp.RequestOptionsBase {
/**
* Optional. Specifies the new visibility timeout value, in seconds, relative to server time. The
* default value is 30 seconds. A specified value must be larger than or equal to 1 second, and
* cannot be larger than 7 days, or larger than 2 hours on REST protocol versions prior to
* version 2011-08-18. The visibility timeout of a message can be set to a value later than the
* expiry time.
* Optional. If specified, the request must be made using an x-ms-version of 2011-08-18 or later.
* If not specified, the default value is 0. Specifies the new visibility timeout value, in
* seconds, relative to server time. The new value must be larger than or equal to 0, and cannot
* be larger than 7 days. The visibility timeout of a message cannot be set to a value later than
* the expiry time. visibilitytimeout should be set to a value smaller than the time-to-live
* value.
*/
visibilityTimeout?: number;
/**
Expand Down
4 changes: 4 additions & 0 deletions sdk/storage/storage-queue/swagger/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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.

transform: >
$["x-ms-client-name"] = "visibilityTimeout";
```

### Rename permission -> permissions
Expand Down