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 specs for new operation descriptions #27641

Merged
merged 5 commits into from
Feb 3, 2024
Merged

Update specs for new operation descriptions #27641

merged 5 commits into from
Feb 3, 2024

Conversation

markcowl
Copy link
Member

@markcowl markcowl commented Feb 3, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

Click here to see the details of Step 1

Breaking changes review (Diagram Step 1)

If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:

  • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
  • You believe there is no need for you to request breaking change approval, for any reason.
    Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2

ARM API changes review (Diagram Step 2)

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented Feb 3, 2024

PR validation pipeline restarted successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

Copy link

openapi-pipeline-app bot commented Feb 3, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
azurelargeinstance.json 2023-07-20-preview(e156123) 2023-07-20-preview(main)
CommunityTrainings.json 2023-11-01(e156123) 2023-11-01(main)
fleets.json 2022-09-02-preview(e156123) 2022-09-02-preview(main)
fleets.json 2023-03-15-preview(e156123) 2023-03-15-preview(main)
fleets.json 2023-06-15-preview(e156123) 2023-06-15-preview(main)
fleets.json 2023-08-15-preview(e156123) 2023-08-15-preview(main)
fleets.json 2023-10-15(e156123) 2023-10-15(main)
containerstorage.json 2023-07-01-preview(e156123) 2023-07-01-preview(main)
devopsinfrastructure.json 2023-12-13-preview(e156123) 2023-12-13-preview(main)
openapi.json 2023-10-04-preview(e156123) 2023-10-04-preview(main)
iotoperationsmq.json 2023-10-04-preview(e156123) 2023-10-04-preview(main)
openapi.json 2023-10-04-preview(e156123) 2023-10-04-preview(main)
astronomer.json 2023-08-01-preview(e156123) 2023-08-01-preview(main)
networkfunction.json 2023-05-15-preview(e156123) 2023-05-15-preview(main)
networkanalytics.json 2023-11-15(e156123) 2023-11-15(main)
playwrighttesting.json 2023-10-01-preview(e156123) 2023-10-01-preview(main)
playwrighttesting.json 2024-02-01(e156123) 2024-02-01(main)
TrafficController.json 2023-11-01(e156123) 2023-11-01(main)
azuresphere.json 2022-09-01-preview(e156123) 2022-09-01-preview(main)
azuresphere.json 2024-04-01(e156123) 2024-04-01(main)
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Feb 3, 2024

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-python-track2 warning [Detail]

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

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

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

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

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

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

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

️❌ azure-resource-manager-schemas failed [Detail]

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

️⚠️ azure-powershell 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 warning [Detail]

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

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Feb 3, 2024

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/azurelargeinstance/armazurelargeinstance https://apiview.dev/Assemblies/Review/c41d6d45c1284dfd892c80db3be3c3d2?revisionId=3ede6003a5b349c391989a2e4aece673
Go sdk/resourcemanager/communitytraining/armcommunitytraining https://apiview.dev/Assemblies/Review/02dcd5af255f4cfca8eb28ab70d61371?revisionId=e4afa8accaf54a91b76bf5c753ee049c
.Net Azure.ResourceManager.Sphere There is no API change compared with the previous version
Java azure-resourcemanager-azurelargeinstance https://apiview.dev/Assemblies/Review/0f795dfbb34e498cad950c8391031ce0?revisionId=9225fa6bd73d4eb49b8db70fff049a1f
Java azure-resourcemanager-communitytraining https://apiview.dev/Assemblies/Review/fb3e327d4fb34e07a0a634d523eb4df4?revisionId=86d14074014d4e219ee3a824cb1ddc45
Java azure-resourcemanager-containerservicefleet There is no API change compared with the previous version
Java azure-resourcemanager-devopsinfrastructure https://apiview.dev/Assemblies/Review/43a6bc3c665749fea7eb1ea191b80cc4?revisionId=0b55a98bc0204660a04b353372a8f09c
Java azure-resourcemanager-mpcnetworkfunction https://apiview.dev/Assemblies/Review/e7c38bf431484aceb0e8b6d4f8141c87?revisionId=bc68e2b9620b4fc6bb2218d9e3c6a163
JavaScript @azure/arm-communitytraining https://apiview.dev/Assemblies/Review/5fdf37b655e743bebdd7b56e6f719664?revisionId=5d2bdaf91d924cc0afc849c4ea4fd2a0
JavaScript @azure/arm-containerservicefleet There is no API change compared with the previous version
JavaScript @azure/arm-devopsinfrastructure https://apiview.dev/Assemblies/Review/16bd85170f8c4709a8821d4b9e0360ab?revisionId=dbba41bb1020478ea537201c14893181
JavaScript @azure/arm-mobilecore https://apiview.dev/Assemblies/Review/bb0e0d4a1916407d98334f72edfeaccc?revisionId=19114a7314a64f11b627100e58ea46e5
JavaScript @azure/arm-networkanalytics There is no API change compared with the previous version
JavaScript @azure/arm-sphere https://apiview.dev/Assemblies/Review/9c655bf2b3d8400383c9456ca67f6db6?revisionId=d78f47034d284aada7a81f94592784b6
Swagger Astronomer.Astro Create ApiView timeout. Package is too large and we cannot create ApiView for it.
Swagger Microsoft.AzureLargeInstance https://apiview.dev/Assemblies/Review/0b699a8ffc604c059db1d2965bf3c943?revisionId=4c7922c8153241f4b9c633e945c636af
Swagger Microsoft.AzurePlaywrightService https://apiview.dev/Assemblies/Review/39085ca5f9b54ca18e7d6b912ff27b2b?revisionId=ff76e6da0a0e4b0fa6f7cb2fcea5c680
Swagger Microsoft.Community https://apiview.dev/Assemblies/Review/0ca4f35809684c4c8755217ecd2906e2?revisionId=87689568612b4fad96343f40b95b12fd
Swagger Microsoft.ContainerService https://apiview.dev/Assemblies/Review/71d5cd3d2d1c46b59eabc692899ea0b4?revisionId=08a3381ec9f041dd96de2d2c543b2183
Swagger Microsoft.DevOpsInfrastructure https://apiview.dev/Assemblies/Review/5503da2bc39e4df4b4a419137c02a85d?revisionId=777c531e65ac47a89f3dec39a8e255b3
Swagger Microsoft.IoTOperationsDataProcessor https://apiview.dev/Assemblies/Review/4c14b9fea00f41ebaa8e06e2cd702011?revisionId=be1b5feda1e641a5b53aa5c9e289784b
Swagger Microsoft.IoTOperationsMQ https://apiview.dev/Assemblies/Review/076ffc382c7341ec8c744c44decfa8fb?revisionId=b8dd694c76854cd2903f9d7e1f3fe1fe
Swagger Microsoft.IoTOperationsOrchestrator https://apiview.dev/Assemblies/Review/7bfbaf540c6e4b108fecc3fc426fb82b?revisionId=b29f17e8e054495ca368acd413ec466d
Swagger Microsoft.MobilePacketCore https://apiview.dev/Assemblies/Review/33ce627f4eed4e3291c2aec5553b5597?revisionId=cae2da4739544426ae835afcb489838a
Swagger Microsoft.NetworkAnalytics https://apiview.dev/Assemblies/Review/079b278f8f41483588d2f918354bd237?revisionId=657ae3e73890444d98eac089b0fbef02
Swagger Microsoft.ServiceNetworking https://apiview.dev/Assemblies/Review/59e6a96ee55f492a9e95b2ff409f02da?revisionId=e8f6dcb0aabd466bb6c4e3a6ab294d46

Copy link

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

This was referenced Feb 3, 2024
@markcowl
Copy link
Member Author

markcowl commented Feb 3, 2024

/azp run

1 similar comment
@mikeharder
Copy link
Member

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

1 similar comment
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@markcowl markcowl merged commit 1640091 into Azure:typespec-next Feb 3, 2024
21 of 28 checks passed
mikeharder added a commit that referenced this pull request Feb 5, 2024
mikeharder added a commit that referenced this pull request Feb 6, 2024
mikeharder added a commit that referenced this pull request Feb 6, 2024
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.

3 participants