Adding default error response & updating basePath #15784

yifan-zhou922 · 2021-08-25T05:32:47Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

This reverts commit 465347e.

openapi-workflow-bot · 2021-08-25T05:32:49Z

Hi, @yifan-zhou922 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. vsswagger@microsoft.com

openapi-workflow-bot · 2021-08-25T05:32:50Z

[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.

openapi-pipeline-app · 2021-08-25T05:32:52Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- purview/data-plane/readme.md tag:package-2021-09-01
Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- purview/data-plane/readme.md tag:default

️️✔️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: 87 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.9.0)
- current:preview/2021-09-01/purviewcatalog.json compared with base:preview/2021-05-01-preview/purviewcatalog.json

The following breaking changes are detected by comparison with latest preview version:

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

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L79:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L129:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L166:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L205:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L241:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L280:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L327:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L358:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L394:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L425:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L458:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L499:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L540:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L586:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L633:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L671:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L711:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L761:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L809:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L852:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L898:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L931:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L976:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1013:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1060:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1099:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1132:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1172:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1200:11
`❌` 1011 - AddingResponseCode	The new version adds a response code 'default'. New: Azure.Analytics.Purview.Catalog/preview/2021-09-01/purviewcatalog.json#L1246:11

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

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]

The following tags are being changed in this PR

purview/data-plane/readme.md#package-2021-09-01

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ ?	"readme":"purview/data-plane/readme.md", "tag":"package-2021-09-01", "details":"Operation 'Glossary/DeleteTermAssignmentFromEntities' really should not have a media type (because there should be no body)"
⚠️ ?	"readme":"purview/data-plane/readme.md", "tag":"package-2021-09-01", "details":"Operation 'Types/DeleteTypeDefinitions' really should not have a media type (because there should be no body)"
💬 AutorestCore/Exception	"readme":"purview/data-plane/readme.md", "tag":"package-2021-09-01", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
💬 AutorestCore/Exception	"readme":"purview/data-plane/readme.md", "tag":"package-2021-09-01", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"
💬 AutorestCore/Exception	"readme":"purview/data-plane/readme.md", "tag":"package-2021-09-01", "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).

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

openapi-pipeline-app · 2021-08-25T05:32:53Z

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️❌ azure-sdk-for-net-track2 failed [Detail]

❌Failed [Logs]Release - Generate from 382a975. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation
error	Fatal error: packageFolderFromFileSearch not configured and could not be found in legacy config
packageFolderFromFileSearch not configured and could not be found in legacy config
Error: packageFolderFromFileSearch not configured and could not be found in legacy config
    at workflowDetectChangedPackages (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:422:23)
    at workflowHandleReadmeMd (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:168:11)
    at async Object.exports.workflowMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:83:9)
    at async Object.exports.sdkAutoMain (/home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:152:13)
    at async /home/vsts/work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

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

openapi-workflow-bot · 2021-08-25T05:34:46Z

Hi @yifan-zhou922, 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.

openapi-workflow-bot · 2021-08-30T06:02:29Z

Hi @yifan-zhou922, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

This reverts commit 9e7eeb4.

This reverts commit 05039d7.

This reverts commit 97dcdea.

jhendrixMSFT · 2021-08-30T17:27:58Z

@yifan-zhou922 has this API version been deployed yet?

yifan-zhou922 · 2021-08-31T01:28:05Z

@jhendrixMSFT It will be deployed in the regular deployment this week. I will inform you when the deployment is finished. Many thanks.

yifan-zhou922 · 2021-09-09T02:03:15Z

@jhendrixMSFT The deployment has finished on PROD regions.

…into add_endpoint * 'main' of https://github.com/Azure/azure-rest-api-specs: (5079 commits) Add Microsoft.ExtendedLocation [CustomLocation] 2021-08-15 stable API Version (Azure#15967) Updated SKU property to be read only (Azure#15965) Add Microsoft.Communication.UserDisconnected Event (Azure#15870) Add collection APIs (Azure#15221) [Cognitive Services - Personalizer] v1.1-preview.2 (Azure#15699) Adding default error response & updating basePath (Azure#15784) Update readme and readme.python (Azure#15973) add synapse batch tag package-composite-v1 (Azure#15974) Microsoft.BareMetalInfrastructure: add stable API version 2021-08-09 (Azure#15680) change readme.go.md template to track 2 (Azure#15972) [CosmosDB] Adding apiVersion 2021-07-01-preview (Azure#14817) Merge Dev-containerservice-microsoft.containerservice-2021-08-01 branch to main (Azure#15954) DiskRP swagger for 2021-04-01 (Azure#15665) Use IncidentSeverity in IncidentInfo (Azure#15762) Add stable API version "2021-09-01" (Azure#15897) add-purview-typescript-file (Azure#15948) Swagger Completeness for Microsoft.Authorization (Azure#15253) [Hub Generated] Review request for Microsoft.Aadiam to add version preview/2020-03-01-preview and stable/2020-03-01 (Azure#15861) Add swagger for missing CheckPolicyRestrictions API version (Azure#15888) Add Red Hat OpenShift 2021-09-01-preview (Azure#15616) ...

yifan-zhou922 added 6 commits July 15, 2021 17:22

add collection APIs

682f498

Update purviewcatalog.json

465347e

Add default error response

37a50df

Update purviewcatalog.json

97dcdea

Revert "Update purviewcatalog.json"

c210197

This reverts commit 465347e.

revert collection

1fb06a8

openapi-assignment-bot bot assigned jhendrixMSFT Aug 25, 2021

yifan-zhou922 changed the title ~~Yifanzhou/error response~~ Adding default error response & changing DNS naming Aug 25, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Aug 25, 2021

Update purviewcatalog.json

05039d7

yifan-zhou922 changed the title ~~Adding default error response & changing DNS naming~~ Adding default error response & updating basePath Aug 26, 2021

update api version

9e7eeb4

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed BreakingChangeReviewRequired labels Aug 30, 2021

openapi-sdkautomation bot mentioned this pull request Aug 30, 2021

[AutoPR Azure.Analytics.Purview.Catalog] Adding default error response & updating basePath AzureSDKAutomation/azure-sdk-for-net#5735

Draft

yifan-zhou922 added 7 commits August 30, 2021 19:51

add api-version

bab82ba

Revert "update api version"

b205739

This reverts commit 9e7eeb4.

Revert "Update purviewcatalog.json"

d4a1db8

This reverts commit 05039d7.

Revert "Update purviewcatalog.json"

b3b8b5d

This reverts commit 97dcdea.

add api-version

f55e01b

update api-version

044ddee

Update readme.md

2766798

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Aug 30, 2021

add ignoreTermsAndCategories

18ce9a4

jhendrixMSFT approved these changes Sep 9, 2021

View reviewed changes

jhendrixMSFT merged commit 382a975 into main Sep 9, 2021

JackTn deleted the yifanzhou/error_response branch June 16, 2022 00:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding default error response & updating basePath #15784

Adding default error response & updating basePath #15784

yifan-zhou922 commented Aug 25, 2021 •

edited

Loading

openapi-workflow-bot bot commented Aug 25, 2021

openapi-workflow-bot bot commented Aug 25, 2021

openapi-pipeline-app bot commented Aug 25, 2021 •

edited

Loading

openapi-pipeline-app bot commented Aug 25, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Aug 25, 2021

openapi-workflow-bot bot commented Aug 30, 2021

jhendrixMSFT commented Aug 30, 2021

yifan-zhou922 commented Aug 31, 2021

yifan-zhou922 commented Sep 9, 2021

Adding default error response & updating basePath #15784

Adding default error response & updating basePath #15784

Conversation

yifan-zhou922 commented Aug 25, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Aug 25, 2021

openapi-workflow-bot bot commented Aug 25, 2021

openapi-pipeline-app bot commented Aug 25, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Aug 25, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Aug 25, 2021

openapi-workflow-bot bot commented Aug 30, 2021

jhendrixMSFT commented Aug 30, 2021

yifan-zhou922 commented Aug 31, 2021

yifan-zhou922 commented Sep 9, 2021

yifan-zhou922 commented Aug 25, 2021 •

edited

Loading

openapi-pipeline-app bot commented Aug 25, 2021 •

edited

Loading

openapi-pipeline-app bot commented Aug 25, 2021 •

edited

Loading