update servicebus swagger required/types

[swathipil]

updating the Servicebus swagger:

• If entities exist, entity descriptions should exist/be required.
• Names of entities should be type string.

[openapi-workflow-bot]

Hi, @swathipil Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 18 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
servicebus.json	2021-05(eb864d9)	2021-05(main)

Rule	Message
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L512:7 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L509:7
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L551:11 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L544:11
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L875:11 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L864:11
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1254:11 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1239:11
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1521:11 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1494:11
❌ 1025 - RequiredStatusChange	The 'required' status changed from the old version('False') to the new version('True'). New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1928:11 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1897:11
❌ 1026 - TypeChanged	The new version has a different type 'string' than the previous one 'object'. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L520:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L517:9
❌ 1026 - TypeChanged	The new version has a different type 'string' than the previous one 'object'. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L836:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L829:9
❌ 1026 - TypeChanged	The new version has a different type 'string' than the previous one 'object'. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1215:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1204:9
❌ 1026 - TypeChanged	The new version has a different type 'string' than the previous one 'object'. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1485:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1462:9
❌ 1026 - TypeChanged	The new version has a different type 'string' than the previous one 'object'. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1892:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1865:9
❌ 1034 - AddedRequiredProperty	The new version has new required property 'type, NamespaceProperties' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L541:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L538:9
❌ 1034 - AddedRequiredProperty	The new version has new required property 'title' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L2504:13 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L2473:13
❌ 1034 - AddedRequiredProperty	The new version has new required property 'title' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L506:5 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L506:5
❌ 1034 - AddedRequiredProperty	The new version has new required property 'type, QueueDescription' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L865:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L858:9
❌ 1034 - AddedRequiredProperty	The new version has new required property 'type, TopicDescription' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1244:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1233:9
❌ 1034 - AddedRequiredProperty	The new version has new required property 'type, SubscriptionDescription' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1511:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1488:9
❌ 1034 - AddedRequiredProperty	The new version has new required property 'type, RuleDescription' that was not found in the old version. New: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1918:9 Old: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1891:9

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-2021-05	package-2021-05(eb864d9)	package-2021-05(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
⚠️ VersionConvention	API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L4
⚠️ DeprecatedXmsCodeGenerationSetting	The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L7
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L83
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L615
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L623
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L640
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L666
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L692
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L758
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L778
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L789
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1028
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1045
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1062
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1070
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1120
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1149
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1160
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1168
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1336
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1353
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1361
⚠️ 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: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1395
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1594
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1601
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1610
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1621
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1631
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1639
⚠️ PropertyDescription	Property should have a description. Location: Microsoft.ServiceBus/stable/2021-05/servicebus.json#L1646

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView 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.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger pipeline restarted successfully, please wait for status update in this comment.

[openapi-pipeline-app]

Generated ApiView

Language	Package Name	ApiView Link
swagger	Microsoft.ServiceBus	https://apiview.dev/Assemblies/Review/66deae2cdd2d45f7840cc338ee757201

[openapi-workflow-bot]

Hi @swathipil, 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.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.