Skip to content

AzureStack Admin API - Update RP APIs#17659

Merged
jianyexi merged 17 commits intoAzure:mainfrom
LingyunSu:AzsUpdateImpNewAPI
Feb 23, 2022
Merged

AzureStack Admin API - Update RP APIs#17659
jianyexi merged 17 commits intoAzure:mainfrom
LingyunSu:AzsUpdateImpNewAPI

Conversation

@LingyunSu
Copy link
Contributor

@LingyunSu LingyunSu commented Feb 3, 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
  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.
    03/2022

  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    03/2022

  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
      -[X] 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-workflow-bot
Copy link

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

    Swagger pipeline can not start as the pull request has merge conflicts.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    @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-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 3, 2022
    @openapi-workflow-bot
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 6 Errors, 9 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    R4009 - RequiredReadOnlySystemData The response of operation:'UpdateLocations_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L62
    R4009 - RequiredReadOnlySystemData The response of operation:'UpdateRuns_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L68
    R4009 - RequiredReadOnlySystemData The response of operation:'UpdateRuns_GetTopLevel' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L161
    R4009 - RequiredReadOnlySystemData The response of operation:'Updates_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L65
    R4017 - TopLevelResourcesListBySubscription The top-level resource 'UpdateLocation' does not have list by subscription operation, please add it.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L105
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Update.Admin/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Update.json#L19
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'UpdateRuns_Rerun' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L206
    ⚠️ R2010 - LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L109
    ⚠️ R2010 - LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L155
    ⚠️ R2010 - LongRunningOperationsOptionsValidator A LRO Post operation with return schema must have 'x-ms-long-running-operation-options' extension enabled.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L201
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'updateRuns' with immediate parent 'Update', must have a list by immediate parent operation.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L255
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'updateRuns' with immediate parent 'UpdateLocation', must have a list by immediate parent operation.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L255
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'updates' with immediate parent 'UpdateLocation', must have a list by immediate parent operation.
    Location: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L249
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get the list of update runs.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L117
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get an update run.
    Location: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L162
    ️⚠️Avocado: 2 Warnings warning [Detail]
    Rule Message
    ⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
    readme: azsadmin/resource-manager/update/readme.md
    json: Microsoft.Update.Admin/stable/2021-07-01/Updates.json
    ⚠️ CIRCULAR_REFERENCE The JSON file has a circular reference.
    readme: azsadmin/resource-manager/update/readme.md
    json: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json
    ️❌~[Staging] ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    API Readiness check failed. Please make sure your service is deployed. "code: AuthorizationFailed,
    message: The client '0a32c980-8601-446c-843e-9411a8f586c7' with object id '0a32c980-8601-446c-843e-9411a8f586c7' does not have authorization to perform action 'Microsoft.Update.Admin/operations/read' over scope '/providers/Microsoft.Update.Admin' or the scope is invalid. If access was recently granted,
    please refresh your credentials."
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️❌Cross-Version Breaking Changes: 31 Errors, 8 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:

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

    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Update.Admin/updateLocations/{updateLocation}/updates/{updateName}/Apply' removed or restructured?
    Old: Microsoft.Update.Admin/preview/2016-05-01/Updates.json#L97:5
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'SubscriptionIdParameter' removed or renamed?
    New: azure-rest-api-specs/blob/38e6cfd012ff06f42cefefc8930be6b01949918b/revision:251:2
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L138:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
    New: azure-rest-api-specs/blob/38e6cfd012ff06f42cefefc8930be6b01949918b/revision:251:2
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L138:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L224:3
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateLocations.json#L165:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L366:3
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L335:3
    1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
    New: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L441:3
    Old: Microsoft.Update.Admin/preview/2016-05-01/Updates.json#L253:3
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/Update.json#L43:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L49:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L94:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L55:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L106:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L148:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L196:11
    1011 - AddingResponseCode The new version adds a response code '202'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L238:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L244:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L52:11
    1011 - AddingResponseCode The new version adds a response code 'default'.
    New: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L100:11
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/Update.json#L31:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L31:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: common-types/resource-management/v2/types.json#L657:5
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L146:5
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L31:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateLocations.json#L31:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateLocations.json#L73:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateLocations.json#L67:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: common-types/resource-management/v2/types.json#L657:5
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L146:5
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L31:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L31:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L79:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L73:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L127:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L115:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L172:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L154:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/UpdateRuns.json#L217:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json#L193:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: common-types/resource-management/v2/types.json#L657:5
    Old: Microsoft.Update.Admin/preview/2016-05-01/Update.json#L146:5
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L31:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/Updates.json#L31:9
    1027 - DefaultValueChanged The new version has a different default value than the previous one.
    New: Microsoft.Update.Admin/stable/2021-07-01/Updates.json#L76:9
    Old: Microsoft.Update.Admin/preview/2016-05-01/Updates.json#L70:9
    ️️✔️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 Feb 3, 2022

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

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

    @LingyunSu LingyunSu marked this pull request as ready for review February 4, 2022 23:13
    @bganapa bganapa changed the title Azs update imp new api AzureStack Admin API - Update RP APIs Feb 5, 2022
    @bganapa
    Copy link
    Member

    bganapa commented Feb 7, 2022

    @ArcturusZhang This is azure stack admin API . These APIs are not shipped in azure. We generate only powershell for these APIs. The SDK validation pipeline is still running(and stuck) as part of PR checks. We do not have any tags in the readme.md for SDK generation. Could you pls check why it is still running? Thank you!

    @LingyunSu
    Copy link
    Contributor Author

    @bganapa , this liner error is:

    "readme":"azsadmin/resource-manager/update/readme.md",
    "tag":"package-2021-07-01",
    "details":"Error: Could not read 'file:///home/vsts/work/1/azure-rest-api-specs/specification/azsadmin/resource-manager/update/$%28this-folder%29/definitions/hybrid-2019-03-01.md'."

    I don't think there is a real liner error here. let's sync up...

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 7, 2022
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 7, 2022
    @jianyexi
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    LingyunSu and others added 7 commits February 11, 2022 08:26
    Invalid yaml
    
    Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com>
    Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com>
    @jianyexi jianyexi merged commit 49b541e into Azure:main Feb 23, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    * Copy of previous API v2016-05-01
    
    * URP api 2021-07-01
    
    * Update examples
    
    * Validation issue fix
    
    * validateion fix
    
    * validation fix
    
    * Add API 2021-07-01 as stable version
    
    * Update readme for new api
    
    * New api in readme
    
    * Config fix
    
    * Remove input-file
    
    Invalid yaml
    
    Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com>
    
    * Correct reference readme.md
    
    Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com>
    
    * Fix validation errors
    
    * Fix validation
    
    * Validate fix
    
    * update validateion fix
    
    * Refactoring
    
    Co-authored-by: JianyeXi <59603451+jianyexi@users.noreply.github.com>
    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 Approved-LintDiff ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    5 participants