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

Cdn swagger 2021 06 01 fix #17278

Merged
merged 30 commits into from
Jan 14, 2022
Merged

Cdn swagger 2021 06 01 fix #17278

merged 30 commits into from
Jan 14, 2022

Conversation

ChenglongLiu
Copy link
Member

@ChenglongLiu ChenglongLiu commented Jan 7, 2022 •
edited
Loading

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 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:

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.

markcowl and others added 22 commits August 21, 2019 19:39
@markcowl
Add blockchain to latest profile
1bcc20d
@markcowl
Add additional types
7b46097
Merge branch 'main' of https://github.com/Azure/azure-rest-api-specs …
5dbb091 
…into cdn-swagger-2021-06-01-fix
[CDN] Fix incorrect type for compressionSettings and SharedPrivateLin…
e1600f7 
…kResourceProperties
@ChenglongLiu
Merge pull request #1 from t-bzhan/cdn-swagger-2021-06-01-fix
d8ac4f9 
[CDN] Fix incorrect type for compressionSettings and SharedPrivateLinkkResourceProperties
Update SecurityPolicy patch operation
b2a85ff
Update SecurityPolicy patch operation
36c88c1
Update SecurityPolicy patch operation
ff473fa
Update SecurityPolicy patch operation
85c0a16
Update SecurityPolicy patch operation
9f1b614
Update SecurityPolicy patch operation
3b76a49
Update SecurityPolicy patch operation
aea71be
Update SecurityPolicy patch operation
ddb3135
Update SecurityPolicy patch operation
de5976b
Update SecurityPolicy patch operation
d390ac7
@ChenglongLiu
Merge pull request #2 from ChenglongLiu/chenglong/fix
898caaf 
Update SecurityPolicy patch operation
Removing originResponseTimeoutSeconds from endpoint level
c3d298d
@sinadell
Merge pull request #3 from ChenglongLiu/users/sinadell/originswaggerfix
0aaeb49 
Removing originResponseTimeoutSeconds from endpoint level
Fix the afdendpoint example
f79d3b4
@ChenglongLiu
Merge pull request #4 from ChenglongLiu/chenglong/fixTimeoutExample
06ffa40 
Fix the afdendpoint example
Fix the cacheDuration format
f82cdc7
@ChenglongLiu
Merge pull request #5 from ChenglongLiu/chenglong/fixDurationFormat
4234b85 
Fix the cacheDuration format
@openapi-workflow-bot
Copy link

Hi, @ChenglongLiu 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-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 7, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 16 Errors, 5 Warnings failed [Detail]
    Rule Message
    ❌ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'SecurityPolicyParameters' removed or renamed?
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L3906:3
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L3906:3
    ❌ 1009 - RemovedRequiredParameter The required parameter 'securityPolicyProperties' was removed in the new version.
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L2858:11
    ❌ 1010 - AddingRequiredParameter The required parameter 'securityPolicyUpdateProperties' was added in the new version.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L2858:11
    ❌ 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4793:9
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4733:9
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'originResponseTimeoutSeconds' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4376:7
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4355:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'originResponseTimeoutSeconds' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4421:7
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4400:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2477:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2472:7
    ❌ 1040 - AddedReadOnlyPropertyInResponse The new version has a new read-only property 'kind' in response that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2456:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2456:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'userAssignedIdentities' in response that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2519:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2519:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'transforms' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4188:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4135:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'transforms' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4080:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4034:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'transforms' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L4026:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3987:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'transforms' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3980:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3948:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'transforms' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3931:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L3906:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'userAssignedIdentities' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2519:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2519:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'kind' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2456:7
    Old: Microsoft.Cdn/stable/2021-06-01/cdn.json#L2456:7
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4223:9
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4223:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4229:5
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4229:5
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4290:5
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4269:5

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Cdn/stable/2020-09-01/afdx.json#L4779:9
    Old: Microsoft.Cdn/stable/2020-09-01/afdx.json#L4779:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Cdn/stable/2020-09-01/afdx.json#L4779:9
    Old: Microsoft.Cdn/stable/2020-09-01/afdx.json#L4779:9
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️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.
    ️️✔️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 Jan 7, 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 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 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-js warning [Detail]

    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.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @ChenglongLiu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    Chenglong Liu and others added 2 commits January 10, 2022 16:19
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 10, 2022
    @ArcturusZhang ArcturusZhang merged commit c3cf8a3 into Azure:main Jan 14, 2022
    This was referenced Jan 14, 2022
    Closed
    Closed
    Closed
    Merged
    Closed
    Closed
    Closed
    @ChenglongLiu ChenglongLiu deleted the cdn-swagger-2021-06-01-fix branch January 19, 2022 06:12
    mstrisoline pushed a commit to mstrisoline/azure-rest-api-specs that referenced this pull request Feb 1, 2022
    @ChenglongLiu @markcowl
    @sinadell @ajbrown821 @mstrisoline
    Cdn swagger 2021 06 01 fix (Azure#17278)
    05d8f92 
    * Add blockchain to latest profile

* Add additional types

* [CDN] Fix incorrect type for compressionSettings and SharedPrivateLinkResourceProperties

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Removing originResponseTimeoutSeconds from endpoint level

* Fix the afdendpoint example

* Fix the cacheDuration format

* Adding user assigned identity to managed identity

* Fix the typo and example

* Fix OBJECT_ADDITIONAL_PROPERTIES

* Revert responseBasedAFDOriginErrorDetectionSettings

Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Co-authored-by: Chenglong Liu <chengll@microsoft.com>
Co-authored-by: Bo Zhang <bzhan@microsoft.com>
Co-authored-by: SINADELL <SINADELL@SINADELL-DEV7>
Co-authored-by: Sindhuri <sindhuri.nadella@gmail.com>
Co-authored-by: AJ Brown <ajbrown@microsoft.com>
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    @ChenglongLiu @markcowl
    @sinadell @ajbrown821 @LeiWang3
    Cdn swagger 2021 06 01 fix (Azure#17278)
    24df104 
    * Add blockchain to latest profile

* Add additional types

* [CDN] Fix incorrect type for compressionSettings and SharedPrivateLinkResourceProperties

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Update SecurityPolicy patch operation

* Removing originResponseTimeoutSeconds from endpoint level

* Fix the afdendpoint example

* Fix the cacheDuration format

* Adding user assigned identity to managed identity

* Fix the typo and example

* Fix OBJECT_ADDITIONAL_PROPERTIES

* Revert responseBasedAFDOriginErrorDetectionSettings

Co-authored-by: Mark Cowlishaw <markcowl@microsoft.com>
Co-authored-by: Chenglong Liu <chengll@microsoft.com>
Co-authored-by: Bo Zhang <bzhan@microsoft.com>
Co-authored-by: SINADELL <SINADELL@SINADELL-DEV7>
Co-authored-by: Sindhuri <sindhuri.nadella@gmail.com>
Co-authored-by: AJ Brown <ajbrown@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ArcturusZhang ArcturusZhang ArcturusZhang approved these changes

    @jorinmejia jorinmejia Awaiting requested review from jorinmejia

    @t-bzhan t-bzhan Awaiting requested review from t-bzhan

    Assignees

    @ArcturusZhang ArcturusZhang

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go-V2 Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python CI-BreakingChange-Go-V2 CI-BreakingChange-JavaScript CI-FixRequiredOnFailure WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    8 participants
    @ChenglongLiu @ArcturusZhang @JeffreyRichter @dw511214992 @msyyc @markcowl @sinadell @ajbrown821