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

Fix incorrect description prefix #18849

Merged
merged 1 commit into from
May 12, 2022
Merged

Fix incorrect description prefix #18849

merged 1 commit into from
May 12, 2022

Conversation

matanpa
Copy link
Contributor

@matanpa matanpa commented Apr 28, 2022

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 - fix typos in description of multiple files across versions
  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 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 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-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.

️⚠️LintDiff: 5447 Warnings warning [Detail]
The following errors/warnings are introduced by current PR:

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

Rule Message
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/AuthConfigs.json#L119
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/AuthConfigs.json#L180
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/ContainerApps.json#L148
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/ContainerApps.json#L209
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L137
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/preview/2022-01-01-preview/SourceControls.json#L205
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/AuthConfigs.json#L119
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/AuthConfigs.json#L180
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L148
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/ContainerApps.json#L209
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L137
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.App/stable/2022-03-01/SourceControls.json#L205
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L19
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L54
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L92
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L130
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L170
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L226
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L266
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L323
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L368
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L415
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L478
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L525
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L589
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L637
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L685
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L724
⚠️ R2023 - SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L772


The following errors/warnings exist before current PR submission:

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

Rule Message
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2019-08-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2020-06-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2020-09-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2020-10-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2020-12-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.CertificateRegistration/stable/2021-01-01/AppServiceCertificateOrders.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2019-08-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2020-06-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2020-09-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2020-10-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2020-12-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.DomainRegistration/stable/2021-01-01/Domains.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2019-08-01/AppServiceEnvironments.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2019-08-01/AppServicePlans.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'DeletedWebApps_List'
Location: Microsoft.Web/stable/2019-08-01/DeletedWebApps.json#L19
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Provider_GetAvailableStacks'
Location: Microsoft.Web/stable/2019-08-01/Provider.json#L19
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Provider_GetAvailableStacksOnPrem'
Location: Microsoft.Web/stable/2019-08-01/Provider.json#L99
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2019-08-01/Recommendations.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2019-08-01/ResourceProvider.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2019-08-01/WebApps.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-06-01/AppServiceEnvironments.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-06-01/AppServicePlans.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'DeletedWebApps_List'
Location: Microsoft.Web/stable/2020-06-01/DeletedWebApps.json#L19
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Provider_GetAvailableStacks'
Location: Microsoft.Web/stable/2020-06-01/Provider.json#L19
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Provider_GetAvailableStacksOnPrem'
Location: Microsoft.Web/stable/2020-06-01/Provider.json#L99
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-06-01/Recommendations.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-06-01/ResourceProvider.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-06-01/WebApps.json#L17
D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
Location: Microsoft.Web/stable/2020-09-01/AppServiceEnvironments.json#L17
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️🔄ModelValidation inProgress [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️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.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Apr 28, 2022

Swagger Generation Artifacts

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

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

️❌SDK Breaking Change Tracking failed [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-go succeeded [Detail] [Expand]

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

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

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

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

️❌ azure-resource-manager-schemas failed [Detail]

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.

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

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

Posted by Swagger Pipeline | How to fix these errors?

@ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Apr 28, 2022
@ghost
Copy link

ghost commented Apr 28, 2022

Thank you for your contribution matanpa! We will review the pull request and get back to you soon.

@openapi-workflow-bot
Copy link

Hi @matanpa, 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
Copy link
Member

I am probably not able to merge due to too many changed files causing CI problem.

@weidongxu-microsoft
Copy link
Member

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented May 5, 2022

Hi @naveedaz @solankisamir

Would you double check the fix on description is OK for your RP?
Basically, the PR only correct the description e.g. from "Description for Get all apps for a subscription." to "Get all apps for a subscription."

@matanpa
Copy link
Contributor Author

matanpa commented May 9, 2022

Hi @weidongxu-microsoft ,
It'd be very difficult to go over all changes one by one, as there are ~5.4k changed lines.
However, the regex I used for the replacement is quite straightforward and I consider it safe -
search for: /"summary": "(.*)",([\n\r\s]+)"description": "Description for \1"/
replace with: "summary": "$1",$2"description": "$1"
i.e., whenever the description matches the summary exactly with the addition of a "Description for" prefix, remove the prefix.
This produced changes in 165 files, and on top of those I added 3 files that I verified manually (and had the same issue basically, only without having a summary prop altogether).

Bottom line - given that going through every changed line is impractical, I have enough confidence in the correctness of the change. Please let me know what you think.

@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented May 9, 2022

@matanpa

Yes, I think your PR is correct. I just want the owner of these RPs (App, WebApp, etc.) be aware of the change. But if they do not reply for some time (may be a few more days), I will probably just go on with the merge.

@akning-ms Let me know if you have better idea.

@weidongxu-microsoft weidongxu-microsoft merged commit eb2b882 into Azure:main May 12, 2022
This was referenced May 12, 2022
FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-ModelValidation CI-BreakingChange-JavaScript CI-FixRequiredOnFailure customer-reported Issues that are reported by GitHub users external to the Azure organization.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants