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

update 2022-08-03 with change that went into 2022-03-03 #23823

Conversation

grizzlytheodore
Copy link
Member

@grizzlytheodore grizzlytheodore commented May 5, 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, @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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 5, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    communityGallery.json 2022-03-03(bc46f18) 2022-03-03(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.1.2) new version base version
    package-2022-11-01 package-2022-11-01(bc46f18) package-2022-11-01(feature/cplat-2022-08-03)
    package-2022-09-04 package-2022-09-04(bc46f18) package-2022-09-04(feature/cplat-2022-08-03)
    package-2022-03-03 package-2022-03-03(bc46f18) package-2022-03-03(feature/cplat-2022-08-03)

    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L37
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L79
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'galleryImageVersionName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L124
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L172
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ResourceNameRestriction The resource name parameter 'publicGalleryName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ResourceNameRestriction The resource name parameter 'galleryImageName' should be defined with a 'pattern' restriction.
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L217
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L44
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L44
    ⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
    Location: GalleryRP/stable/2022-03-03/communityGallery.json#L44
    ️⚠️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-2022-08-03
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️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 May 5, 2023

    Swagger Generation Artifacts

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

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

    ️⚠️SDK Breaking Change Tracking warning [Detail]

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

    ️❌ azure-sdk-for-net-track2 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 succeeded [Detail] [Expand]

    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-resource-manager-schemas warning [Detail]

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

    ️❌ azure-powershell failed [Detail]

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

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 5, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Swagger Microsoft.Compute https://apiview.dev/Assemblies/Review/ab2e3727542440ae85eac457648c5b73
    Go sdk/resourcemanager/compute/armcompute https://apiview.dev/Assemblies/Review/7aad00b2a8de4159aa0f13ce2e838f8a
    Java azure-resourcemanager-compute-generated https://apiview.dev/Assemblies/Review/51eff62c75c847f0b817f1fed4e849c1
    JavaScript @azure/arm-compute https://apiview.dev/Assemblies/Review/9e13a86c20e24a9496b0b3a820650f5a

    @grizzlytheodore
    Copy link
    Member Author

    closing. pursuing different fixes that does not involve swagger change

    @grizzlytheodore
    Copy link
    Member Author

    reopening. it is updated in 2022-03-03 version here #23820

    @grizzlytheodore grizzlytheodore changed the title fix update 2022-08-03 with change that went into 2022-03-03 May 17, 2023
    @grizzlytheodore
    Copy link
    Member Author

    will not be having SDK PR because it is being added here: Azure/azure-sdk-for-net#36025

    @ghost
    Copy link

    ghost commented Jun 4, 2023

    Hi, @grizzlytheodore. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Jun 4, 2023
    @ghost ghost closed this Jun 19, 2023
    @ghost
    Copy link

    ghost commented Jun 19, 2023

    Hi, @grizzlytheodore. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants