Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Investigate creating a common error type in Azure Core #19490

Closed
srnagar opened this issue Jun 25, 2021 · 2 comments
Closed

Investigate creating a common error type in Azure Core #19490

srnagar opened this issue Jun 25, 2021 · 2 comments
Assignees
@rakshith91
Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. Monitor Monitor, Monitor Ingestion, Monitor Query
Milestone
[2021] September

Comments

@srnagar
Copy link
Member

srnagar commented Jun 25, 2021

REST API guideline recommends services to return errors in a standard format - https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#errorresponse--object

Investigate creating an error type in Azure Core that all services that return errors in this format can use.
@srnagar srnagar added Monitor Monitor, Monitor Ingestion, Monitor Query Client This issue points to a problem in the data-plane of the library. Azure.Core labels Jun 25, 2021
@rakshith91 rakshith91 added this to the [2021] August milestone Jul 8, 2021
@lmazuel
Copy link
Member

lmazuel commented Jul 14, 2021

This is a thing already in azure-core:

azure-sdk-for-python/sdk/core/azure-core/azure/core/exceptions.py

Line 108 in 2f8f507

class ODataV4Format(object):

Keeping this issue for testing

@rakshith91
Copy link
Contributor

Confirmed OdataV4Error works

azure-sdk pushed a commit to azure-sdk/azure-sdk-for-python that referenced this issue Jun 24, 2022
@joslinmicrosoft @tanaybhartia
@tabhar-msft @JarodAertsMs @annikel @cschen13 @edwin-msft @weidongxu-microsoft @jiansong-msft @dejo-msft @alexkarcher-msft
CodeGen from PR 19430 in Azure/azure-rest-api-specs
c6a7ea2 
Web ant97 2022 03 01 (Azure#19430)

* Adds base for updating Microsoft.Web from version stable/2021-03-01 to version 2022-03-01

* Updates readme

* Updates API version in new specs and examples

* Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegis… (Azure#18460)

* Carry fwd Microsoft.CertificateRegistration and Microsoft.DomainRegistration RPs to Api-version 2022-03-01

* Add x-ms-enum for array of inline enums. Fix reference to older api version for common defs

* Add examples for App Service Certificate orders

* Add suppressions back

* Add examples for Microsoft.DomainRegistration RP

* Fixes from prettier

* Remove unused example

* Add Unhealthy CustomDomainStatus for StaticSites (Azure#18557)

* Adding VnetRouteAllEnabled, VnetImagePullEnabled, VnetContentShareEnabled site properties to CommonDefinitions (Azure#18627)

* Added vnet realted site properties to common definitions

* removed tab

Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com>

* Add Ftp/Remote debug properties to Ase network config (Azure#18549)

* Add Ftp/Remote debug properties to Ase network config

* Switched changes to the right file

* Add Networking config to hosting environment creates

* Added some of the missing examples

* Remove disallowed properties from example Ase GET response

* Adjusted responses from other gets

* Added a bunch more examples

* Added other missing examples for Ase.

* Added more missing examples for Ase.

* fixed formatting

* Edit some examples, add back privatelink apis and try to supress the errors for missing examples.

* Fix suppress spelling and fix prettier

* Added missing privatelink examples since suppressing did not work

* Add Bring your own Backend operations (Azure#18517)

* add bring your own backend operations

* add missing files

* fix json formattin

* validation fixes

* fix

* fix more validation

* fix ids

* fix model validation

* fix descriptions

* fix environmentName description

* change to 202

* revert change to 202

* customhostnamesites optional param for 2022 API version (Azure#18670)

* fix DUPLICATE_PARAMETER

* prettier

* fix  OBJECT_ADDITIONAL_PROPERTIES

* fix random sub in examples

* add optional hostname param to customHostnameSites RT and add examples

* move changes from 2021 api version to 2022

* move examples to 2022

* Revert "add optional hostname param to customHostnameSites RT and add examples"

This reverts commit 7fc318e190de2108222dbb869d9a6219a02cae2f.

* remove examples from 2021

* fix lintDiff

* prettier fix

* model validation fix

* suppress model validation in readme

Co-authored-by: Elle Tojaroon <patojaro@microsoft.com>

* [Microsoft.Web] Add CustomDnsSuffixConfiguration to ASE (Azure#18553)

* [Microsoft.Web] Add CustomDnsSuffixConfiguration to AppServiceEnvironments

* Add examples

* Fix style issues

* Add customdnssuffix to custom-words

* Add CustomDnsSuffixConfiguration to AppServiceEnvironment definition

* Address remaining model validation errors

* Adjusted networking configuration definitions

* Addressed Arm review feedback

Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com>

* Fork/web ant97 2022 03 01 (Azure#19259)

* Added DeploymentStatus API specs and examples

* change status to enum, rm extra dot

* suppress missing examples for now

* rm id from List Deployment Slot examples

* rm location, and rename deploymentId in GetSiteDeploymentStatus examples

* change model as string to true, add 202 operations for DeploymentStatus ops to spec

* rename operationId to deploymentStatusId, undo deploymentId rename

* add long running op, as per linter

Co-authored-by: Shubham Dhond <shdhond@microsoft.com>
Co-authored-by: Weidong Xu <weidxu@microsoft.com>

* PublicNetworkAccess Swagger Change (Azure#19352)

* add publicNetworkAccess property in site for swagger

* add suppression to fix Model Validation CI

* Add allowed values in the description

* Add specs for Hosting Environment Maintenance Control (Azure#18691)

* Add documentation for Hosting Environment Maintenance Control

* Update example file name

* Make UpgradePreference non-nullable

* Correct indentation to 2 spaces

* Fix upgradePreference indentation

* Address swagger feedback. Add enums with descriptions.

* Move testNotification to request body. Update description text

* Fix testNotification

* Fix example

* Replace TestNotification parameter with TestUpgradeNotification API

* Rename to TestUpgradeAvailableNotification

* Added logic apps operations (Azure#18604)

* Added Initial Operations and some definitions

* Adding additional objects to support Logic Apps operations

* Updated path and parameters to match testing

* Prettier Fixes

* oav validat-example fixes

* Github validation fixes

* Prettier

* Updated examples and paths

* Prettier

* Revert "Prettier"

This reverts commit da090adf8005e0bd6fdc2ddebbd4390e5c4b6b20.

* Prettier

* Fixed model validation errors

* Filled in nextLinkName values

* Fixing swagger lintdiff errors

* added x-ms-long-running to async calls

* Adds numberOfWorkers to app service plan (Azure#19475)

* Adds numberOfWorkers to app service plan

* Add suppression for missing ASP examples

* Updating to fix workflow errors (Azure#19490)

* Removed conflicting resource definition and added reference to CommonDefinitions.json (Azure#19507)

* Removed conflicting resource definition and added reference to CommonDefinitions.json

* Updated resource to have workflow version

* Updated nextLink object to be correctly tagged (Azure#19560)

* Updated nextLink object to be correctly tagged

* Adding value placeholder

* Updated SKU to remove conflict

* Updated x-ms-enum

* Added missing model

* Adding more missing models

* Add suppressions for missing examples (Azure#19563)

Co-authored-by: Joseph Lin <54335291+joslinmicrosoft@users.noreply.github.com>
Co-authored-by: Tanay Bhartia <tanaybhartia@gmail.com>
Co-authored-by: Tanay Bhartia <tanaybhartia@microsoft.com>
Co-authored-by: JarodAertsMs <90280240+JarodAertsMs@users.noreply.github.com>
Co-authored-by: annikel <92825476+annikel@users.noreply.github.com>
Co-authored-by: Paviya (Elle) Tojaroon <pt335@cornell.edu>
Co-authored-by: Elle Tojaroon <patojaro@microsoft.com>
Co-authored-by: Chris Chen <chrc@microsoft.com>
Co-authored-by: Jarod Aerts <jarodaerts@microsoft.com>
Co-authored-by: edwin-msft <71858592+edwin-msft@users.noreply.github.com>
Co-authored-by: Shubham Dhond <shdhond@microsoft.com>
Co-authored-by: Weidong Xu <weidxu@microsoft.com>
Co-authored-by: jiansong-msft <77516279+jiansong-msft@users.noreply.github.com>
Co-authored-by: Derek Johnson <47129225+dejo-msft@users.noreply.github.com>
Co-authored-by: Alex Karcher <alkarche@microsoft.com>
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@rakshith91 rakshith91

Labels
Azure.Core Client This issue points to a problem in the data-plane of the library. Monitor Monitor, Monitor Ingestion, Monitor Query
Projects
None yet
Milestone
[2021] September
Development

No branches or pull requests
3 participants
@lmazuel @rakshith91 @srnagar