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

Feature/cplat 2021 10 01 #17548

Merged
merged 14 commits into from
Feb 9, 2022
Merged

Feature/cplat 2021 10 01 #17548

merged 14 commits into from
Feb 9, 2022

Conversation

grizzlytheodore
Copy link
Member

@grizzlytheodore grizzlytheodore commented Jan 28, 2022

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

PR for gallery 2021-10-01 version

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you 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.

grizzlytheodore and others added 12 commits October 22, 2021 15:29
* update new api version branch with base

* change 2021-10-03 to 2021-10-01
* update new api version branch with base

* change 2021-10-03 to 2021-10-01
* add new api version 2020-09-30 for gallery.json

* add support for api change, sharing profile related

* update, change post to patch

* fix model validation error

* fix typo

* add shared gallery api

* update

* fix typo

* update

* update

* update

* chagne new api version to preview

* update readme.md and nit

* remove some required field and make groups readonly

* add swagger support for Grace's and Tim's work

* error fix

* error fix

* change api version name to 2020-09-30 withour 'preview'

* update

* fix typo

* address pr comment

* set modelAsString to true for gallery sharing-related enum

* update, fix merge

* remove duplicate entry

* shared gallery, change id to identifier.uniqueId

* fix typo

* update, remove x-ms-azure-resource for shared gallery

* change name of Permissions to avoid SDK code build error

* update

* add new line

* correct reset

* update

* save

* update

* fix

* update

* update

* update

* resolve CI error

* update
* added target extended locations to the caps gallery schema and added an example file

* fixed a comma

* Update readme.md

* Rename specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery/CreateOrUpdateASimpleGalleryImageVersionWithTargetExtendedLocations.json to specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/examples/gallery/CreateOrUpdateASimpleGalleryImageVersionWithTargetExtendedLocations.json

* Update readme.md

* update

* address comment

* resolve CI

Co-authored-by: Andrew Sager <asager@microsoft.com>
Co-authored-by: Theodore Chang <thchan@microsoft.com>
@openapi-workflow-bot
Copy link

Hi, @grizzlytheodore Thanks for your PR. I am workflow bot for review process. Here are some small tips.

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

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

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

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

    @ghost ghost added the Compute label Jan 28, 2022
    @openapi-pipeline-app
    Copy link

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 28, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️🔄LintDiff inProgress [Detail]
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/compute/resource-manager/readme.md
    tag: specification/compute/resource-manager/readme.md#tag-package-2021-11-01
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️Cross-Version Breaking Changes: 4 Warnings warning [Detail]
    The following breaking changes are detected by comparison with the latest stable version:
    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Compute/stable/2021-10-01/gallery.json#L2582:9
    Old: Microsoft.Compute/stable/2021-07-01/gallery.json#L2401:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Compute/stable/2021-10-01/gallery.json#L2595:5
    Old: Microsoft.Compute/stable/2021-07-01/gallery.json#L2414:5


    The following breaking changes are detected by comparison with latest preview version:

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Compute/stable/2021-10-01/gallery.json#L2582:9
    Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2358:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Compute/stable/2021-10-01/gallery.json#L2595:5
    Old: Microsoft.Compute/preview/2020-09-30/gallery.json#L2371:5
    ️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 28, 2022

    Swagger Generation Artifacts

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

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

    ️❌SDK Breaking Change Tracking failed [Detail]

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

    ️❌ azure-sdk-for-net failed [Detail]

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

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

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

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

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

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

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

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

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

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

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

    ️⚠️ azure-resource-manager-schemas warning [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

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

    @@ -0,0 +1,323 @@
    {
    "parameters": {
    "subscriptionId": "{subscription-id}",
    Copy link

    Choose a reason for hiding this comment

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

    Can you explain how this works with the targetExtendedLocation ?

    Looks like you create the resource and the targetExtendedLocations automatically get set as per this example. Also rather than using the extendedlocation name can you consider using the extendedlocation resourceid instead ?

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    @raosuhas Not sure I understand your question correctly here. 'targetExtendedLocations' is used just like 'targetRegions', so it is not automatically set, it is from user input, user needs to input extendedLocation which is edgeZone alongside with 'targetRegions'.

    It has a legit payload:
    "targetExtendedLocations": [
    {
    "name": "West US",
    "extendedLocation": {
    "name": "microsoftlosangeles1",
    "type": "EdgeZone"
    },
    "encryption": {
    "osDiskImage": {
    "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet"
    },
    "dataDiskImages": [
    {
    "lun": 0,
    "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myWestUSDiskEncryptionSet"
    }
    ]
    },
    "storageAccountType": "StandardSSD_LRS(default)",
    "extendedLocationReplicaCount": 1
    },
    {
    "name": "East US",
    "extendedLocation": {
    "name": "microsoftnewyork1",
    "type": "EdgeZone"
    },
    "encryption": {
    "osDiskImage": {
    "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet"
    },
    "dataDiskImages": [
    {
    "lun": 0,
    "diskEncryptionSetId": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSet/myEastUSDiskEncryptionSet"
    }
    ]
    },
    "storageAccountType": "StandardSSD_LRS(default)",
    "extendedLocationReplicaCount": 1
    }
    ],

    @raosuhas raosuhas added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Feb 1, 2022
    @grizzlytheodore
    Copy link
    Member Author

            "modelAsString": false
    

    modelasstring must be set to true

    Refers to: specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery.json:2624 in 43f30d1. [](commit_id = 43f30d1, deletion_comment = False)

    addressed

    @grizzlytheodore
    Copy link
    Member Author

    @raosuhas thank you for your review. We've addressed your comments. Please see.

    @grizzlytheodore
    Copy link
    Member Author

    @raosuhas please review

    @pilor pilor self-requested a review February 7, 2022 19:52
    @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 ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Feb 7, 2022
    @grizzlytheodore
    Copy link
    Member Author

    @ArcturusZhang please review/merge !

    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @ArcturusZhang ArcturusZhang merged commit 11df602 into main Feb 9, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    * Feature/cplat 2021 10 03 (Azure#16512)
    
    * update new api version branch with base
    
    * change 2021-10-03 to 2021-10-01
    
    * Update readme.md
    
    * fix folder structure
    
    * add community gallery
    
    * Feature/cplat 2021 10 03 (Azure#16512)
    
    * update new api version branch with base
    
    * change 2021-10-03 to 2021-10-01
    
    * Update readme.md
    
    * fix folder structure
    
    * add community gallery
    
    * remove sharedGallery and communityGallery
    
    * Gallery 10-01 change (community gallery, CVM) (Azure#16824)
    
    * add new api version 2020-09-30 for gallery.json
    
    * add support for api change, sharing profile related
    
    * update, change post to patch
    
    * fix model validation error
    
    * fix typo
    
    * add shared gallery api
    
    * update
    
    * fix typo
    
    * update
    
    * update
    
    * update
    
    * chagne new api version to preview
    
    * update readme.md and nit
    
    * remove some required field and make groups readonly
    
    * add swagger support for Grace's and Tim's work
    
    * error fix
    
    * error fix
    
    * change api version name to 2020-09-30 withour 'preview'
    
    * update
    
    * fix typo
    
    * address pr comment
    
    * set modelAsString to true for gallery sharing-related enum
    
    * update, fix merge
    
    * remove duplicate entry
    
    * shared gallery, change id to identifier.uniqueId
    
    * fix typo
    
    * update, remove x-ms-azure-resource for shared gallery
    
    * change name of Permissions to avoid SDK code build error
    
    * update
    
    * add new line
    
    * correct reset
    
    * update
    
    * save
    
    * update
    
    * fix
    
    * update
    
    * update
    
    * update
    
    * resolve CI error
    
    * update
    
    * Edge zone (Azure#17097)
    
    * added target extended locations to the caps gallery schema and added an example file
    
    * fixed a comma
    
    * Update readme.md
    
    * Rename specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/gallery/CreateOrUpdateASimpleGalleryImageVersionWithTargetExtendedLocations.json to specification/compute/resource-manager/Microsoft.Compute/stable/2021-10-01/examples/gallery/CreateOrUpdateASimpleGalleryImageVersionWithTargetExtendedLocations.json
    
    * Update readme.md
    
    * update
    
    * address comment
    
    * resolve CI
    
    Co-authored-by: Andrew Sager <asager@microsoft.com>
    Co-authored-by: Theodore Chang <thchan@microsoft.com>
    
    * save (Azure#17600)
    
    Co-authored-by: kangsun-ctrl <69279251+kangsun-ctrl@users.noreply.github.com>
    Co-authored-by: Andrew Sager <asager@microsoft.com>
    @JackTn JackTn deleted the feature/cplat-2021-10-01 branch June 16, 2022 00:49
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go-V2 CI-FixRequiredOnFailure Compute
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants