Skip to content

Conversation

@ross-bryan
Copy link
Contributor

@ross-bryan ross-bryan commented Aug 30, 2022

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.
    September 7th
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    September 20th
  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, @ross-bryan Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 30, 2022

    Swagger Validation Report

    ️🔄BreakingChange inProgress [Detail]
    ️🔄Breaking Change(Cross-Version) inProgress [Detail]
    ️⌛CredScan pending [Detail]
    ️🔄LintDiff inProgress [Detail]
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️🔄ApiReadinessCheck inProgress [Detail]
    ️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]
    ️🔄~[Staging] TrafficValidation inProgress [Detail]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⌛PoliCheck pending [Detail]
    ️🔄SDK Track2 Validation inProgress [Detail]
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 30, 2022

    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-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.19.2` to update!
      cmderr	[automation_generate.sh] npm notice
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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/redhatopenshift/armredhatopenshift [View full logs]  [Preview SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*SyncSetsClient.Update(context.Context, string, string, string, SyncSetUpdate, *SyncSetsClientUpdateOptions) (SyncSetsClientUpdateResponse, error)`
      info	[Changelog] - New function `*MachinePoolsClient.Delete(context.Context, string, string, string, *MachinePoolsClientDeleteOptions) (MachinePoolsClientDeleteResponse, error)`
      info	[Changelog] - New function `*SyncSetsClient.NewListPager(string, string, *SyncSetsClientListOptions) *runtime.Pager[SyncSetsClientListResponse]`
      info	[Changelog] - New function `NewOpenShiftVersionsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*OpenShiftVersionsClient, error)`
      info	[Changelog] - New function `*SyncSetsClient.Delete(context.Context, string, string, string, *SyncSetsClientDeleteOptions) (SyncSetsClientDeleteResponse, error)`
      info	[Changelog] - New function `*SecretsClient.Update(context.Context, string, string, string, SecretUpdate, *SecretsClientUpdateOptions) (SecretsClientUpdateResponse, error)`
      info	[Changelog] - New function `*OpenShiftVersionsClient.NewListPager(string, *OpenShiftVersionsClientListOptions) *runtime.Pager[OpenShiftVersionsClientListResponse]`
      info	[Changelog] - New function `NewSecretsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SecretsClient, error)`
      info	[Changelog] - New function `NewSyncIdentityProvidersClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SyncIdentityProvidersClient, error)`
      info	[Changelog] - New function `*MachinePoolsClient.CreateOrUpdate(context.Context, string, string, string, MachinePool, *MachinePoolsClientCreateOrUpdateOptions) (MachinePoolsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*SyncIdentityProvidersClient.NewListPager(string, string, *SyncIdentityProvidersClientListOptions) *runtime.Pager[SyncIdentityProvidersClientListResponse]`
      info	[Changelog] - New function `*SyncIdentityProvidersClient.CreateOrUpdate(context.Context, string, string, string, SyncIdentityProvider, *SyncIdentityProvidersClientCreateOrUpdateOptions) (SyncIdentityProvidersClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*SyncSetsClient.CreateOrUpdate(context.Context, string, string, string, SyncSet, *SyncSetsClientCreateOrUpdateOptions) (SyncSetsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*SecretsClient.Delete(context.Context, string, string, string, *SecretsClientDeleteOptions) (SecretsClientDeleteResponse, error)`
      info	[Changelog] - New function `*MachinePoolsClient.Get(context.Context, string, string, string, *MachinePoolsClientGetOptions) (MachinePoolsClientGetResponse, error)`
      info	[Changelog] - New function `*SyncIdentityProvidersClient.Update(context.Context, string, string, string, SyncIdentityProviderUpdate, *SyncIdentityProvidersClientUpdateOptions) (SyncIdentityProvidersClientUpdateResponse, error)`
      info	[Changelog] - New function `*MachinePoolsClient.NewListPager(string, string, *MachinePoolsClientListOptions) *runtime.Pager[MachinePoolsClientListResponse]`
      info	[Changelog] - New function `*SyncIdentityProvidersClient.Delete(context.Context, string, string, string, *SyncIdentityProvidersClientDeleteOptions) (SyncIdentityProvidersClientDeleteResponse, error)`
      info	[Changelog] - New function `NewSyncSetsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SyncSetsClient, error)`
      info	[Changelog] - New function `NewMachinePoolsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*MachinePoolsClient, error)`
      info	[Changelog] - New function `*SecretsClient.CreateOrUpdate(context.Context, string, string, string, Secret, *SecretsClientCreateOrUpdateOptions) (SecretsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*SecretsClient.Get(context.Context, string, string, string, *SecretsClientGetOptions) (SecretsClientGetResponse, error)`
      info	[Changelog] - New function `*MachinePoolsClient.Update(context.Context, string, string, string, MachinePoolUpdate, *MachinePoolsClientUpdateOptions) (MachinePoolsClientUpdateResponse, error)`
      info	[Changelog] - New function `*SecretsClient.NewListPager(string, string, *SecretsClientListOptions) *runtime.Pager[SecretsClientListResponse]`
      info	[Changelog] - New function `*SyncSetsClient.Get(context.Context, string, string, string, *SyncSetsClientGetOptions) (SyncSetsClientGetResponse, error)`
      info	[Changelog] - New function `*SyncIdentityProvidersClient.Get(context.Context, string, string, string, *SyncIdentityProvidersClientGetOptions) (SyncIdentityProvidersClientGetResponse, error)`
      info	[Changelog] - New struct `MachinePool`
      info	[Changelog] - New struct `MachinePoolList`
      info	[Changelog] - New struct `MachinePoolProperties`
      info	[Changelog] - New struct `MachinePoolUpdate`
      info	[Changelog] - New struct `MachinePoolsClient`
      info	[Changelog] - New struct `MachinePoolsClientCreateOrUpdateOptions`
      info	[Changelog] - New struct `MachinePoolsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `MachinePoolsClientDeleteOptions`
      info	[Changelog] - New struct `MachinePoolsClientDeleteResponse`
      info	[Changelog] - New struct `MachinePoolsClientGetOptions`
      info	[Changelog] - New struct `MachinePoolsClientGetResponse`
      info	[Changelog] - New struct `MachinePoolsClientListOptions`
      info	[Changelog] - New struct `MachinePoolsClientListResponse`
      info	[Changelog] - New struct `MachinePoolsClientUpdateOptions`
      info	[Changelog] - New struct `MachinePoolsClientUpdateResponse`
      info	[Changelog] - New struct `OpenShiftVersion`
      info	[Changelog] - New struct `OpenShiftVersionList`
      info	[Changelog] - New struct `OpenShiftVersionProperties`
      info	[Changelog] - New struct `OpenShiftVersionsClient`
      info	[Changelog] - New struct `OpenShiftVersionsClientListOptions`
      info	[Changelog] - New struct `OpenShiftVersionsClientListResponse`
      info	[Changelog] - New struct `ProxyResource`
      info	[Changelog] - New struct `Secret`
      info	[Changelog] - New struct `SecretList`
      info	[Changelog] - New struct `SecretProperties`
      info	[Changelog] - New struct `SecretUpdate`
      info	[Changelog] - New struct `SecretsClient`
      info	[Changelog] - New struct `SecretsClientCreateOrUpdateOptions`
      info	[Changelog] - New struct `SecretsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `SecretsClientDeleteOptions`
      info	[Changelog] - New struct `SecretsClientDeleteResponse`
      info	[Changelog] - New struct `SecretsClientGetOptions`
      info	[Changelog] - New struct `SecretsClientGetResponse`
      info	[Changelog] - New struct `SecretsClientListOptions`
      info	[Changelog] - New struct `SecretsClientListResponse`
      info	[Changelog] - New struct `SecretsClientUpdateOptions`
      info	[Changelog] - New struct `SecretsClientUpdateResponse`
      info	[Changelog] - New struct `SyncIdentityProvider`
      info	[Changelog] - New struct `SyncIdentityProviderList`
      info	[Changelog] - New struct `SyncIdentityProviderProperties`
      info	[Changelog] - New struct `SyncIdentityProviderUpdate`
      info	[Changelog] - New struct `SyncIdentityProvidersClient`
      info	[Changelog] - New struct `SyncIdentityProvidersClientCreateOrUpdateOptions`
      info	[Changelog] - New struct `SyncIdentityProvidersClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `SyncIdentityProvidersClientDeleteOptions`
      info	[Changelog] - New struct `SyncIdentityProvidersClientDeleteResponse`
      info	[Changelog] - New struct `SyncIdentityProvidersClientGetOptions`
      info	[Changelog] - New struct `SyncIdentityProvidersClientGetResponse`
      info	[Changelog] - New struct `SyncIdentityProvidersClientListOptions`
      info	[Changelog] - New struct `SyncIdentityProvidersClientListResponse`
      info	[Changelog] - New struct `SyncIdentityProvidersClientUpdateOptions`
      info	[Changelog] - New struct `SyncIdentityProvidersClientUpdateResponse`
      info	[Changelog] - New struct `SyncSet`
      info	[Changelog] - New struct `SyncSetList`
      info	[Changelog] - New struct `SyncSetProperties`
      info	[Changelog] - New struct `SyncSetUpdate`
      info	[Changelog] - New struct `SyncSetsClient`
      info	[Changelog] - New struct `SyncSetsClientCreateOrUpdateOptions`
      info	[Changelog] - New struct `SyncSetsClientCreateOrUpdateResponse`
      info	[Changelog] - New struct `SyncSetsClientDeleteOptions`
      info	[Changelog] - New struct `SyncSetsClientDeleteResponse`
      info	[Changelog] - New struct `SyncSetsClientGetOptions`
      info	[Changelog] - New struct `SyncSetsClientGetResponse`
      info	[Changelog] - New struct `SyncSetsClientListOptions`
      info	[Changelog] - New struct `SyncSetsClientListResponse`
      info	[Changelog] - New struct `SyncSetsClientUpdateOptions`
      info	[Changelog] - New struct `SyncSetsClientUpdateResponse`
      info	[Changelog] - New field `SystemData` in struct `Resource`
      info	[Changelog] - New field `SystemData` in struct `TrackedResource`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 162 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. 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
    • ️✔️redhatopenshift [View full logs]  [Preview Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from e40029494a55fff992b833f8cbd7183c306d1b16. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.RedHatOpenShift [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 30, 2022

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

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

    ghost commented Aug 30, 2022

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

    @openapi-workflow-bot
    Copy link

    Hi @ross-bryan, 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

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

    @raosuhas
    Copy link

    raosuhas commented Aug 30, 2022

    Pleae follow the instructions in the checklist before sumitting the PR. This PR is not created correctly :

    image


    In reply to: 1232049880

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @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 Aug 30, 2022
    @openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 30, 2022
    @ross-bryan ross-bryan force-pushed the new-api-test branch 4 times, most recently from 45fe07a to de4e973 Compare August 31, 2022 20:29
    Copy link

    @raosuhas raosuhas Aug 31, 2022

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    get

    was this meant to be a POST ? THis current path will be interpreted by arm as a collection get for the resource. If you keep it as a GET the InstallVersions object would need to be a ARM resource. #Closed

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    we want it to be a GET request - the idea is for the ARO service to provide same command as AKS, they have az aks get-versions and we are working on implementing the az aro get-versions equivalent.

    I am trying to see more of how AKS achieved this, it looks like the endpoint for their command is as follows:

    'https://management.azure.com/subscriptions/fe16a035-e540-4ab7-80d9-373fa9a3d6ae/providers/Microsoft.ContainerService/locations/eastus/orchestrators?api-version=2019-04-01&resource-type=managedClusters'
    

    is the orchestrators an ARM resource? I see this for AKS service https://github.com/Azure/azure-rest-api-specs/blob/3ec782ff73d2c35f23978d2c6738cc9c85016531/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2022-06-01/managedClusters.json#L2699-L2703

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @raosuhas can you review my response here?

    Copy link

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    we are trying to discourage RPs from using this model

    For your scenario you can achieve pretty much the same thing by modelling this as a GET on a collection of "installVersions" i.e

    GET ...crosoft.RedHatOpenShift/locations/{location}/installversions"

    THis returns a paginated response like so : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#pagination

    and each entry of the value array is a Proxy resource of the "InstallVersion" type. The only difference from the AKS model is that each installVersion is a Proxy ARM type.

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @raosuhas I have refactored my code and api /swagger definition such that this is a GET request which returns a List of OpenShiftVersion's that are available.

    Can you please review? I do not seem to be able to edit the labels on the PR

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @ross-bryan I think @raosuhas is also suggesting changing the path to /installversions, so in this case the resource type is "InstallVersion"

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @raosuhas @leni-msft We have changed this resource path to

    GET ...crosoft.RedHatOpenShift/locations/{location}/openshiftversions"

    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 5, 2022
    @openapi-workflow-bot
    Copy link

    Hi @ross-bryan, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @leniatgh
    Copy link
    Contributor

    Thank you for the feedback. I found the code that implements CreateOperationAsyncResponseValidation, and it looks like any PUT that results in a 201 Created is considered a long running operation. To work around this, we are removing the 201 responses and will use 200 OK instead.

    @ventifus Does your service return 201? if so, you must define 201 in swagger. To workaround the lint error, we can suppress it. See https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process

    any PUT that results in a 201 Created is considered a long running operation

    +@jianyexi to check the logic

    @ventifus
    Copy link
    Contributor

    HI @leni-msft Going back to the "pattern" restrictions and the resulting breaking change, I joined the Breaking Change office hours and they advised that the requirement for pattern restrictions is just a "staging" check and that we should not implement them at this time. (Also they noted that the client does not perform validation and so the restrictions would not have any effect anyway.) I'll submit a new commit reverting the pattern restrictions.

    Regarding the 201 responses, yes we had originally designed our API to return 201 Created for PUT requests as that made the most sense. We would prefer to use 201, I will look into the suppression process.

    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 10, 2022
    @AzureRestAPISpecReview AzureRestAPISpecReview added the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 10, 2022
    @openapi-workflow-bot
    Copy link

    Hi @ross-bryan, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @AzureRestAPISpecReview AzureRestAPISpecReview removed the BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required label Oct 10, 2022
    @ventifus
    Copy link
    Contributor

    @leni-msft I have removed the pattern restrictions and restored the 201 Created responses for our PUTs. Since both of these are staging checks, do we still need to go through the swagger suppression process? The regular "Swagger LintDiff" is reporting green.

    @leniatgh
    Copy link
    Contributor

    @leni-msft I have removed the pattern restrictions and restored the 201 Created responses for our PUTs. Since both of these are staging checks, do we still need to go through the swagger suppression process? The regular "Swagger LintDiff" is reporting green.

    You're right, no need for the staging lint check.

    @jianyexi
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @ross-bryan
    Copy link
    Contributor Author

    @jianyexi @leni-msft can we get an approval here? This PR has been open for many many weeks now. We are delayed on delivering highly demanded features such as multi-version support because of this PR pending approval. Please either request changes, or grant us your blessings and approval 🙏

    @leniatgh
    Copy link
    Contributor

    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.

    Hi @ross-bryan , this PR is blocked on ARM review. I will merge this PR after ARM sign-off.

    @ventifus
    Copy link
    Contributor

    Looks like this is not getting an ARM review because it still has the tag ARMChangesRequested. I don't have permissions to remove it, @leni-msft @raosuhas can you help?

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 21, 2022
    "description": "The Syncsets properties",
    "x-ms-client-flatten": true
    },
    "systemData": {
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    systemData

    SyncSetUpdate is defined as a parameter and it doesnt make sense for paramaters to have readOnly properties

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @rkmanda It is our intention that this systemData property is the Azure system metadata. In that context, should the systemData property be omitted from the swagger entirely?
    https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-contracts.md#system-metadata-for-all-azure-resources

    Copy link
    Contributor

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I looked in the repo for other users of systemData, and our definitions seem to match theirs. Compare with adp.json DataPoolPatch and used in a PATCH method here.

    @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 Oct 21, 2022
    @ventifus ventifus mentioned this pull request Oct 24, 2022
    12 tasks
    @ventifus
    Copy link
    Contributor

    Please close this PR in favor of #21248.

    @ross-bryan ross-bryan closed this Oct 24, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview CI-FixRequiredOnFailure customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane 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.

    10 participants