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

Add Get All Policies under Subscription in Version 2022-05-01. #22393

Conversation

neelesh06
Copy link
Contributor

@neelesh06 neelesh06 commented Jan 31, 2023

ARM API Information (Control Plane)

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

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @neelesh06 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 31, 2023

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    webapplicationfirewall.json 2022-05-01(b48f422) 2022-05-01(main)
    Rule Message
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L79:5
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-05 package-2022-05(b48f422) package-2022-05(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L86
    ⚠️ UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get all Policies in a Resource Group
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L111


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L62
    ResourceNameRestriction The resource name parameter 'policyName' should be defined with a 'pattern' restriction.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L118
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L146
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L159
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L201
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L201
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L207
    PatchSkuProperty The patch operation body parameter schema should contains property 'sku'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L240
    LroPatch202 The async patch operation should return 202.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L250
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L257
    DeleteOperationAsyncResponseValidation An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L271
    RequiredDefaultResponse The response is defined but without a default error response implementation.Consider adding it.'
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L291
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L295
    PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets'
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L310
    DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L332
    MissingTypeObject The schema 'WebApplicationFirewallPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L351
    MissingTypeObject The schema 'WebApplicationFirewallPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L374
    MissingTypeObject The schema 'WebApplicationFirewallPolicyList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L456
    MissingTypeObject The schema 'PolicySettings' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L473
    IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L504
    MissingTypeObject The schema 'CustomRuleList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L527
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L530
    MissingTypeObject The schema 'CustomRule' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L539
    IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L553
    IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L581
    IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L587
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L592
    MissingTypeObject The schema 'MatchCondition' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L621
    MissingTypeObject The schema 'ManagedRuleSetList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L694
    XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.Network/stable/2022-05-01/webapplicationfirewall.json#L697
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/frontdoor/resource-manager/readme.md
    tag: specification/frontdoor/resource-manager/readme.md#tag-package-2022-05
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 54 Errors, 0 Warnings failed [Detail]

    Tag package-2022-05; Prod region: Deployed

    Test run on region: northcentralus; Operation coverage: total: 38, untested: 0, failed: 27, passed: 11

    Service API Readiness Test failed. Check pipeline artifact for detail report.

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

    Rule Message
    CLIENT_ERROR statusCode: 400,
    errorCode: BadRequest,
    errorMessage: Invalid Resource Id provided for WebApplicationFirewallPolicy link.;
    Frontdoor location must be global.;
    Backend "10.0.1.5" has an invalid address. The address field must be an IPv4 address, IPv6 address, or fully-qualified domain name.;
    Backend hostname "10.0.1.5" is invalid. It must be a valid domain name, IP version 4, or IP version 6.
    Source: runtime
    OperationId: FrontDoors_CreateOrUpdate
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: FrontDoors_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoors/frontdoow5owmq' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: FrontDoors_Get
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: FrontDoors_Get
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoors/frontdoow5owmq' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: FrontDoors_ValidateCustomDomain
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: FrontDoors_ValidateCustomDomain
    CLIENT_ERROR statusCode: 400,
    errorCode: BadRequest,
    errorMessage: The Internet Analyzer profile did not pass validation checks.
    Source: runtime
    OperationId: NetworkExperimentProfiles_CreateOrUpdate
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: NetworkExperimentProfiles_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: NetworkExperimentProfiles_Get
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: NetworkExperimentProfiles_Get
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: NetworkExperimentProfiles_Update
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: NetworkExperimentProfiles_Update
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Experiments_CreateOrUpdate
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Experiments_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Experiments_ListByProfile
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Experiments_ListByProfile
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Experiments_Get
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Experiments_Get
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/networkExperimentProfiles/profilen8atv7h' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Experiments_Update
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Experiments_Update
    CLIENT_ERROR statusCode: 400,
    errorCode: LocationRequired,
    errorMessage: The location property is required for this definition.
    Source: runtime
    OperationId: Policies_CreateOrUpdate
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Policies_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoorWebApplicationFirewallPolicies/policynaph41da' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Policies_Get
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Policies_Get
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoorWebApplicationFirewallPolicies/policynaph41da' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: Policies_Update
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: Policies_Update
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoors/frontdoow5owmq' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: RulesEngines_CreateOrUpdate
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: RulesEngines_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: ResourceNotFound,
    errorMessage: The Resource 'Microsoft.Network/frontdoors/frontdoow5owmq' under resource group 'apiTest-MGvyUC-22393' was not found. For more details please go to https://aka.ms/ARMResourceNotFoundFix
    Source: runtime
    OperationId: RulesEngines_ListByFrontDoor
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: error
    Source: response
    OperationId: RulesEngines_ListByFrontDoor
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 31, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking




    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b228c00. 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
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.3 -> 9.4.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.4.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-frontdoor [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation PoliciesOperations.begin_update
      info	[Changelog]   - Added operation PoliciesOperations.list_by_subscription
      info	[Changelog]   - Model FrontDoor has a new parameter extended_properties
      info	[Changelog]   - Model FrontDoorProperties has a new parameter extended_properties
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b228c00. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/frontdoor/armfrontdoor [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New value `ActionTypeAnomalyScoring` added to type alias `ActionType`
      info	[Changelog] - New value `FrontDoorResourceStateMigrated`, `FrontDoorResourceStateMigrating` added to type alias `FrontDoorResourceState`
      info	[Changelog] - New function `*PoliciesClient.NewListBySubscriptionPager(*PoliciesClientListBySubscriptionOptions) *runtime.Pager[PoliciesClientListBySubscriptionResponse]`
      info	[Changelog] - New function `*PoliciesClient.BeginUpdate(context.Context, string, string, TagsObject, *PoliciesClientBeginUpdateOptions) (*runtime.Poller[PoliciesClientUpdateResponse], error)`
      info	[Changelog] - New struct `DefaultErrorResponse`
      info	[Changelog] - New struct `DefaultErrorResponseError`
      info	[Changelog] - New struct `PoliciesClientListBySubscriptionResponse`
      info	[Changelog] - New struct `PoliciesClientUpdateResponse`
      info	[Changelog] - New field `ExtendedProperties` in struct `Properties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 14 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b228c00. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-frontdoor [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation Policies.beginUpdate
      info	[Changelog]   - Added operation Policies.beginUpdateAndWait
      info	[Changelog]   - Added operation Policies.listBySubscription
      info	[Changelog]   - Added Interface DefaultErrorResponse
      info	[Changelog]   - Added Interface DefaultErrorResponseError
      info	[Changelog]   - Added Interface PoliciesListBySubscriptionNextOptionalParams
      info	[Changelog]   - Added Interface PoliciesListBySubscriptionOptionalParams
      info	[Changelog]   - Added Interface PoliciesUpdateOptionalParams
      info	[Changelog]   - Added Type Alias PoliciesListBySubscriptionNextResponse
      info	[Changelog]   - Added Type Alias PoliciesListBySubscriptionResponse
      info	[Changelog]   - Added Type Alias PoliciesUpdateResponse
      info	[Changelog]   - Interface FrontDoor has a new optional parameter extendedProperties
      info	[Changelog]   - Interface FrontDoorProperties has a new optional parameter extendedProperties
      info	[Changelog]   - Enum KnownActionType has a new value AnomalyScoring
      info	[Changelog]   - Enum KnownFrontDoorResourceState has a new value Migrated
      info	[Changelog]   - Enum KnownFrontDoorResourceState has a new value Migrating
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b228c00. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️frontdoor [View full logs
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 31, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/frontdoor/armfrontdoor https://apiview.dev/Assemblies/Review/3a47bcbeec414675aa355834f6d607cb
    .Net Azure.ResourceManager.FrontDoor https://apiview.dev/Assemblies/Review/339e1efe89964a99b1089af29d678f0c
    JavaScript @azure/arm-frontdoor https://apiview.dev/Assemblies/Review/3e0438bb369a4e36964d00cfaabe5a87

    @neelesh06
    Copy link
    Contributor Author

    This PR is adding the missing subscription level GET policies API. this is not changing any parameter and not touching any existing API. No breaking change for the customer. Code already support the Subscription level GET api.

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure resource-manager WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jan 31, 2023
    @openapi-workflow-bot
    Copy link

    Hi @neelesh06, 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.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @qiaozha
    Copy link
    Member

    qiaozha commented Feb 1, 2023

    @neelesh06 Could you help fix those lintDiff, semantic, model validation errors ?

    @AzureRestAPISpecReview AzureRestAPISpecReview added ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test and removed CI-FixRequiredOnFailure labels Feb 1, 2023
    @qiaozha
    Copy link
    Member

    qiaozha commented Feb 2, 2023

    @JeffreyRichter Could you help take a look at the breaking change ? Thanks

    @JeffreyRichter
    Copy link
    Member

    I see a new path being added: https://github.com/Azure/azure-rest-api-specs/pull/22393/checks?check_run_id=11055506302
    This requires a new api-version and then it will not be considered a breaking change.

    @neelesh06
    Copy link
    Contributor Author

    @JeffreyRichter here we are just adding a new missing GET API on subscription level. this API does not break any existing api's. we are not adding new parameter or adding any new value for the parameter. this API implementation is already present in the RP. This is just new api publishing. Does this still consider as breaking change. This will not affect any customer calls or any of their template.

    @JeffreyRichter
    Copy link
    Member

    Azure's formal versioning policy is that ANY change to an API contract requires a new api-version. This avoid having multiple versions of a single api-version which customers can't rationalize about.

    @neelesh06
    Copy link
    Contributor Author

    I agree on when any api contract change than it needs new api version because customers' needs to change their template and scripts. but here we are not changing any api contract. We are just adding new api (whose implementation is already present in the RP). On this change there is no effect on customer running the template or scripts. It is Subscription level get that was missed in last PR.

    @JeffreyRichter
    Copy link
    Member

    Adding a new path IS changing the contract - it now has a new path that it didn't have before.
    So, if a customer asks: Which api-version has this new path then some version of 2022-05-01 does and some version of 2022-05-01 doesn't. This is confusing for customers (and Azure Customer Support) and because we optimize for the customer experience, Azure's formal policy is to not allow this and this is why our repo tooling is flagging your PR as breaking our policy.

    @neelesh06
    Copy link
    Contributor Author

    Appreciate your time Actually this was asks from customers as well as supports that we do not have subscription level GET api in the same version (this is one of the required GET api) although we have implementation of this api in RP. If we can support this GET api in the same version, then we can avoid customers to upgrade the version and if they really need the new api then they will just add in the same version. Their existing scripts and template will not get affected. I understand that the tool is robust and check all the conditions, but can you please review this and check if this can be added in the same version?

    @JeffreyRichter
    Copy link
    Member

    You're asking me to violate azure's policy and I don't feel comfortable doing that. If the customer has to change their code to call this new path anyway, then it is trivial for them to also change the api-version.

    @neelesh06
    Copy link
    Contributor Author

    Sorry @JeffreyRichter, I am not asking to violate the policy, but this scenario is little unique where we are not changing any existing API's contract. we are only adding new API that RP already supported, and we are only publishing that to customer. I was asking to just review the swagger and scenario and see if this can qualify as non-breaking change. I talked to some of the API reviewer before raising this PR and they said this may qualify for the non-breaking change.

    @JeffreyRichter
    Copy link
    Member

    Was this path added after 2022-05-01 shipped or did 2022-05-01 ALWAYS have this path as part of it? If the former, then your service team should not have done this as this violates Azure's policy. If the latter, then the swagger should never have been published missing the path but I can approve it.

    @neelesh06
    Copy link
    Contributor Author

    @JeffreyRichter, thanks for reconsideration. We have this path available before we shipped the 2022-05-01. It was missed to add this GET API in our last publishing of swagger.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 3, 2023
    @sjanamma sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 4, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 4, 2023
    @ruowan
    Copy link
    Member

    ruowan commented Feb 8, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @qiaozha qiaozha merged commit b228c00 into Azure:main Feb 8, 2023
    ghost pushed a commit to Azure/azure-resource-manager-schemas that referenced this pull request Feb 8, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    …#22393)
    
    * Create WafListPoliciesUnderResourceGroup.json
    
    * Update webapplicationfirewall.json
    
    * Rename WafListPoliciesUnderResourceGroup.json to WafListPoliciesUnderSubscription.json
    
    * Update webapplicationfirewall.json
    
    Fixed the LintDiff error - fix https://github.com/Azure/azure-openapi-validator/blob/main/docs/default-error-response-schema.md
    Fixed the SemanticValidatiion error - fix https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#DUPLICATE_OPERATIONID
    
    * Update WafPolicyDelete.json
    
    Fixed the ModelValidation error - fix of https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/Semantic-and-Model-Violations-Reference.md#LRO_RESPONSE_HEADER
    
    * Update webapplicationfirewall.json
    
    add typeobject.
    
    * Update WafPolicyDelete.json
    
    Fix prettier check.
    
    * Update webapplicationfirewall.json
    
    Prettier fix
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    6 participants