EventHub 2024-05-01-preview #28450
Merged
EventHub 2024-05-01-preview #28450
Conversation
This file contains 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
…o the 2024-05-01-preview
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.7) | new version | base version |
|---|---|---|
| ApplicationGroups.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| ApplicationGroups.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| AuthorizationRules.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| AuthorizationRules.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| AvailableClusterRegions-preview.json | 2024-05-01-preview(1954910) | 2021-11-01(main) |
| AvailableClusterRegions-preview.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| CheckNameAvailability.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| CheckNameAvailability.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| Clusters-preview.json | 2024-05-01-preview(1954910) | 2021-11-01(main) |
| Clusters-preview.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| SchemaRegistry.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| SchemaRegistry.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| consumergroups.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| consumergroups.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| disasterRecoveryConfigs.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| disasterRecoveryConfigs.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| eventhubs.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| eventhubs.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| namespaces.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| networkrulessets-preview.json | 2024-05-01-preview(1954910) | 2021-11-01(main) |
| networkrulessets-preview.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| operations.json | 2024-05-01-preview(1954910) | 2024-01-01(main) |
| operations.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
| quotaConfiguration-preview.json | 2024-05-01-preview(1954910) | 2021-11-01(main) |
| quotaConfiguration-preview.json | 2024-05-01-preview(1954910) | 2023-01-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 33 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-2024-05-preview | package-2024-05-preview(1954910) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 30 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'Clusters_ListAvailableClusterRegion' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L38 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L49 |
||
| Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L78 |
||
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.EventHub/preview/2024-05-01-preview/AvailableClusterRegions-preview.json#L91 |
RPC-Put-V1-14 | |
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L49 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L88 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L130 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L170 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L232 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L291 |
||
| Based on the response model schema, operation 'Clusters_ListNamespaces' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L326 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L331 |
||
| 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: Microsoft.EventHub/preview/2024-05-01-preview/Clusters-preview.json#L424 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L345 |
||
| Use the latest version v5 of types.json. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L385 |
||
| Schema should have a description or title. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L989 |
||
| Schema should have a description or title. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L998 |
||
The service-defined (reserved name) resource 'default' should be represented as a path parameter enum with modelAsString set to true.Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L37 |
RPC-ConstrainedCollections-V1-04 | |
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L49 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L98 |
||
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L128 |
RPC-Get-V1-11 | |
| Based on the response model schema, operation 'Namespaces_ListNetworkRuleSet' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L129 |
||
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L140 |
||
| 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: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L209 |
||
| 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: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L222 |
||
| Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L238 |
||
| Missing identifier id in array item property Location: Microsoft.EventHub/preview/2024-05-01-preview/networkrulessets-preview.json#L245 |
||
| A nested resource type's List operation must include all the parent segments in its api path. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L37 |
RPC-Get-V1-11 | |
| The response of operation:'Configuration_Patch' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L38 |
||
| 'PATCH' operation 'Configuration_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.EventHub/preview/2024-05-01-preview/quotaConfiguration-preview.json#L42 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Tracked resource 'Eventhub' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2024-05-01-preview/eventhubs.json#L309 |
|
System data references must utilize common types. Location: Microsoft.EventHub/preview/2024-05-01-preview/eventhubs.json#L400 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.EventHub/preview/2024-05-01-preview/eventhubs.json#L474 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L119 |
|
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L172 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L178 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L187 |
|
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L216 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L225 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L274 |
|
Synchronous PATCH operations must have responses with 200 and default return codes. They also must not have other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L274 |
|
Properties of a PATCH request body must not have default value, property:publicNetworkAccess. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L296 |
|
Properties of a PATCH request body must not have default value, property:keySource. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L296 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L296 |
|
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L321 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
|
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L444 |
|
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L487 |
|
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L493 |
|
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L497 |
|
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L499 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L511 |
|
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L546 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L555 |
|
provisioningState property must be set to readOnly. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L598 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L612 |
|
x-ms-pageable extension must be specified for LIST APIs.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L657 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L685 |
|
The resource name parameter 'resourceAssociationName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2024-05-01-preview/namespaces.json#L698 |
️❌Avocado: 5 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventHub/namespaces/{}/ipfilterrules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventhub/resource-manager/readme.md json: Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventHub/namespaces/{}/ipfilterrules/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventhub/resource-manager/readme.md json: Microsoft.EventHub/preview/2018-01-01-preview/ipfilterrules-preview.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.EventHub/sku/{}/regions is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventhub/resource-manager/readme.md json: Microsoft.EventHub/preview/2018-01-01-preview/sku.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventHub/namespaces/{}/virtualnetworkrules is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventhub/resource-manager/readme.md json: Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.EventHub/namespaces/{}/virtualnetworkrules/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/eventhub/resource-manager/readme.md json: Microsoft.EventHub/preview/2018-01-01-preview/virtualnetworkrules-preview.json |
️️✔️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
|
Generated ApiView
|
This was referenced Mar 26, 2024
schaudhari6254888
requested review from
v-Ajnava,
dsouzaarun and
damodaravadhani
as code owners
AzureRestAPISpecReview
added
ARMReview
WaitForARMFeedback
|
There are a bunch of breaking changes reported on this PR. Please get a breaking changes approval from Azure Breaking Changes Reviewers azbreakchangereview@microsoft.com and ARM can review the changes afterwards. Once you have the approval, please remove the "ARMChangesRequested" label from the PR to make the PR visible to the ARM reviewers. |
ms-henglu
added
the
ARMChangesRequested
|
Please address or respond to feedback from the ARM API reviewer. |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
schaudhari6254888
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
gary-x-li
reviewed
Apr 10, 2024
| } | ||
| } | ||
| }, | ||
| "x-ms-long-running-operation": true |
There was a problem hiding this comment.
Can you also add x-ms-long-running-operation-options to indicate which header to use? This applies to all other occurrences.
gary-x-li
reviewed
Apr 10, 2024
| } | ||
| } | ||
| }, | ||
| "patch": { |
There was a problem hiding this comment.
Also add x-ms-long-running-operation and x-ms-long-running-operation-options?
There was a problem hiding this comment.
They don't seem to be added under patch.
There was a problem hiding this comment.
Hey @gary-x-li ,this change is causing too much CI checks failed because previous swagger of a namespace doesn't have this x-ms-long-running-operation property
https://github.com/schaudhari6254888/azure-rest-api-specs/blob/716b241d1cc21b7830b7d5bfaa605d85501668f0/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json#L265
Can you pls approve is this change is not very concerning, this PR is blocking future SDK release.
gary-x-li
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
schaudhari6254888
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
gary-x-li
added
the
ARMChangesRequested
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
/azp run |
|
Azure Pipelines successfully started running 4 pipeline(s). |
schaudhari6254888
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
gary-x-li
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
gary-x-li
approved these changes
Apr 12, 2024
tjprescott
pushed a commit
that referenced
this pull request
Apr 17, 2024
* Base Check-In: Copying latest api version 2023-01-01-Preview folder to the 2024-05-01-preview * renaming 2023-01-01-preview to 2024-05-01-preview * New Updates * Readme Updates * Updates * Updates * Updates * update * Updates * Updates * Updates * Updates * namespace-preview renamed to namespaces.json * Removed Preview naming * Reverse the changes Removed Preview naming * Updates * updates * LintDiff suppression * LintDiff suppression2 * LintDiff suppression3 * LintDiff suppression4 * LintDiff suppression6 * Updates * X-MS-Long added in Patch * X-MS-Long added in Patch * removed X-MS-Long added in Patch
wiboris
pushed a commit
to wiboris/azure-rest-api-specs
that referenced
this pull request
May 7, 2024
* Base Check-In: Copying latest api version 2023-01-01-Preview folder to the 2024-05-01-preview * renaming 2023-01-01-preview to 2024-05-01-preview * New Updates * Readme Updates * Updates * Updates * Updates * update * Updates * Updates * Updates * Updates * namespace-preview renamed to namespaces.json * Removed Preview naming * Reverse the changes Removed Preview naming * Updates * updates * LintDiff suppression * LintDiff suppression2 * LintDiff suppression3 * LintDiff suppression4 * LintDiff suppression6 * Updates * X-MS-Long added in Patch * X-MS-Long added in Patch * removed X-MS-Long added in Patch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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.
Click here to see the details of Step 1, Breaking Changes review
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
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!
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:
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 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
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.