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

[Cognitive Services] Update endpoint URL template for Face. #3490

Merged
merged 2 commits into from Jul 26, 2018
Merged

[Cognitive Services] Update endpoint URL template for Face. #3490

merged 2 commits into from Jul 26, 2018

Conversation

yangyuan
Copy link
Member

@yangyuan yangyuan commented Jul 24, 2018

Detail background and explainations in here: #3489 Cognitive Services URL template (endpoint)

Please hold for @huxuan or @lebronJ 's review.

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 24, 2018

Automation for azure-sdk-for-python

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

@AutorestCI
Copy link

AutorestCI commented Jul 24, 2018

Automation for azure-sdk-for-node

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

@AutorestCI
Copy link

AutorestCI commented Jul 24, 2018

Automation for azure-sdk-for-ruby

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

@@ -8,7 +8,6 @@ nodejs:
package-name: azure-cognitiveservices-face
package-version: 1.0.0-preview
output-folder: $(node-sdks-folder)/lib/services/face
override-client-name: FaceAPIClient
Copy link
Member Author

Choose a reason for hiding this comment

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

Remove this as the class name now naturally ends with "Client"

@AutorestCI
Copy link

AutorestCI commented Jul 24, 2018

Automation for azure-sdk-for-java

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

@AutorestCI
Copy link

AutorestCI commented Jul 24, 2018

Automation for azure-sdk-for-go

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

@yangyuan yangyuan changed the title [cognitive Services] Update endpoint URL template for Face. [Cognitive Services] Update endpoint URL template for Face. Jul 24, 2018
@@ -1,6 +1,6 @@
{
"parameters": {
"AzureRegion": "westus",
"Endpoint": "{Endpoint}",
Copy link
Contributor

Choose a reason for hiding this comment

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

[Nit] Indent

@lebronJ
Copy link
Contributor

lebronJ commented Jul 25, 2018

LGTM 👍

},
"Endpoint": {
"name": "Endpoint",
"description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).",
Copy link

@huxuan huxuan Jul 25, 2018

Choose a reason for hiding this comment

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

I am a little concern about the Endpoint setting. Previously, we also have Endpoint concept in Windows SDK [1] and many other places where the endpoint is the whole base url including the path /face/v1.0. I prefer we keep consistency and that is also more general since the path dose not need to be fixed. But if this is a team decision as explained in #3489 that we will keep the same style in all cognitive services, I am OK with it.

[1] https://github.com/Microsoft/Cognitive-Common-Windows/blob/10b0875f4f984186db45ec6da987617dd967d14f/SampleUserControlLibrary/SubscriptionKeyPage.xaml#L49

Copy link
Member Author

Choose a reason for hiding this comment

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

Hi @huxuan, the decision is a compromise according to the feedback from multiple teams as well as the limitations of swagger. (In fact we have this change because we prefer consistency over back compatibility)

In this PR we changed the definition of Endpoint, we are planning to update Endpoint in documents and Azure Portal when all the teams agree with the change.

Copy link
Member Author

Choose a reason for hiding this comment

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

@huxuan BTW feel free to bring up you concerns in the e-mail thread.

@huxuan
Copy link

huxuan commented Jul 25, 2018

Others LGTM.

@yangyuan
Copy link
Member Author

Hi @jhendrixMSFT, I guess we can merge this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants