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.

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

[text analytics] Updated HealthcareAssertion enum values to be camel cased #13361

Merged
merged 2 commits into from
Mar 16, 2021

Conversation

abhahn
Copy link
Member

@abhahn abhahn commented Mar 10, 2021

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, @abhahn 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 Mar 10, 2021

    Swagger Validation Report

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

    Rule Message
    1020 - AddedEnumValue The new version is adding enum value(s) 'hypothetical, conditional' from the old version.
    New: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L1870:9
    Old: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L1870:9
    1020 - AddedEnumValue The new version is adding enum value(s) 'positive, positivePossible, neutralPossible, negativePossible, negative' from the old version.
    New: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L1882:9
    Old: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L1882:9
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ENUM_CASE_MISMATCH Enum does not match case for: Positive
    Url: TextAnalytics/preview/v3.1-preview.4/TextAnalytics.json#L1882
    JsonUrl: preview/v3.1-preview.4/examples/SuccessfulHealthStatusRequest.json
    ️️✔️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: 1 Warnings warning [Detail]

    Rule Message
    ⚠️ PreCheck/CheckDuplicateSchemas "readme":"cognitiveservices/data-plane/TextAnalytics/readme.md",
    "tag":"release_3_1_preview.4",
    "details":"Checking for duplicate schemas,
    this could take a (long) while. Run with --verbose for more detail."
    ️️✔️[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 Mar 10, 2021

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-python failed [Detail]
    • Failed [Logs]Release - Generate from c2e50d6. 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]/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c2e50d6. 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-03-16 18:02:01 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-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2e50d6. 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/TextAnalytics/readme.md
    • ️✔️@azure/cognitiveservices-textanalytics [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/textAnalyticsClient.js → ./dist/cognitiveservices-textanalytics.js...
      cmderr	[npmPack] created ./dist/cognitiveservices-textanalytics.js in 193ms
    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs]Release - Generate from c2e50d6. 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.1/textanalytics [View full logs
      info	[Changelog] No exported changes
      error	Fatal error: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}
      error	The following packages are still pending:
      error		cognitiveservices/v2.1/textanalytics
      error		cognitiveservices/v2.0/textanalytics
    • ️✔️cognitiveservices/v2.0/textanalytics
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    ghost pushed a commit to Azure/azure-sdk-for-js that referenced this pull request Mar 11, 2021
    This change is needed to match the current service's response. The swagger is being updated in Azure/azure-rest-api-specs#13361.
    @tjprescott
    Copy link
    Member

    @lmazuel can you merge this? Confirmed that this "breaking change" is a bug fix in the Swagger, so it's really a "fixing change" :)

    @lmazuel lmazuel merged commit c2e50d6 into Azure:master Mar 16, 2021
    MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
    …cased (Azure#13361)
    
    * Updated HealthcareAssertion enum values to be camel cased
    
    * Updated an example
    
    Co-authored-by: Abby Hartman <abhahn@microsoft.com>
    jay-most pushed a commit to jay-most/azure-sdk-for-js that referenced this pull request Apr 26, 2021
    …14246)
    
    This change is needed to match the current service's response. The swagger is being updated in Azure/azure-rest-api-specs#13361.
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …cased (Azure#13361)
    
    * Updated HealthcareAssertion enum values to be camel cased
    
    * Updated an example
    
    Co-authored-by: Abby Hartman <abhahn@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants