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

BotService Preview: new API version for MsTeams and CheckNameavailability #3478

Merged
merged 2 commits into from
Aug 2, 2018

Conversation

carlosscastro
Copy link
Contributor

@carlosscastro carlosscastro commented Jul 23, 2018

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

  • The title of the PR is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
  • Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
  • If applicable, the PR references the bug/issue that it fixes.
  • Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

@AutorestCI
Copy link

AutorestCI commented Jul 23, 2018

Automation for azure-sdk-for-python

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-python#2337

@AutorestCI
Copy link

AutorestCI commented Jul 23, 2018

Automation for azure-sdk-for-node

Nothing to generate for azure-sdk-for-node

@AutorestCI
Copy link

AutorestCI commented Jul 23, 2018

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

@AutorestCI
Copy link

AutorestCI commented Jul 23, 2018

Automation for azure-sdk-for-java

Nothing to generate for azure-sdk-for-java

@AutorestCI
Copy link

AutorestCI commented Jul 23, 2018

Automation for azure-sdk-for-go

The initial PR has been merged into your service PR:
Azure/azure-sdk-for-go#2380

@annatisch annatisch added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jul 25, 2018
@annatisch
Copy link
Member

ping @ravbhatnagar for ARM review.

@annatisch
Copy link
Member

Thanks for your patience @carlosscastro - the only changes I can find between this API spec and the previous one are:

  • The checkNameAvailability URL has changed:
    /providers/Microsoft.BotService/botServices/checkNameAvailability to /providers/Microsoft.BotService/checkNameAvailability
  • The MSTeamsChannelProperties parameters have changed:
    • removed enableMessaging
    • removed enableMediaCards
    • removed enableVideo
    • removed callMode
    • added callingWebHook which is a string.

Does this sounds accurate to you?
It's also worth noting that there will be no new SDKs generated or published unless the new API version is also added as a package tag to the readme.md

@carlosscastro
Copy link
Contributor Author

Thanks @annatisch !

That is accurate, the changes are pretty minimal.

I'm adding the new api version to the readme now, good catch! Please take a look at that once its out to make sure I did it correctly, its my first time adding a new API version :) Thanks

Copy link
Contributor

@ravbhatnagar ravbhatnagar left a comment

Choose a reason for hiding this comment

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

Looks good except one note.

"info": {
"title": "Azure Bot Service",
"description": "Azure Bot Service is a platform for creating smart conversational agents.",
"version": "2018-07-12"
Copy link
Contributor

Choose a reason for hiding this comment

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

If this is preview, please add a -preview suffix to the api-version

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ravbhatnagar I already updated manifest and our PPE environment with this version name. Would it be acceptable to leave it as-is, given that it is in the preview folder? If not, I can rev all the changes but it is a bit hard to coordinate.

Copy link
Member

Choose a reason for hiding this comment

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

@carlosscastro - just to clarify - the "preview" directory in the repo is not related to the "preview" status of the API. The directory name is only to indicate the status of the swagger spec and it's stability for producing SDKs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@annatisch thanks for clarifying. Regardless, given that our previous API version has no '-preview' and that we already deployed some code with this API version, can we agree to leave it as-is? We will still support the previous API version simultaneously for 8+ months.

Copy link
Member

Choose a reason for hiding this comment

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

@ravbhatnagar can correct me if I'm wrong - but is this new API version considered a stable API deployment? Or a preview API? If it's a preview API (e.g. limited availability, trial features etc) then the API version should probably have a suffix.
However if this is a stable API and we are discussing this because of the PR title and the location in the "preview" directory then the suffix probably isn't necessary.

Though will leave this call up to @ravbhatnagar as I'm not familiar with correct process here :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure. @ravbhatnagar let us know if we can merge with API version as-is. We signed up as preview just because they are the first couple of versions, but we will be respecting all the stable requirements, i.e. long term support of past version, etc.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fine from my side. More details in the email.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks!!! @annatisch can we merge this PR?

Copy link
Member

Choose a reason for hiding this comment

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

Thanks @carlosscastro - I will do a final review today.

@ravbhatnagar ravbhatnagar added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jul 28, 2018
@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants