Skip to content

Conversation

@MahmoudYounes
Copy link
Contributor

Changelog

  1. What's the purpose of the update?
    • Fixes bug in issue 18041
    • Fixes typo in parameter for issue 12601
  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. 11/2/2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. (11/2/2021)
  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, @MahmoudYounes 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 8, 2021

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/0dfd246b3a54a8358016728bd95e0b6b568f3027/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/LUIS/Authoring/preview/v3.0/LUIS-Authoring.json",
    "details":"Error: Found circular allOf reference: #/definitions/CompositeEntityExtractor-> #/definitions/EntityModelInfo\n at ResolveSwagger.checkCircularAllOf (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.8.6/node_modules/@azure/oad/dist/lib/util/resolveSwagger.js:237:23)\n at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.8.6/node_modules/@azure/oad/dist/lib/util/resolveSwagger.js:249:22\n at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:158:40\n at Object.exports.fold (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:138:18)\n at exports.forEach (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:158:13)\n at Object.forEach ("
    Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/0dfd246b3a54a8358016728bd95e0b6b568f3027/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json",
    "details":"Error: Found circular allOf reference: #/definitions/CompositeEntityExtractor-> #/definitions/EntityModelInfo\n at ResolveSwagger.checkCircularAllOf (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.8.6/node_modules/@azure/oad/dist/lib/util/resolveSwagger.js:237:23)\n at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@azure/oad@0.8.6/node_modules/@azure/oad/dist/lib/util/resolveSwagger.js:249:22\n at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:158:40\n at Object.exports.fold (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:138:18)\n at exports.forEach (/home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@ts-common/iterator@0.3.6/node_modules/@ts-common/iterator/dist/index.js:158:13)\n at Object.forEach ("
    ️️✔️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: 23 Errors, 14 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'HierarchicalEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'CompositeEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'ClosedListEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'PrebuiltEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'CustomPrebuiltModel' inherits 'IntentClassifier' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'CustomPrebuiltModel' inherits 'EntityExtractor' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'CustomPrebuiltModel' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'EntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'RegexEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_2_0",
    "details":"Schema 'PatternAnyEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    ️️✔️[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 8, 2021

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs]Release - Generate from e775182. 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
      Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
      HttpError: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
          at /home/vsts/work/1/a/unified-pipeline-runtime/common/temp/node_modules/.pnpm/@octokit/request@5.4.9/node_modules/@octokit/request/dist-node/index.js:66:23
          at processTicksAndRejections (internal/process/task_queues.js:93:5)
          at async workflowPkgUpdatePR (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:305:21)
          at async Object.exports.workflowPkgMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflowPackage.js:40:5)
          at async workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:171:9)
          at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
          at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
          at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:18:20
    • ️✔️cognitiveservices/v2.0/luis/authoring [View full logsBreaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Type of `LabelExampleResponse.ExampleID` has been changed from `*int32` to `*int64`
      info	[Changelog]
      info	[Changelog] Total 1 breaking change(s), 0 additive change(s).
      info	[Changelog]
      error	Fatal error: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
      error	The following packages are still pending:
      error		cognitiveservices/v2.0/luis/authoring
      error		preview/cognitiveservices/v3.0/luis/authoring
    • ️✔️preview/cognitiveservices/v3.0/luis/authoringBreaking Change Detected
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from e775182. 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
      cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!
      warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
    • ️✔️azure-cognitiveservices-language-luis [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from e775182. 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/data-plane/LUIS/Authoring/readme.md
    • ️✔️@azure/cognitiveservices-luis-authoring [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/lUISAuthoringClient.js → ./dist/cognitiveservices-luis-authoring.js...
      cmderr	[npmPack] created ./dist/cognitiveservices-luis-authoring.js in 771ms
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @ghost
    Copy link

    ghost commented Feb 8, 2021

    CLA assistant check
    All CLA requirements met.

    @MahmoudYounes
    Copy link
    Contributor Author

    @jhendrixMSFT any ideas why I am not authorized to merge this PR?

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    3 participants