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

Updating to fix workflow errors #19490

Merged
merged 1 commit into from
Jun 16, 2022
Merged

Updating to fix workflow errors #19490

merged 1 commit into from
Jun 16, 2022

Conversation

alexkarcher-msft
Copy link
Contributor

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

Changelog

Add a changelog entry for 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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a 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, @alexkarcher-msft 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. vscswagger@microsoft.com

    @weidongxu-microsoft
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @weidongxu-microsoft
    Copy link
    Member

    /azp run

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 16, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌LintDiff: 88 Errors, 90 Warnings failed [Detail] The following errors/warnings are introduced by current PR:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5522
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5580
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5637
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5697
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,baseAddress,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5760
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,processId,instanceId should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L5827
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,backupId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L9182
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,backupId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L9236
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,backupId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L9293
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,backupId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L9358
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,appSettingKey,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L10437
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,connectionStringKey,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L10548
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,snapshotId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11291
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,snapshotId,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11347
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,webJobName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11562
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,webJobName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11620
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,webJobName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11676
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,webJobName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11733
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,id,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L11965
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,id,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12019
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,id,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12082
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,id,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12138
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,domainOwnershipIdentifierName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12304
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,domainOwnershipIdentifierName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12358
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,domainOwnershipIdentifierName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12421
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,domainOwnershipIdentifierName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12475
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,functionName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12808
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,functionName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12866
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,functionName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12930
    ❌ R4039 - ParametersOrder The parameters:resourceGroupName,name,functionName,keyName,slot should be kept in the same order as they present in the path.
    Location: Microsoft.Web/stable/2022-03-01/WebApps.json#L12987
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 3 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: Microsoft.Web/stable/2022-03-01/CommonDefinitions.json#L2797:7
    Old: Microsoft.Web/stable/2021-03-01/CommonDefinitions.json#L2619:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: Microsoft.Web/stable/2022-03-01/WebApps.json#L26349:7
    Old: Microsoft.Web/stable/2021-03-01/WebApps.json#L23920:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: Microsoft.Web/stable/2022-03-01/WebApps.json#L27111:7
    Old: Microsoft.Web/stable/2021-03-01/CommonDefinitions.json#L2470:7
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️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 Jun 16, 2022 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-python-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-go failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-js warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-workflow-bot
    Copy link

    Hi @alexkarcher-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
     If you need further help, please feedback via swagger feedback.

    @weidongxu-microsoft weidongxu-microsoft merged commit a48ea4d into Azure:Web-ANT97-2022-03-01 Jun 16, 2022
    This was referenced Jun 16, 2022
    Closed
    Closed
    weidongxu-microsoft added a commit that referenced this pull request Jun 24, 2022
    @naveedaz @joslinmicrosoft
    @tanaybhartia @tabhar-msft @JarodAertsMs @annikel @cschen13 @JarodAertsMsft @edwin-msft @weidongxu-microsoft @jiansong-msft @dejo-msft @alexkarcher-msft
    Web ant97 2022 03 01 (#19430)
    cf35748 
    * Adds base for updating Microsoft.Web from version stable/2021-03-01 to version 2022-03-01

* Updates readme

* Updates API version in new specs and examples

* Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegis… (#18460)

* Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegistration RPs to Api-version 2022-03-01

* Add x-ms-enum for array of inline enums. Fix reference to older api version for common defs

* Add examples for App Service Certificate orders

* Add suppressions back

* Add examples for Microsoft.DomainRegistration RP

* Fixes from prettier

* Remove unused example

* Add Unhealthy CustomDomainStatus for StaticSites (#18557)

* Adding VnetRouteAllEnabled, VnetImagePullEnabled, VnetContentShareEnabled site properties to CommonDefinitions (#18627)

* Added vnet realted site properties to common definitions

* removed tab

Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com>

* Add Ftp/Remote debug properties to Ase network config (#18549)

* Add Ftp/Remote debug properties to Ase network config

* Switched changes to the right file

* Add Networking config to hosting environment creates

* Added some of the missing examples

* Remove disallowed properties from example Ase GET response

* Adjusted responses from other gets

* Added a bunch more examples

* Added other missing examples for Ase.

* Added more missing examples for Ase.

* fixed formatting

* Edit some examples, add back privatelink apis and try to supress the errors for missing examples.

* Fix suppress spelling and fix prettier

* Added missing privatelink examples since suppressing did not work

* Add Bring your own Backend operations (#18517)

* add bring your own backend operations

* add missing files

* fix json formattin

* validation fixes

* fix

* fix more validation

* fix ids

* fix model validation

* fix descriptions

* fix environmentName description

* change to 202

* revert change to 202

* customhostnamesites optional param for 2022 API version (#18670)

* fix DUPLICATE_PARAMETER

* prettier

* fix  OBJECT_ADDITIONAL_PROPERTIES

* fix random sub in examples

* add optional hostname param to customHostnameSites RT and add examples

* move changes from 2021 api version to 2022

* move examples to 2022

* Revert "add optional hostname param to customHostnameSites RT and add examples"

This reverts commit 7fc318e.

* remove examples from 2021

* fix lintDiff

* prettier fix

* model validation fix

* suppress model validation in readme

Co-authored-by: Elle Tojaroon <patojaro@microsoft.com>

* [Microsoft.Web] Add CustomDnsSuffixConfiguration to ASE (#18553)

* [Microsoft.Web] Add CustomDnsSuffixConfiguration to AppServiceEnvironments

* Add examples

* Fix style issues

* Add customdnssuffix to custom-words

* Add CustomDnsSuffixConfiguration to AppServiceEnvironment definition

* Address remaining model validation errors

* Adjusted networking configuration definitions

* Addressed Arm review feedback

Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com>

* Fork/web ant97 2022 03 01 (#19259)

* Added DeploymentStatus API specs and examples

* change status to enum, rm extra dot

* suppress missing examples for now

* rm id from List Deployment Slot examples

* rm location, and rename deploymentId in GetSiteDeploymentStatus examples

* change model as string to true, add 202 operations for DeploymentStatus ops to spec

* rename operationId to deploymentStatusId, undo deploymentId rename

* add long running op, as per linter

Co-authored-by: Shubham Dhond <shdhond@microsoft.com>
Co-authored-by: Weidong Xu <weidxu@microsoft.com>

* PublicNetworkAccess Swagger Change (#19352)

* add publicNetworkAccess property in site for swagger

* add suppression to fix Model Validation CI

* Add allowed values in the description

* Add specs for Hosting Environment Maintenance Control (#18691)

* Add documentation for Hosting Environment Maintenance Control

* Update example file name

* Make UpgradePreference non-nullable

* Correct indentation to 2 spaces

* Fix upgradePreference indentation

* Address swagger feedback. Add enums with descriptions.

* Move testNotification to request body. Update description text

* Fix testNotification

* Fix example

* Replace TestNotification parameter with TestUpgradeNotification API

* Rename to TestUpgradeAvailableNotification

* Added logic apps operations (#18604)

* Added Initial Operations and some definitions

* Adding additional objects to support Logic Apps operations

* Updated path and parameters to match testing

* Prettier Fixes

* oav validat-example fixes

* Github validation fixes

* Prettier

* Updated examples and paths

* Prettier

* Revert "Prettier"

This reverts commit da090ad.

* Prettier

* Fixed model validation errors

* Filled in nextLinkName values

* Fixing swagger lintdiff errors

* added x-ms-long-running to async calls

* Adds numberOfWorkers to app service plan (#19475)

* Adds numberOfWorkers to app service plan

* Add suppression for missing ASP examples

* Updating to fix workflow errors (#19490)

* Removed conflicting resource definition and added reference to CommonDefinitions.json (#19507)

* Removed conflicting resource definition and added reference to CommonDefinitions.json

* Updated resource to have workflow version

* Updated nextLink object to be correctly tagged (#19560)

* Updated nextLink object to be correctly tagged

* Adding value placeholder

* Updated SKU to remove conflict

* Updated x-ms-enum

* Added missing model

* Adding more missing models

* Add suppressions for missing examples (#19563)

Co-authored-by: Joseph Lin <54335291+joslinmicrosoft@users.noreply.github.com>
Co-authored-by: Tanay Bhartia <tanaybhartia@gmail.com>
Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com>
Co-authored-by: JarodAertsMs <90280240+JarodAertsMs@users.noreply.github.com>
Co-authored-by: annikel <92825476+annikel@users.noreply.github.com>
Co-authored-by: Paviya (Elle) Tojaroon <pt335@cornell.edu>
Co-authored-by: Elle Tojaroon <patojaro@microsoft.com>
Co-authored-by: Chris Chen <chrc@microsoft.com>
Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com>
Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com>
Co-authored-by: Shubham Dhond <shdhond@microsoft.com>
Co-authored-by: Weidong Xu <weidxu@microsoft.com>
Co-authored-by: jiansong-msft <77516279+jiansong-msft@users.noreply.github.com>
Co-authored-by: Derek Johnson <47129225+dejo-msft@users.noreply.github.com>
Co-authored-by: Alex Karcher <alkarche@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @weidongxu-microsoft weidongxu-microsoft weidongxu-microsoft approved these changes

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

    Assignees

    @weidongxu-microsoft weidongxu-microsoft

    Labels
    CI-BreakingChange-JavaScript CI-FixRequiredOnFailure
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @alexkarcher-msft @weidongxu-microsoft