-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Service Bus and EventHub : 2021-06-01-preview - Added optional Properties #15233
Conversation
Hi, @v-Ajnava Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json#L37 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L37 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L85 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/listKeys' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L234 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName}/regenerateKeys' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L282 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName}/authorizationRules/{authorizationRuleName}/ListKeys' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L545 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/authorizationRules/{authorizationRuleName}/ListKeys' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/AuthorizationRules.json#L865 |
R3021 - PathResourceTypeNameCamelCase |
Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/CheckNameAvailability' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/CheckNameAvailability.json#L37 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.EventHub/preview/2021-06-01-preview/disasterRecoveryConfigs.json#L217 |
R4011 - DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.ServiceBus/preview/2021-06-01-preview/DisasterRecoveryConfig.json#L217 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L214 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L204 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L214 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L204 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L363 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L353 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L363 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L353 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L363 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L353 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L363 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: resource-manager/common/v1/definitions.json#L353 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.EventHub/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.EventHub/preview/2021-06-01-preview/operations.json#L37 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ServiceBus/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ServiceBus/preview/2021-06-01-preview/operations.json#L37 |
R4037 - MissingTypeObject |
The schema 'EHNamespaceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L578 |
R4037 - MissingTypeObject |
The schema 'EHNamespace' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L594 |
R4037 - MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L609 |
R4037 - MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L732 |
R4037 - MissingTypeObject |
The schema 'Encryption' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L787 |
R4037 - MissingTypeObject |
The schema 'KeyVaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2021-06-01-preview/namespaces-preview.json#L817 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 0 Warnings warning [Detail]
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"eventhub/resource-manager/readme.md",
"tag":"package-2021-06-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"eventhub/resource-manager/readme.md",
"tag":"package-2021-06-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
"readme":"servicebus/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"Schema 'SqlRuleAction' has a property 'sqlExpression' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction" |
|
"readme":"servicebus/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"Schema 'SqlRuleAction' has a property 'compatibilityLevel' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction" |
|
"readme":"servicebus/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"Schema 'SqlRuleAction' has a property 'requiresPreprocessing' that is already declared the parent schema 'Action' but isn't significantly different. The property has been removed from SqlRuleAction" |
|
💬 AutorestCore/Exception | "readme":"eventhub/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"servicebus/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"servicebus/resource-manager/readme.md", "tag":"package-2021-06-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
Hi @v-Ajnava, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
NewApiVersionRequired reason: |
@@ -248,15 +248,11 @@ | |||
"intervalInSeconds": { | |||
"format": "int32", | |||
"type": "integer", | |||
"maximum": 900, | |||
"minimum": 60, | |||
"description": "The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds" | |||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-Ajnava The description also needs to be either removed or changed
...ation/eventhub/resource-manager/Microsoft.EventHub/preview/2021-06-01-preview/eventhubs.json
Show resolved
Hide resolved
@@ -652,8 +652,6 @@ | |||
"maximumThroughputUnits": { | |||
"format": "int32", | |||
"type": "integer", | |||
"maximum": 20, | |||
"minimum": 0, | |||
"description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" | |||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-Ajnava The description also needs to be either removed or changed
...ation/servicebus/resource-manager/Microsoft.ServiceBus/preview/2021-06-01-preview/Rules.json
Show resolved
Hide resolved
@@ -336,9 +336,6 @@ | |||
"compatibilityLevel": { | |||
"format": "int32", | |||
"type": "integer", | |||
"default": 20, | |||
"minimum": 20, | |||
"maximum": 20, | |||
"description": "This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20." | |||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-Ajnava Also for eventhubs since this is removed, would there be new examples reflecting the new change or thats optional?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its optional and we don't have min/max in examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as recommended, removed min/max and description will have the range.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. We need to update the descriptions by removing the information related to maximum limits.
Hi, @v-Ajnava. 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 |
@PhoenixHe-TSP please merge the PR |
…Added optional Properties (#1873) Create to sync Azure/azure-rest-api-specs#15233 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/eventhub?expand=1)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.