Added the folder for Translator and the Open API file for Text Translation API V3 #3705

kellyaltom · 2018-08-22T22:33:53Z

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

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

msftclas · 2018-08-22T22:34:04Z

All CLA requirements met.

AutorestCI · 2018-08-22T22:34:16Z

Automation for azure-sdk-for-python

Encountered a Subprocess error: (azure-sdk-for-python)

Command: ['/usr/local/bin/autorest', '/tmp/tmpxbba3_0f/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmpktdj7ist']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4284)
ERROR: Syntax Error Encountered: Syntax error: can not read a block mapping entry; a multiline key may not be an implicit key
    - file:///tmp/tmpxbba3_0f/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md:112:4
[OperationAbortedException] Error occurred. Exiting.

AutorestCI · 2018-08-22T22:34:26Z

Automation for azure-sdk-for-go

Encountered a Subprocess error: (azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpodjstidt/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmp0rdycswj']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.4]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4283)
ERROR: Syntax Error Encountered: Syntax error: can not read a block mapping entry; a multiline key may not be an implicit key
    - file:///tmp/tmpodjstidt/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md:112:4
[OperationAbortedException] Error occurred. Exiting.

AutorestCI · 2018-08-22T22:34:58Z

Automation for azure-sdk-for-ruby

Encountered a Subprocess error: (azure-sdk-for-ruby)

Command: ['/usr/local/bin/autorest', '/tmp/tmpj9bsr5bi/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmpwxm_oj0m']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4284)
ERROR: Syntax Error Encountered: Syntax error: can not read a block mapping entry; a multiline key may not be an implicit key
    - file:///tmp/tmpj9bsr5bi/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md:112:4
[OperationAbortedException] Error occurred. Exiting.

azuresdkci · 2018-08-22T22:35:08Z

Can one of the admins verify this patch?

AutorestCI · 2018-08-22T22:36:24Z

Automation for azure-sdk-for-node

Encountered a Subprocess error: (azure-sdk-for-node)

Command: ['/usr/local/bin/autorest', '/tmp/tmp5znxb86a/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmp81xpp6vn']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4283)
ERROR: Syntax Error Encountered: Syntax error: can not read a block mapping entry; a multiline key may not be an implicit key
    - file:///tmp/tmp5znxb86a/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md:112:4
[OperationAbortedException] Error occurred. Exiting.

AutorestCI · 2018-08-22T22:36:25Z

Automation for azure-sdk-for-java

Encountered a Subprocess error: (azure-sdk-for-java)

Command: ['/usr/local/bin/autorest', '/tmp/tmplt__u25v/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md', '--perform-load=false', '--swagger-to-sdk', '--output-artifact=configuration.json', '--input-file=foo', '--output-folder=/tmp/tmpfdcyas9n']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4283; node: v8.11.3]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4283)
ERROR: Syntax Error Encountered: Syntax error: can not read a block mapping entry; a multiline key may not be an implicit key
    - file:///tmp/tmplt__u25v/rest/specification/cognitiveservices/data-plane/TranslatorText/v3.0/readme.md:112:4
[OperationAbortedException] Error occurred. Exiting.

jhendrixMSFT

The empty README.md files are causing various processes to fail and need to be fixed.

kellyaltom · 2018-08-22T22:47:46Z

Empty readme files causing problems. Fixing.

kellyaltom · 2018-08-22T22:52:30Z

done

…

________________________________ From: Joel Hendrix <[email protected]> Sent: Wednesday, August 22, 2018 3:37 PM To: Azure/azure-rest-api-specs Cc: KellyAltom; Author Subject: Re: [Azure/azure-rest-api-specs] Added the folder for Translator and the Open API file for Text Translation API V3 (#3705) @jhendrixMSFT requested changes on this pull request. The empty README.md files are causing various processes to fail and need to be fixed. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<https://nam01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fpull%2F3705%23pullrequestreview-148700382&data=02%7C01%7C%7C6cdbde2273654fb7a99808d6087fea33%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636705742809829551&sdata=Iwn8tkLj7auJ3VqWpgzEGGP6c%2BkJt%2Fn5tlZuWeo%2FQlY%3D&reserved=0>, or mute the thread<https://nam01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAOUo1IMKB07SLrlgsCCY89NGVwQNEt5_ks5uTd1HgaJpZM4WIhru&data=02%7C01%7C%7C6cdbde2273654fb7a99808d6087fea33%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636705742809829551&sdata=sTAJrCJOX9SWRKNOPTA0EIbjvdBKU3Pd72n3SdtORgo%3D&reserved=0>.

yangyuan · 2018-08-22T22:46:26Z

specification/cognitiveservices/data-plane/TextTranslation/V3/TextTranslationV3.json

+  "swagger": "2.0",
+  "info": {
+    "version": "3.0",
+    "title": "Translator Text API",


Title will be used for client class name
Please change to "Translator Text Client" to keep consistent with other Cognitive Services.

yangyuan · 2018-08-22T22:54:07Z

specification/cognitiveservices/data-plane/TextTranslation/V3/TextTranslationV3.json

@@ -0,0 +1,930 @@
+{


I noticed some places we call the service "Translator Text" some places we call it "Text Translation".
We should use same term.

If "Translator Text" is the official service name, in here, the path should be:
specification/cognitiveservices/data-plane/TranslatorText/v3.0/TranslatorText.json

TextTranslation => TranslatorText V3 => v3.0 TextTranslationV3.json => TranslatorText.json

yangyuan · 2018-08-22T22:58:06Z

specification/cognitiveservices/data-plane/TextTranslation/Readme.md

@@ -0,0 +1,3 @@
+# Microsoft Translator API V3


Readme.md => readme.md :)
This file is not a simple readme file. This is actually a configuration/metadata file for generating SDK.

Please refer the example in
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/Face/readme.md
to write an autorest compatible readme.

Yes please be sure to use lower-case in the file name. Also the file format is incorrect and is still causing breaks, please see the logs for details.

kellyaltom · 2018-08-23T22:05:20Z

Made the fixes to the Open API file and the Readme.md files.

jhendrixMSFT · 2018-08-23T22:13:25Z

specification/cognitiveservices/data-plane/TranslatorText/Readme.md

@@ -0,0 +1,4 @@
+# Microsoft Translator API V3


You'll need to rename this file to something else as readme.md has special meaning in this repo. Or just remove it entirely as I don't know how much value it provides regarding swagger generation.

jhendrixMSFT · 2018-08-23T22:23:41Z

specification/cognitiveservices/data-plane/TranslatorText/v3.0/TranslatorText.json

+          "200": {
+            "description": "OK"
+          },
+          "400": {


It isn't necessary to define all these error cases, just use a default response for them. Example here.

kellyaltom · 2018-08-23T22:23:43Z

Changed the readme.md file name to info.md

jhendrixMSFT · 2018-08-23T22:24:37Z

Examples are missing for the operations, see example here.

kellyaltom · 2018-08-23T22:31:27Z

OK I thought the customers would just try the operation out to see what a successful request looks like. A successful request of the Languages method will return 15 screens of data. Do you want all of the data from a successful request or just a subset.

…

________________________________ From: Joel Hendrix <[email protected]> Sent: Thursday, August 23, 2018 3:24 PM To: Azure/azure-rest-api-specs Cc: KellyAltom; State change Subject: Re: [Azure/azure-rest-api-specs] Added the folder for Translator and the Open API file for Text Translation API V3 (#3705) Examples are missing for the operations, see example here<https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fblob%2Fmaster%2Fspecification%2Fcognitiveservices%2Fdata-plane%2FSpellCheck%2Fstable%2Fv1.0%2FSpellCheck.json%23L238&data=02%7C01%7C%7Ccda1e2d13523437adda008d609473c2b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636706598879955479&sdata=62UoIBpFrxrWj5L9egiINhpnheABTesILVWy%2FbXLXcI%3D&reserved=0>. — You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub<https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fpull%2F3705%23issuecomment-415590466&data=02%7C01%7C%7Ccda1e2d13523437adda008d609473c2b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636706598879955479&sdata=SWCyDaV4jQKadjMzHSJ8pqpJZsNButjXYQFnjrGHwrU%3D&reserved=0>, or mute the thread<https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAOUo1C_7Bkud_3JgxemanXIerDTQdlyVks5uTyuugaJpZM4WIhru&data=02%7C01%7C%7Ccda1e2d13523437adda008d609473c2b%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636706598879955479&sdata=9zijn0Za1wStC9E%2FduQ4n68xToktXPP%2BbfPUJYNYI5c%3D&reserved=0>.

jhendrixMSFT · 2018-08-23T23:02:22Z

The examples don't have to be huge, just enough to convey what a request and response can look like. Building on my previous example link, see the details of an example file here.

jhendrixMSFT · 2018-08-31T15:22:06Z

@kellyaltom any update?

kellyaltom · 2018-08-31T16:58:43Z

I plan on getting back to it late next week. We received a lot of last minute requests from SOC auditors that needed to be done this month, and we have a conference next week where I need to give a hands on lab. Should I cancel the pull request and start a new one?

…

________________________________ From: Joel Hendrix <[email protected]> Sent: Friday, August 31, 2018 8:22 AM To: Azure/azure-rest-api-specs Cc: KellyAltom; Mention Subject: Re: [Azure/azure-rest-api-specs] Added the folder for Translator and the Open API file for Text Translation API V3 (#3705) @kellyaltom<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fkellyaltom&data=02%7C01%7C%7C4d5cd000355d4ed5df2108d60f558bfb%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636713257426233666&sdata=2JZNmyLQT%2FBr9e41JKpcS%2B%2FSBzuaAWexS6TsT6bnP5M%3D&reserved=0> any update? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FAzure%2Fazure-rest-api-specs%2Fpull%2F3705%23issuecomment-417698407&data=02%7C01%7C%7C4d5cd000355d4ed5df2108d60f558bfb%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636713257426233666&sdata=awBopl5JpOGIeu2%2BoCob9SBAe%2BU8JawTAUtDxH2vNlY%3D&reserved=0>, or mute the thread<https://eur04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAOUo1DnvUU3glfKMxHVvY-O7iSahRLmWks5uWVSsgaJpZM4WIhru&data=02%7C01%7C%7C4d5cd000355d4ed5df2108d60f558bfb%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636713257426233666&sdata=PlTd3VAl704e9dsPU9fqkKrGMgCcbPFc3FaBvdt8Pvo%3D&reserved=0>.

jhendrixMSFT · 2018-08-31T17:00:45Z

If you think the work is roughly a week out yeah let's close it for now, you can reopen it when ready or create a new one (whatever works best for you).

kellyaltom added 5 commits August 21, 2018 11:34

Create readme.md

6bccc97

Delete readme.md

06807da

Create Readme.md

3c35c90

Create readme.md

a468697

Add files via upload

676354a

kellyaltom requested a review from yangyuan as a code owner August 22, 2018 22:33

azuresdkci assigned jhendrixMSFT Aug 22, 2018

azuresdkci requested a review from jhendrixMSFT August 22, 2018 22:35

jhendrixMSFT requested changes Aug 22, 2018

View reviewed changes

kellyaltom added 6 commits August 22, 2018 15:41

Update Readme.md

b44d324

Update Readme.md

bb918b4

Update Readme.md

2ca0c36

Update readme.md

d437ae9

Update readme.md

ce1c361

Update Readme.md

cd76de8

kellyaltom closed this Aug 22, 2018

yangyuan reviewed Aug 22, 2018

View reviewed changes

kellyaltom reopened this Aug 22, 2018

kellyaltom added 3 commits August 23, 2018 11:08

Create readme.md

ee600ea

Create Readme.md

c6a3efa

Update Readme.md

46a9fa5

kellyaltom added 7 commits August 23, 2018 14:09

Delete TextTranslationV3.json

bd2bf47

Delete readme.md

7380d11

Delete Readme.md

d86c498

Add files via upload

84e82f5

Update readme.md

112ff9c

Update readme.md

841007a

Update readme.md

176fe70

jhendrixMSFT reviewed Aug 23, 2018

View reviewed changes

Rename Readme.md to Inof.md

f4c6cad

jhendrixMSFT reviewed Aug 23, 2018

View reviewed changes

Rename Inof.md to Info.md

e4a9139

kellyaltom closed this Aug 31, 2018

yangyuan mentioned this pull request Feb 19, 2019

Translator Text API V3 #5230

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added the folder for Translator and the Open API file for Text Translation API V3 #3705

Added the folder for Translator and the Open API file for Text Translation API V3 #3705

kellyaltom commented Aug 22, 2018

msftclas commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

azuresdkci commented Aug 22, 2018

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

jhendrixMSFT left a comment

kellyaltom commented Aug 22, 2018

kellyaltom commented Aug 22, 2018 via email

yangyuan Aug 22, 2018

yangyuan Aug 22, 2018

yangyuan Aug 22, 2018 •

edited

Loading

jhendrixMSFT Aug 23, 2018

kellyaltom commented Aug 23, 2018

jhendrixMSFT Aug 23, 2018

jhendrixMSFT Aug 23, 2018

kellyaltom commented Aug 23, 2018

jhendrixMSFT commented Aug 23, 2018

kellyaltom commented Aug 23, 2018 via email

jhendrixMSFT commented Aug 23, 2018

jhendrixMSFT commented Aug 31, 2018

kellyaltom commented Aug 31, 2018 via email

jhendrixMSFT commented Aug 31, 2018

Added the folder for Translator and the Open API file for Text Translation API V3 #3705

Added the folder for Translator and the Open API file for Text Translation API V3 #3705

Conversation

kellyaltom commented Aug 22, 2018

PR information

Quality of Swagger

msftclas commented Aug 22, 2018 • edited Loading

AutorestCI commented Aug 22, 2018 • edited Loading

Automation for azure-sdk-for-python

AutorestCI commented Aug 22, 2018 • edited Loading

Automation for azure-sdk-for-go

AutorestCI commented Aug 22, 2018 • edited Loading

Automation for azure-sdk-for-ruby

azuresdkci commented Aug 22, 2018

AutorestCI commented Aug 22, 2018 • edited Loading

Automation for azure-sdk-for-node

AutorestCI commented Aug 22, 2018 • edited Loading

Automation for azure-sdk-for-java

jhendrixMSFT left a comment

Choose a reason for hiding this comment

kellyaltom commented Aug 22, 2018

kellyaltom commented Aug 22, 2018 via email

yangyuan Aug 22, 2018

Choose a reason for hiding this comment

yangyuan Aug 22, 2018

Choose a reason for hiding this comment

yangyuan Aug 22, 2018 • edited Loading

Choose a reason for hiding this comment

jhendrixMSFT Aug 23, 2018

Choose a reason for hiding this comment

kellyaltom commented Aug 23, 2018

jhendrixMSFT Aug 23, 2018

Choose a reason for hiding this comment

jhendrixMSFT Aug 23, 2018

Choose a reason for hiding this comment

kellyaltom commented Aug 23, 2018

jhendrixMSFT commented Aug 23, 2018

kellyaltom commented Aug 23, 2018 via email

jhendrixMSFT commented Aug 23, 2018

jhendrixMSFT commented Aug 31, 2018

kellyaltom commented Aug 31, 2018 via email

jhendrixMSFT commented Aug 31, 2018

msftclas commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

AutorestCI commented Aug 22, 2018 •

edited

Loading

yangyuan Aug 22, 2018 •

edited

Loading