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.

Sign up for GitHub

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

Jump to bottom

[Cognitive Services] change PEC actionRequired to actionsRequired #13066

Merged
merged 1 commit into from Feb 22, 2021
Merged

[Cognitive Services] change PEC actionRequired to actionsRequired #13066

merged 1 commit into from Feb 22, 2021

Conversation

yangyuan
Copy link
Member

@yangyuan yangyuan commented Feb 19, 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.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. 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 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.

@openapi-workflow-bot
Copy link

Hi, @yangyuan 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

    openapi-pipeline-app bot commented Feb 19, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

    Rule Message
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'actionRequired' renamed or removed?
    New: Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json#L1837:7
    Old: Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json#L1837:7
    ️️✔️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.
    ️⚠️[Staging] SDK Track2 Validation: 39 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'Sku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesAccountListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesAccountProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesAccountApiProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesAccountKeys' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'RegenerateKeyParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesAccountEnumerateSkusResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'CognitiveServicesResourceAndSku' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'UsagesResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"cognitiveservices/resource-manager/readme.md",
    "tag":"package-2017-04",
    "details":"The schema 'Usage' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 19, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4151fbc. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/cognitiveservices/resource-manager/readme.md
    • ️✔️cognitiveservices [View full logs]  [Release Schema Changes] 
      cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN
cmderr	[resource-manager] Using request for node-pre-gyp https download
cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4151fbc. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/cognitiveservices/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.Management.CognitiveServices [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4151fbc. 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-02-22 05:33:59 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-cognitiveservices"
cmderr	[generate.py] 2021-02-22 05:33:59 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-02-22 05:33:59 INFO autorest --version=3.0.6369 --use=@autorest/java@4.0.17 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/cognitiveservices/azure-resourcemanager-cognitiveservices --java.namespace=com.azure.resourcemanager.cognitiveservices   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/cognitiveservices/resource-manager/readme.md
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [POM][Skip] pom already has module sdk/cognitiveservices
cmderr	[generate.py] 2021-02-22 05:34:46 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-cognitiveservices [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-02-22 05:37:43 DEBUG Got artifact_id: azure-resourcemanager-cognitiveservices
cmderr	[Inst] 2021-02-22 05:37:43 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-02-22 05:37:43 DEBUG Got artifact: azure-resourcemanager-cognitiveservices-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-02-22 05:37:43 DEBUG Got artifact: azure-resourcemanager-cognitiveservices-1.0.0-beta.1.jar
cmderr	[Inst] 2021-02-22 05:37:43 DEBUG Match jar package: azure-resourcemanager-cognitiveservices-1.0.0-beta.1.jar
cmderr	[Inst] 2021-02-22 05:37:43 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13066/azure-sdk-for-java/azure-resourcemanager-cognitiveservices/azure-resourcemanager-cognitiveservices-1.0.0-beta.1.jar\" -o azure-resourcemanager-cognitiveservices-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-cognitiveservices -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-cognitiveservices-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4151fbc. 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/mgmt/2017-04-18/cognitiveservices [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Field `ActionRequired` of struct `PrivateLinkServiceConnectionState` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New struct `AccountSkuChangeInfo`
info	[Changelog] - New field `QnaAzureSearchEndpointID` in struct `AccountAPIProperties`
info	[Changelog] - New field `QnaAzureSearchEndpointKey` in struct `AccountAPIProperties`
info	[Changelog] - New field `Etag` in struct `PrivateEndpointConnection`
info	[Changelog] - New field `IsMigrated` in struct `AccountProperties`
info	[Changelog] - New field `SkuChangeInfo` in struct `AccountProperties`
info	[Changelog] - New field `ActionsRequired` in struct `PrivateLinkServiceConnectionState`
info	[Changelog]
info	[Changelog] Total 1 breaking change(s), 6 additive change(s).
info	[Changelog]
    • ️✔️preview/cognitiveservices/mgmt/2016-02-01-preview/cognitiveservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 4151fbc. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/resource-manager/readme.md
    • ️✔️@azure/arm-cognitiveservices [View full logs]  [Release SDK Changes] 
      cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/cognitiveServicesManagementClient.js → ./dist/arm-cognitiveservices.js...
cmderr	[npmPack] created ./dist/arm-cognitiveservices.js in 333ms
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 4151fbc. 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] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-mgmt-cognitiveservices [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model PrivateEndpointConnection has a new parameter etag
info	[Changelog]   - Model PrivateLinkServiceConnectionState has a new parameter actions_required
info	[Changelog]   - Model CognitiveServicesAccountApiProperties has a new parameter qna_azure_search_endpoint_id
info	[Changelog]   - Model CognitiveServicesAccountApiProperties has a new parameter qna_azure_search_endpoint_key
info	[Changelog]   - Model CognitiveServicesAccountProperties has a new parameter is_migrated
info	[Changelog]   - Model CognitiveServicesAccountProperties has a new parameter sku_change_info
info	[Changelog]   - Model CognitiveServicesAccountProperties has a new parameter date_created
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model PrivateLinkServiceConnectionState no longer has parameter action_required
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details.

    @openapi-workflow-bot
    Copy link

    Hi @yangyuan, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @yangyuan
    Copy link
    Member Author

    S360 item https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=CDC57F4F-3EFE-44A5-8423-399BF057716E
    It supposed to be actionsRequired in the beginning, but mislead by samples. It was also fixed in common types , https://github.com/Azure/azure-rest-api-specs/commits/master/specification/common-types/resource-management/v1/privatelinks.json

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Feb 19, 2021
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Feb 19, 2021
    Closed
    This was referenced Feb 19, 2021
    Closed
    Closed
    Closed
    @lirenhe lirenhe added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 22, 2021
    @lirenhe lirenhe merged commit 4151fbc into Azure:master Feb 22, 2021
    This was referenced Feb 22, 2021
    Closed
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    This was referenced Feb 25, 2021
    Merged
    Closed
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @yangyuan @mkarmark
    [Cognitive Services] change PEC actionRequired to actionsRequired (Az…
    861db4c 
    …ure#13066)
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @lirenhe lirenhe lirenhe approved these changes

    Assignees

    @lirenhe lirenhe

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go CI-BreakingChange-Python FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @yangyuan @lirenhe