Release communication rooms 2024-04-15 stable version#28124
Merged
Conversation
mikehang-msft
requested review from
DominikMe and
tg-msft
and removed request for
a team
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.5) | new version | base version |
|---|---|---|
| communicationservicesrooms.json | 2024-04-15(9b86e3a) | 2023-06-14(main) |
| communicationservicesrooms.json | 2024-04-15(9b86e3a) | 2023-10-30-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-rooms-2024-04-15 | package-rooms-2024-04-15(9b86e3a) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L28 |
|
| Using post for a create operation is discouraged. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L51 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L132 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L182 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L238 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L284 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L338 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L409 |
|
| Schema should have a description or title. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L431 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L509 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Rooms/stable/2024-04-15/communicationservicesrooms.json#L594 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Expected type but found type object Url: Rooms/stable/2024-04-15/communicationservicesrooms.json#L358:22 ExampleUrl: stable/2024-04-15/examples/Participants_Update.json#L18:16 |
|
Expected type but found type object Url: Rooms/stable/2024-04-15/communicationservicesrooms.json#L358:22 ExampleUrl: stable/2024-04-15/examples/Participants_Update.json#L18:16 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
BreakingChangeReviewRequired
paolamvhz
approved these changes
Mar 12, 2024
mikekistler
approved these changes
Mar 22, 2024
Member
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
Looks good. 👍
I flagged two small errors in examples that I think you should fix, but otherwise this all looks good for GA.
Comment on lines
+425
to
+426
| }, | ||
| "rawId3": null |
Member
There was a problem hiding this comment.
null is not a "ParticipantProperties" object so this part of the example is invalid. Probably best to remove it.
Suggested change
| }, | |
| "rawId3": null | |
| } |
Contributor
Author
There was a problem hiding this comment.
Thank you Mike. We use null to remove the entry in the PATCH operation. However, it does not make sense in the create scenario here. I am gong to remove it.
Comment on lines
+568
to
+569
| }, | ||
| "rawId3": null |
Member
There was a problem hiding this comment.
Here too, null is an invalid example of "ParticipantProperties" so it should be removed.
Suggested change
| }, | |
| "rawId3": null | |
| } |
Contributor
Author
There was a problem hiding this comment.
In PATCH operation, we use null to remove the entry from the collection.
* Used latest common specification (2023-11-15) * Corrected path in Readme.md * Corrected tag value in Readme
mikekistler
added
the
BreakingChange-Approved-Previously
Member
|
Breaking changes reviewed and approved in #25451 |
mikekistler
requested review from
JeffreyRichter
and removed request for
tg-msft
JeffreyRichter
approved these changes
Mar 22, 2024
mikekistler
added
the
APIStewardshipBoard-SignedOff
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Added a new release for communication rooms 2024-04-15 stable version. This release is based on the 2023-10-30-preview release. There is no additional changes besides the API version.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
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 ApiViewcomment 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
Swagger-Suppression-Process
to get approval.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
Checks stuck in `queued` state?
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.