-
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
[EventHubs]: Adding missing descriptions #21685
Conversation
Hi, @damodaravadhani 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.2)] | new version | base version |
---|---|---|
SchemaRegistry.json | 2022-01-01-preview(a979ded) | 2022-01-01-preview(main) |
namespaces-preview.json | 2022-01-01-preview(a979ded) | 2022-01-01-preview(main) |
SchemaRegistry.json | 2021-11-01(a979ded) | 2021-11-01(main) |
namespaces-preview.json | 2021-11-01(a979ded) | 2021-11-01(main) |
️️✔️
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-11 | package-2021-11(a979ded) | package-2021-11(main) |
package-2022-01-preview | package-2022-01-preview(a979ded) | package-2022-01-preview(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L118 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L119 |
LongRunningResponseStatusCode |
A 'put' operation 'Namespaces_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L119 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L169 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L169 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L181 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L210 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L283 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L283 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L283 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L312 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L324 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L372 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L372 |
TrackedResourcePatchOperation |
Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L372 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L426 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L426 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L440 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L475 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L537 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L582 |
ResourceNameRestriction |
The resource name parameter 'namespaceName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L624 |
ResourceNameRestriction |
The resource name parameter 'resourceAssociationName' should be defined with a 'pattern' restriction. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L624 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L625 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L657 |
MissingTypeObject |
The schema 'EHNamespaceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L672 |
MissingTypeObject |
The schema 'EHNamespace' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L688 |
MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L703 |
MissingTypeObject |
The schema 'Identity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L857 |
MissingTypeObject |
The schema 'Encryption' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.EventHub/preview/2022-01-01-preview/namespaces-preview.json#L912 |
️️✔️
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.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @damodaravadhani, Your PR has some issues. Please fix the CI sequentially by following the order of
|
* Adding missing descriptions * fix * Doc Fix * Fixes
* Adding missing descriptions * fix * Doc Fix * Fixes
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.