[batch document translation][mt] small changes to swagger's name + new fields in response #12965

alexhcheng · 2021-02-11T21:59:18Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

This reverts commit 025b875.

azure-pipelines · 2021-02-18T03:55:46Z

Azure Pipelines successfully started running 2 pipeline(s).

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json

openapi-workflow-bot · 2021-02-18T18:39:53Z

Hi @alexhcheng, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json

…or preview

maririos

LGTM! Thank you Alex!!

maririos · 2021-02-19T21:58:28Z

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json

+      "x-ms-enum": {
+        "name": "StorageInputType",
+        "modelAsString": true,
+        "values": [


@iscai-msft curious, is the values array necessary? or can it be omitted so no need to maintain enum and s-ms-enum

maririos · 2021-02-19T22:00:47Z

Question about the location of the files. They are currently under TranslatorText although this is the DocumentTranslator service. Will that be a concern? like should it be in it's own folder?
Or organize it like Translator/TextTranslator and Translator/DocumentTranslator?

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json

jhendrixMSFT · 2021-02-22T16:24:02Z

@alexhcheng does anybody from your team need to review this? Looks good from my side.

alexhcheng · 2021-02-22T16:58:04Z

@alexhcheng does anybody from your team need to review this? Looks good from my side.

I just had a sync up with our team, they approve these changes. So we are good to go. @jhendrixMSFT

This reverts commit 3b0e442.

…w fields in response (Azure#12965) * Merged from master again * updated swagger based on API review feedback * updated post * fix spelling * added x-ms-pageable, x-ms-error-response, x-ms-long-running * fix enum * remove long running operation * bug in sdk go generation * Revert "bug in sdk go generation" This reverts commit 025b875. * remove x-ms-pageable * addressed changes * fix casing for x-ms-parameterized-host * fix endpoint in examples * move everything in the same SDK readme file * change path to v1.0_preview.1 * add input type parameter for folder vs file * Merged from master again * updated swagger based on API review feedback * updated post * fix spelling * added x-ms-pageable, x-ms-error-response, x-ms-long-running * fix enum * remove long running operation * bug in sdk go generation * Revert "bug in sdk go generation" This reverts commit 025b875. * remove x-ms-pageable * addressed changes * fix casing for x-ms-parameterized-host * fix endpoint in examples * move everything in the same SDK readme file * change path to v1.0_preview.1 * Update title of swagger page * update ' * updating formating to formatting * Merged from master again * updated swagger based on API review feedback * updated post * fix spelling * added x-ms-pageable, x-ms-error-response, x-ms-long-running * fix enum * remove long running operation * bug in sdk go generation * Revert "bug in sdk go generation" This reverts commit 025b875. * remove x-ms-pageable * addressed changes * fix casing for x-ms-parameterized-host * fix endpoint in examples * move everything in the same SDK readme file * change path to v1.0_preview.1 * Update title of swagger page * Merged from master again * updated swagger based on API review feedback * updated post * fix spelling * added x-ms-pageable, x-ms-error-response, x-ms-long-running * fix enum * remove long running operation * bug in sdk go generation * Revert "bug in sdk go generation" This reverts commit 025b875. * remove x-ms-pageable * addressed changes * fix casing for x-ms-parameterized-host * fix endpoint in examples * move everything in the same SDK readme file * change path to v1.0_preview.1 * update ' * updating formating to formatting * update swagger changes * fix ' * added x-ms-enum * fix x-ms-enum, added a few more xmsextensions, remove go generation for preview * fix examples and error code * add jsonignore to internalcode * fix quotes * modelasstring = true * update x-ms-enum name * Revert "update x-ms-enum name" This reverts commit 3b0e442.

alexhcheng added 30 commits August 25, 2020 10:20

Merged from master again

003936f

updated swagger based on API review feedback

03e9107

updated post

a46d5d6

fix spelling

5254297

added x-ms-pageable, x-ms-error-response, x-ms-long-running

f751d11

fix enum

a377257

remove long running operation

608a9d4

bug in sdk go generation

08e7ef0

Revert "bug in sdk go generation"

ef1f2b2

This reverts commit 025b875.

remove x-ms-pageable

a416e02

addressed changes

7f93856

fix casing for x-ms-parameterized-host

ca82cbe

fix endpoint in examples

bf751b8

move everything in the same SDK readme file

e0d21e0

change path to v1.0_preview.1

583c3db

add input type parameter for folder vs file

3f5a459

Merged from master again

855ee7b

updated swagger based on API review feedback

f79507f

updated post

2d55fa4

fix spelling

615d6df

added x-ms-pageable, x-ms-error-response, x-ms-long-running

b57403f

fix enum

1196757

remove long running operation

095f47e

bug in sdk go generation

80f5423

Revert "bug in sdk go generation"

0163acd

This reverts commit 025b875.

remove x-ms-pageable

96cb962

addressed changes

f191e92

fix casing for x-ms-parameterized-host

b0ce5ee

fix endpoint in examples

89c3d14

move everything in the same SDK readme file

5d0eae0

maririos reviewed Feb 18, 2021

View reviewed changes

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json Show resolved Hide resolved

openapi-pipeline-app bot added the CI-BreakingChange-Go label Feb 18, 2021

added x-ms-enum

818fae7

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed BreakingChangeReviewRequired labels Feb 18, 2021

openapi-pipeline-app bot removed the CI-BreakingChange-Go label Feb 18, 2021

jhendrixMSFT reviewed Feb 19, 2021

View reviewed changes

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json Outdated Show resolved Hide resolved

fix x-ms-enum, added a few more xmsextensions, remove go generation f…

34c4298

…or preview

alexhcheng requested a review from ArcturusZhang as a code owner February 19, 2021 18:10

openapi-pipeline-app bot added BreakingChangeReviewRequired and removed CI-FixRequiredOnFailure labels Feb 19, 2021

alexhcheng added 4 commits February 19, 2021 10:26

fix examples and error code

fd2ba1a

add jsonignore to internalcode

d833666

fix quotes

d98e987

modelasstring = true

644d9f1

maririos approved these changes Feb 19, 2021

View reviewed changes

maririos reviewed Feb 19, 2021

View reviewed changes

jhendrixMSFT reviewed Feb 19, 2021

View reviewed changes

...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json Show resolved Hide resolved

update x-ms-enum name

3b0e442

Revert "update x-ms-enum name"

d200428

This reverts commit 3b0e442.

jhendrixMSFT approved these changes Feb 22, 2021

View reviewed changes

jhendrixMSFT merged commit a23007d into Azure:master Feb 22, 2021

openapi-sdkautomation bot mentioned this pull request Feb 22, 2021

[ReleasePR cognitiveservices/v3.0/translatortext] [Document Translator] update operation names Azure/azure-sdk-for-go#14226

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[batch document translation][mt] small changes to swagger's name + new fields in response #12965

[batch document translation][mt] small changes to swagger's name + new fields in response #12965

alexhcheng commented Feb 11, 2021

azure-pipelines bot commented Feb 18, 2021

openapi-workflow-bot bot commented Feb 18, 2021

maririos left a comment

maririos Feb 19, 2021

maririos commented Feb 19, 2021

jhendrixMSFT commented Feb 22, 2021

alexhcheng commented Feb 22, 2021

[batch document translation][mt] small changes to swagger's name + new fields in response #12965

[batch document translation][mt] small changes to swagger's name + new fields in response #12965

Conversation

alexhcheng commented Feb 11, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

azure-pipelines bot commented Feb 18, 2021

openapi-workflow-bot bot commented Feb 18, 2021

maririos left a comment

Choose a reason for hiding this comment

maririos Feb 19, 2021

Choose a reason for hiding this comment

maririos commented Feb 19, 2021

jhendrixMSFT commented Feb 22, 2021

alexhcheng commented Feb 22, 2021