Skip to content

Add Failure Response Property to CircuitBReakerRule and BackendPool #33065

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

Merged
solankisamir merged 5 commits into from
Jul 3, 2025

fix

8ff859d
Select commit
Loading
Failed to load commit list.
Merged

Add Failure Response Property to CircuitBReakerRule and BackendPool #33065

fix
8ff859d
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Apr 4, 2025 in 7m 6s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-preview-2024-10-01-preview package-preview-2024-10-01-preview(8ff859d) package-preview-2024-10-01-preview(apim-2024-10-01-preview)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L2523


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'AccessInformationContract'. Properties [properties.id] conflict with ARM top level properties. Please rename these.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L62
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L218
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'ApiContract'. Properties [properties.type] conflict with ARM top level properties. Please rename these.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L296
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ApiExportResult' has extra properties ['format'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L692
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ApiExportResult' has extra properties ['value'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L692
❌ RequiredPropertiesMissingInResourceModel Model definition 'ApiExportResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L692
❌ RequiredPropertiesMissingInResourceModel Model definition 'ApiRevisionCollection' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L815
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L1359
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L1550
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L1557
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'BackendContract'. Properties [properties.type] conflict with ARM top level properties. Please rename these.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L2040
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L2118
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L2128
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'GroupContract'. Properties [properties.type] conflict with ARM top level properties. Please rename these.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L3346
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'IdentityProviderContract'. Properties [properties.type] conflict with ARM top level properties. Please rename these.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L3663
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L4187
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L4257
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L4830
❌ ArrayMustHaveType 'items.type' property must be truthy
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L5388
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterCollection' has extra properties ['counterKey'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterCollection' has extra properties ['periodKey'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterCollection' has extra properties ['periodStartTime'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterCollection' has extra properties ['periodEndTime'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterCollection' has extra properties ['value'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ NestedResourcesMustHaveListOperation The nested resource 'QuotaCounterCollection' does not have list operation, please add it.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ RequiredPropertiesMissingInResourceModel Model definition 'QuotaCounterCollection' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6078
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterContract' has extra properties ['counterKey'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterContract' has extra properties ['periodKey'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterContract' has extra properties ['periodStartTime'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterContract' has extra properties ['periodEndTime'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'QuotaCounterContract' has extra properties ['value'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ RequiredPropertiesMissingInResourceModel Model definition 'QuotaCounterContract' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6104
❌ NestedResourcesMustHaveListOperation The nested resource 'RecipientEmailContract' does not have list operation, please add it.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6200
❌ NestedResourcesMustHaveListOperation The nested resource 'RecipientUserContract' does not have list operation, please add it.
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6268
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['timestamp'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['interval'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['country'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['region'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['zip'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['userId'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['productId'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['apiId'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['operationId'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['apiRegion'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['subscriptionId'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['callCountSuccess'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['callCountBlocked'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['callCountFailed'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['callCountOther'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'ReportCollection' has extra properties ['callCountTotal'].
Location: Microsoft.ApiManagement/preview/2024-10-01-preview/definitions.json#L6304
View more details on openapi-pipeline-app