-
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
Add optional property EndpointType to the endpoints in 2021-06-01-preview #15203
Conversation
Hi, @laxmankumar12 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. vsswagger@microsoft.com |
[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 |
---|---|
1041 - AddedPropertyInResponse |
The new version has a new property 'endpointType' in response that was not found in the old version. New: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2875:7 Old: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2875:7 |
️⚠️
LintDiff: 2 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
Rule | Message |
---|---|
'endpointType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2911 |
|
'endpointType' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4262 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2373 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2637 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3554 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3640 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3850 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3874 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4156 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4621 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4857 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdate' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1326 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeFirst' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1478 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeSecond' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1639 |
|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Skus_CreateOrUpdateNestedResourceTypeThird' Request Model: 'ResourceTypeSku' Response Model: 'SkuResource' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L1809 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: marketplaceType Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3192 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: resourceAccessPolicy Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3313 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: origin Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3617 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: actionType Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3633 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: origin Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3827 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: actionType Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3843 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: marketplaceType Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4439 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4705 |
|
200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'ProviderRegistrations_CreateOrUpdate', Response code: '201' Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L941 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2488 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L2876 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3363 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCheckedIn Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3473 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3613 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L3823 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: preflightSupported Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4018 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#L4224 |
️️✔️
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: 6 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManagement-resourceAccessRolesItem' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManagement-resourceAccessRolesItem" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManifestProperties-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManifestProperties-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceType-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceType-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'ResourceProviderManifest-metadata' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/ResourceProviderManifest-metadata" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'OperationsDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/OperationsDefinition-properties" |
|
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"The schema 'LocalizedOperationDefinition-properties' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/providerhub/resource-manager/Microsoft.ProviderHub/preview/2021-06-01-preview/providerhub.json#/components/schemas/LocalizedOperationDefinition-properties" |
|
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-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 |
---|---|
AutorestCore/Exception |
"readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-preview", "details":"Error: Plugin pre-namer reported failure." |
💬 AutorestCore/Exception | "readme":"providerhub/resource-manager/readme.md", "tag":"package-2021-06-01-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): 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
R4031 - Rpaas_ResourceProvisioningState |
[RPaaS] The resource NotificationRegistration is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L3467 |
R4031 - Rpaas_ResourceProvisioningState |
[RPaaS] The resource SkuResource is defined without 'provisioningState' in properties bag, consider adding the provisioningState for it. Location: Microsoft.ProviderHub/stable/2020-11-20/providerhub.json#L4532 |
Swagger Generation Artifacts
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Hi @laxmankumar12, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
@ruowan This API version was merged yesterday and should have any documentation/client libraries or customer support. So I'm not sure if this is still supposed to be considered as a breaking change. The PR that introduced this api version which merged yesterday is: #14650. let me know if you need anything else from me. |
Ok. LGTM. It's allowed. No customer impact. |
…view (Azure#15203) * Add EndpointType to the endpoints. * Add example * Fix spaces * Add EndpointType to the endpoints in 2021-06-01-preview * remove unnecessary changes Co-authored-by: REDMOND\lakshv <lakshv@microsoft.com>
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.
week of 7/19.
July
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.