Skip to content

[cognitive services][machine translation][document batch translator api] Update documentation, support new formats & add storage field to glossaries#12576

Merged
anuchandy merged 6 commits intoAzure:masterfrom
FadyEssam:UpdateDoc
Jan 26, 2021
Merged

[cognitive services][machine translation][document batch translator api] Update documentation, support new formats & add storage field to glossaries#12576
anuchandy merged 6 commits intoAzure:masterfrom
FadyEssam:UpdateDoc

Conversation

@FadyEssam
Copy link
Copy Markdown
Contributor

@FadyEssam FadyEssam commented Jan 24, 2021 •
edited
Loading

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.

  1. 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
  2. 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.

We are going to public preview in start of Feb/2021 so we are deploying latest features to prod by the end of Jan/2021

  1. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

before the end of Jan/2021

  1. 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:

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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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.

@FadyEssam FadyEssam requested a review from yangyuan as a code owner January 24, 2021 15:36
@openapi-workflow-bot
Copy link
Copy Markdown

openapi-workflow-bot Bot commented Jan 24, 2021

Hi, @FadyEssam Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jan 24, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link
    Copy Markdown

    openapi-pipeline-app Bot commented Jan 24, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 825cc5c. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-01-26 17:54:12 ERROR [Skip] readme path does not format as specification/*/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 825cc5c. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
cmderr	[automation_init.sh]   Failed building wheel for wrapt
cmderr	[automation_init.sh]   Failed building wheel for yarl
cmderr	[automation_init.sh]   Failed building wheel for multidict
cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
    • ️✔️azure-cognitiveservices-translatortext [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 825cc5c. SDK Automation 14.0.0 
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️cognitiveservices/v3.0/translatortext [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️preview/cognitiveservices/v1.0_preview.1/translatortext [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Type of `TargetInput.StorageSource` has been changed from `StorageSource1` to `StorageSource2`
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New const `StorageSource2AzureBlob`
info	[Changelog] - New function `PossibleStorageSource2Values() []StorageSource2`
info	[Changelog] - New field `StorageSource` in struct `Glossary`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 3 additive change(s).
info	[Changelog]
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Jan 24, 2021
    @ghost
    Copy link
    Copy Markdown

    ghost commented Jan 24, 2021

    Thank you for your contribution FadyEssam! We will review the pull request and get back to you soon.

    @openapi-sdkautomation openapi-sdkautomation Bot mentioned this pull request Jan 24, 2021
    Closed
    anuchandy
    anuchandy reviewed Jan 26, 2021
    View reviewed changes
    Comment thread ...tion/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json
    "example": "2.0"
    },
    "storageSource": {
    "$ref": "#/definitions/StorageSource"
    Copy link
    Copy Markdown
    Member

    @anuchandy anuchandy Jan 26, 2021

    Choose a reason for hiding this comment

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

    Is this addition of new property is intentional? I see the description says PR is about doc update, so just want to make sure addition of this property is not by error.

    Copy link
    Copy Markdown
    Member

    @anuchandy anuchandy Jan 26, 2021

    Choose a reason for hiding this comment

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

    or this property is to enable the file formats?

    Copy link
    Copy Markdown
    Contributor Author

    @FadyEssam FadyEssam Jan 26, 2021

    Choose a reason for hiding this comment

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

    yes this is an intentional property, but it is completely backward compatible (this property has a default value keeping the same behavior)

    Copy link
    Copy Markdown
    Contributor Author

    @FadyEssam FadyEssam Jan 26, 2021

    Choose a reason for hiding this comment

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

    updated the PR title

    @FadyEssam FadyEssam changed the title [cognitive services][machine translation][document batch translator api] Update documentation and support new formats [cognitive services][machine translation][document batch translator api] Update documentation, support new formats & add storage field to glossaries Jan 26, 2021
    @anuchandy anuchandy merged commit 825cc5c into Azure:master Jan 26, 2021
    This was referenced Jan 26, 2021
    Closed
    Closed
    Closed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @anuchandy anuchandy anuchandy approved these changes

    @yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

    Assignees

    @anuchandy anuchandy

    Labels

    CI-BreakingChange-Go customer-reported Issues that are reported by GitHub users external to the Azure organization.

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    3 participants

    @FadyEssam @anuchandy @FadyEssam2