azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Added optional deliveryReportTimeoutInSeconds to smsSendOptions.
Data Plane API - Pull Request
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.
- Link to API Spec engagement record issue: https://github.com/Azure/azure-rest-api-specs/issues/27068
Is this review for (select one):
- [ ] a private preview
- [x] a public preview
- [ ] GA release
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.
- Design Document:
- Previous API Spec Doc: SMS GA https://github.com/Azure/azure-rest-api-specs/blob/main/specification/communication/data-plane/Sms/stable/2021-03-07/communicationservicessms.json.
- Updated paths:
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 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.
- 💬 Teams Channel
Click here for links to tools, specs, guidelines & other good stuff
Tooling
- Open API validation tools were run on this PR. Go here to see how to fix errors
- Spectral Linting
- Open API Hub
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.fix https://github.com/Azure/azure-rest-api-specs/issues/27068
PR validation pipeline started successfully. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
PR validation pipeline started successfully. This comment will be populated with the 'Swagger Validation Report'
PR validation pipeline started successfully. This comment will be populated with the 'Swagger Generation Artifacts' report
PR validation pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Hi, @besh2014. 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.
![microsoft-github-policy-service[bot] avatar](https://avatars.githubusercontent.com/in/95686?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @besh2014. 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.
Hi, @besh2014. 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.
Hi, @besh2014. 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.
Hi, @besh2014. 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.
Next Steps to Merge
✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 1 Errors, 5 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| communicationservicessms.json | 2024-02-05-preview(ab5ea5b) | 2021-03-07(main) |
| communicationservicessms.json | 2024-02-05-preview(ab5ea5b) | 2024-01-14-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
|
The new version has a different format than the previous one. New: Sms/preview/2024-02-05-preview/communicationservicessms.json#L178:9 Old: Sms/stable/2021-03-07/communicationservicessms.json#L171:9 |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-sms-2024-02-05-preview | package-sms-2024-02-05-preview(ab5ea5b) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: ListInOperationName | Since operation response has model definition in array type, it should be of the form '_list'. Location: Sms/preview/2024-02-05-preview/communicationservicessms.json#L21 |
| :warning: PaginationResponse | Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Sms/preview/2024-02-05-preview/communicationservicessms.json#L21 |
| :warning: DefaultResponse | Operation is missing a default response. Location: Sms/preview/2024-02-05-preview/communicationservicessms.json#L56 |
| :warning: LroHeaders | A 202 response should include an Operation-Location response header. Location: Sms/preview/2024-02-05-preview/communicationservicessms.json#L57 |
| :warning: EnumInsteadOfBoolean | 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: Sms/preview/2024-02-05-preview/communicationservicessms.json#L96 |
| :warning: PropertyDescription | Property should have a description. Location: Sms/preview/2024-02-05-preview/communicationservicessms.json#L153 |
| :warning: EnumInsteadOfBoolean | 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: Sms/preview/2024-02-05-preview/communicationservicessms.json#L191 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️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
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Swagger | communication-data-plane-Sms | https://apiview.dev/Assemblies/Review/2fc171f07b82439ebbe8dbb544a705fb?revisionId=33464227a11140cda4d671c9f9e37c83 |
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Azure's versioning policy requires that any change to a GA or public preview API version, breaking or not, be made in a new api-version.
Please create a new api-version for this change.
@mikekistler Thanks. Added new version.
@jhendrixMSFT do I understand right that you are the assigned person who is in charge to merge the pr to master? if yes, could you please merge, thank you.