Skip to content

[DoNotMerge] Add RepairAction to AutoRepairs feature #16534

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
Closed
frank-pang-msft wants to merge 9 commits into from
Closed

[DoNotMerge] Add RepairAction to AutoRepairs feature #16534

frank-pang-msft wants to merge 9 commits into from

Conversation

@frank-pang-msft
Copy link
Contributor

@frank-pang-msft frank-pang-msft commented Oct 25, 2021

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: add new repairAction under auto repairs feature
  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.
    • November/December timeframe
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    • Next earliest release or November
  4. If updating an existing version, please select the specific langauge 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:

  • I commit to follow the Breaking Change Policy of "no breaking changes"
    - Is this change a breaking change? I do not think so, but please let me know.
  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
    - When running prettier on all json files there were a huge list of modified files that were not related to my change so I did not push it. Is this expected?

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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.

  • 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.

Alancere and others added 9 commits October 18, 2021 14:02
@Alancere
Add track2 batch 4 mysql-->cognitiveservices (Azure#16431)
6ba37b7 
* Add track2 batch 4 mysql-->cognitiveservices

* resourcehealth-->sqlvirtualmachine
@giakas
Fix AVA 2021-11-01 example files (Azure#16432)
009e56c 
* fix examples

* fix prettier checks
@solankisamir
Api Management 2021-08-01 Stable API-VERSION (Azure#16353)
0a82306 
* Adds base for updating Microsoft.ApiManagement from version preview/2021-04-01-preview to version 2021-08-01

* Updates readme

* Updates API version in new specs and examples
@alankashiwa @alextts627
[Azure Maps] Route: Swagger improvement for SDK generation [Hub Gener…
1bee73d 
…ated] (Azure#16193)

* Route: Rename parameter/client names

* Route: Rename request body names

* Route: Model a few objects as enum

* Route: rename magnitudeOfDelay

* Route: update startPointIndex/endPointIndex docstrings

* Route: departureTime/arrivalTime to date-time

* Route: Fix name in typescript.md

* Route: modify docstrings for firstInstructionIndex/lastInstructionIndex

* Route: rename turnAngleInDecimalDegrees

* Route: Add docstrings for RouteSection/RouteLeg

* Route: rename report object

* Route: add friendly x-ms-examples key name

* Route: rearrange definitions for better review

* Route: remove language reference in hyperlink

* Route: Remove repeated descriptions of batch API

* Changed model name RouteDirectionsSummary to RouteSummary

* Rename to RouteRangeResponse

* Add max/min values for efficiency

* Name changing with x-ms-client-name

* Minor update

* Route: naming fix

* renamed all kWh to KwH

* Route: add default values

* Route: Fix wrong name

* Route: Change response type name

* Updated name and descriptions for route attributes

* Remote language in URL

* Route: definition name changed for type name

* Route: keep the operations for maintaining SDK consistencies

* Route: Change response object names

* Route: Fix parameter type

* Common: Add more definitions for better client type name

* Common: Add description for query parameter

* Route: Just rename RouteSummary Definition

* Common: Redo the naming for batchItems

* Route: add names for x-ms-enum

* Route: change all floats to doubles (verified in backend)

* Route: use collectionFormat for route range api

* Route: rename operationIds to remove Post wording

* Modified two method names

* Route: update vehicleCommericial's client name

* Route: update description/client name for carTrain

Co-authored-by: Alex Tsao <[email protected]>
Co-authored-by: Daniel Rocha <[email protected]>
@alextts627 @AlexTsao
[Azure Maps] Weather: Swagger improvement for SDK generation [Hub Gen…
929be18 
…erated] (Azure#16148)

* Modified AirQuality

* Modified AirDetails

* renaming variables for Current Condition

* 1. Rename to model to WeatherValue

2. Renamed to IconCode definition

* Rename properties to description(s) for consistency

* Rename model to weatherValueRange

* Renamed to Forecast for better self explaining

* Better naming/self explaining for values

* Update name fpr dbz

* Add enum for UnitType, PrecipitationType, IconCode

* Updated example files

* Fix CI errors

1. Add new word to avoid error checks failing
2. Updated with "x-ms-client-name" to fix CI errors

* Update according to review feedbacks

1. Removed duplicate enum attributes
2. Updated descriptions

* Update IconCode

* Update x-ms-exmaple for better description

* Update Enum

* add name for enum

* Update according to feedback

1. Update all `query` to collectionFormat
2. Set `readOnly=true` for all response
3. Create PastHoursTemperature model for opimization

* Update name

Co-authored-by: Alex Tsao <[email protected]>
@ishaydahan
[Hub Generated] Review request for Microsoft.Marketplace to add versi…
118b501 
…on stable/2021-10-01 (This is internal data plane service inside Microsoft.Marketplace RP) (Azure#16306)

* New Swagger Spec File

* New Swagger Example Spec File

* New Readme Config File

* first commit

* fix

* fix

* examples

* fix

* words

* fix

* spell

* pretty

* fix

* pretty

* fix

* comments

* spelling
@prince3332
Fix check access response (Azure#16428)
1a0701d 
* fix check access response

* Add DefinitionsPropertiesNamesCamelCase suppression role

Co-authored-by: Prince Gupta <[email protected]>
@rokulka
Move QuestionAnswering 2021-07-15-preview to main (Azure#16411)
694fe69 
* move questionAnswering 2021-07-15-preview to main

* update version in examples
@jiacheng-L
[Hub Generated] Review request for Microsoft.KeyVault to add version …
3c16aae 
…preview/2021-06-01-preview (Azure#16399)

* Bypass incompatible responses

* Add missing path

* Add version info

* Removing undesired 404
@openapi-workflow-bot
Copy link

openapi-workflow-bot bot commented Oct 25, 2021

Hi, @frank-pang-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. [email protected]

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Oct 25, 2021

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

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

    ghost commented Oct 25, 2021

    Thank you for your contribution frank-pang-msft! We will review the pull request and get back to you soon.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Oct 25, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'zTileIndex' removed or renamed?
    New: Common/preview/1.0/common.json#L530:3
    Old: Common/preview/1.0/common.json#L530:3
    ❌ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'IncludeText' removed or renamed?
    New: Common/preview/1.0/common.json#L530:3
    Old: Common/preview/1.0/common.json#L530:3
    ️⚠️LintDiff: 5 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Marketplace/stable/2021-10-01/marketplacecatalog.json#L1857
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'QuestionAnsweringProjects_DeleteProject' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Language/preview/2021-07-15-preview/questionanswering-authoring.json#L169
    ⚠️ R4020 - DescriptiveDescriptionRequired The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2021-10-01/marketplacecatalog.json#L281
    ⚠️ R4020 - DescriptiveDescriptionRequired The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2021-10-01/marketplacecatalog.json#L1104
    ⚠️ R4020 - DescriptiveDescriptionRequired The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation.
    Location: Microsoft.Marketplace/stable/2021-10-01/marketplacecatalog.json#L1806


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Feedback/preview/1.0/feedback.json#L216
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Mobility/preview/1.0/mobility.json#L1464
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Mobility/preview/1.0/mobility.json#L1491
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1813
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1855
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1878
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Route/preview/1.0/route.json#L1969
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Search/preview/1.0/search.json#L2075
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1095
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1118
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1148
    ❌ R2026 - AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
    Location: Spatial/preview/1.0/spatial.json#L1175
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'SignInSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L123
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'SignUpSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L315
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DelegationSettings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L507
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'SignInSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L218
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'SignUpSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L410
    ❌ R4009 - RequiredReadOnlySystemData The response of operation:'DelegationSettings_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimportalsettings.json#L602
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L306
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L312
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L318
    ❌ R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L324
    ❌ R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ApiManagement/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimdeployment.json#L37
    ❌ R4037 - MissingTypeObject The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38
    ❌ R4037 - MissingTypeObject The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L55
    ❌ R4037 - MissingTypeObject The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65
    ❌ R4037 - MissingTypeObject The schema 'RegionContract' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L85
    ❌ R4037 - MissingTypeObject The schema 'RegionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L103
    ❌ R4037 - MissingTypeObject The schema 'ErrorFieldContract' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L38
    ❌ R4037 - MissingTypeObject The schema 'ErrorResponseBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.ApiManagement/stable/2021-08-01/apimanagement.json#L65
    ️⚠️Avocado: 4 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/alertsmanagement/resource-manager/readme.md
    tag: specification/alertsmanagement/resource-manager/readme.md#tag-package-2019-06-preview
    ⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
    readme: specification/apimanagement/resource-manager/readme.md
    json: Microsoft.ApiManagement/stable/2021-08-01/definitions.json
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/mysql/resource-manager/readme.md
    tag: specification/mysql/resource-manager/readme.md#tag-package-2020-01-01
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/streamanalytics/resource-manager/readme.md
    tag: specification/streamanalytics/resource-manager/readme.md#tag-package-2020-03-preview
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation

    ️️✔️[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 Oct 25, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

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

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

    ️⚠️[Staging] SDK Breaking Change Tracking warning [Detail]

    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 warning [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 succeeded [Detail] [Expand]

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

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

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

    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

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

    ️⚠️ azure-resource-manager-schemas warning [Detail]

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

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

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

    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

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

    ️❌ azure-powershell failed [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    openapi-workflow-bot bot commented Oct 25, 2021

    Hi @frank-pang-msft, 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.

    This was referenced Oct 25, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    This was referenced Oct 25, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    This was referenced Oct 25, 2021
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    @frank-pang-msft
    Copy link
    Contributor Author

    frank-pang-msft commented Oct 25, 2021

    PR mistake

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

    Reviewers

    No reviews

    Assignees

    No one assigned

    Labels

    CI-BreakingChange-Go CI-BreakingChange-Python 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.

    10 participants

    @frank-pang-msft @Alancere @giakas @solankisamir @alankashiwa @alextts627 @ishaydahan @prince3332 @rokulka @jiacheng-L