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

[ServiceBus] Invalid parameter in documentation for getMessageIterator function #16618

Closed
3 of 4 tasks
Zenious opened this issue Jul 28, 2021 · 1 comment · Fixed by #16957
Closed
3 of 4 tasks

[ServiceBus] Invalid parameter in documentation for getMessageIterator function #16618

Zenious opened this issue Jul 28, 2021 · 1 comment · Fixed by #16957
Assignees
@chradek
Labels
Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Service Bus
Milestone
[2021] September

Comments

@Zenious
Copy link

Zenious commented Jul 28, 2021

  • Package Name: @azure/service-bus
  • Package Version: v7
  • Is the bug related to documentation in
  • typescript
    • version: 4.3.5

Describe the bug
Parameters option maxWaitTimeInMs shown in source code documentation and SDK API docs for ServiceBusReceiver's getMessageIterator function is invalid. The options interface, GetMessageIteratorOptions does not have the property maxWaitTimeInMs, hence any attempt to include maxWaitTimeInMs will result in error in typescript.

Screenshots
image
image
image

Additional context
Source Code Documentation for ServiceBusReceiver.getMessageIterator
@ghost ghost added needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. customer-reported Issues that are reported by GitHub users external to the Azure organization. question The issue doesn't require a change to the product in order to be resolved. Most issues start as that labels Jul 28, 2021
@ramya-rao-a ramya-rao-a added Client This issue points to a problem in the data-plane of the library. Docs Service Bus labels Jul 29, 2021
@ghost ghost removed the needs-triage Workflow: This is a new issue that needs to be triaged to the appropriate team. label Jul 29, 2021
@chradek chradek mentioned this issue Aug 17, 2021
Merged
@chradek
Copy link
Contributor

chradek commented Aug 17, 2021

@Zenious
Thanks for reporting this issue and sorry for the delayed response. Both the maxWaitTimeInMs and the note that undefined will be returned if the iterator can't fetch a new message in over a minute were leftover from when this library was still in preview.

I've updated the docs to reflect the actual intended current status in #16957

@ramya-rao-a ramya-rao-a added this to the [2021] September milestone Aug 24, 2021
openapi-sdkautomation bot pushed a commit to AzureSDKAutomation/azure-sdk-for-js that referenced this issue Nov 5, 2021
CodeGen from PR 16618 in Azure/azure-rest-api-specs
bae226c 
[python] replace api-version `2021-03-01` with `2021-05-01` (Azure#16618)

* Update readme.python.md

* Update readme.python.md

* Update readme.python.md
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@chradek chradek

Labels
Client This issue points to a problem in the data-plane of the library. customer-reported Issues that are reported by GitHub users external to the Azure organization. Docs question The issue doesn't require a change to the product in order to be resolved. Most issues start as that Service Bus
Projects
None yet
Milestone
[2021] September
Development

Successfully merging a pull request may close this issue.

[service-bus] fix getMessageIterator docs chradek/azure-sdk-for-js
3 participants
@Zenious @ramya-rao-a @chradek