Skip to content

[BodyTopLevelProperties] Add "managedByExtended" to allowed list of top-level properties #810

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

Draft
Copilot wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

[BodyTopLevelProperties] Add "managedByExtended" to allowed list of top-level properties #810

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ff8bafa
Initial plan
Copilot Jan 27, 2026
2d11108
Add managedByExtended to allowed body top level properties
Copilot Jan 27, 2026
c99fb08
Add test case for managedByExtended property support
Copilot Jan 27, 2026
4454482
Update error message to include all allowed properties
Copilot Jan 27, 2026
98c34eb
Fix documentation casing for extendedLocation property
Copilot Jan 27, 2026
be580a7
Add missing kind and zones properties to documentation
Copilot Jan 27, 2026
90d4543
Update existing test file instead of creating new one for managedByEx…
Copilot Jan 27, 2026
cab0d67
Add Rush change file for managedByExtended feature
Copilot Jan 29, 2026
5cb9e21
Update package.json to v2.2.1 and CHANGELOG.md directly
Copilot Jan 29, 2026
b0e6127
Apply suggestion from @mikeharder
mikeharder Jan 29, 2026
6056f7d
Merge branch 'main' into copilot/update-allowed-body-properties
mikeharder Jan 30, 2026
ad0471d
Increment patch version from 2.2.1 to 2.2.2
Copilot Jan 30, 2026
98aee25
Increment patch version from 2.2.2 to 2.2.3
Copilot Feb 6, 2026
bec2729
Merge branch 'main' into copilot/update-allowed-body-properties
mikeharder Feb 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/body-top-level-properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ARM OpenAPI(swagger) specs
## Description

Top level properties should be one of `name`, `type`, `id`, `location`, `properties`, `tags`, `plan`, `sku`, `etag`,
`managedBy`, `identity`, `systemData`, `extendedlocation`. Per [ARM guidelines](https://github.com/cloud-and-ai-microsoft/resource-provider-contract/blob/master/v1.0/resource-api-reference.md),
`managedBy`, `managedByExtended`, `identity`, `kind`, `zones`, `systemData`, `extendedLocation`. Per [ARM guidelines](https://github.com/cloud-and-ai-microsoft/resource-provider-contract/blob/master/v1.0/resource-api-reference.md),
top level properties of a resource should be only ones from the allowed set.

## How to fix
Expand Down
2 changes: 1 addition & 1 deletion docs/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Please refer to [body-properties-names-camel-case.md](./body-properties-names-ca
### BodyTopLevelProperties

Top level properties should be one of `name`, `type`, `id`, `location`, `properties`, `tags`, `plan`, `sku`, `etag`,
`managedBy`, `identity`, `systemData`, `extendedlocation`. Per [ARM guidelines](https://github.com/cloud-and-ai-microsoft/resource-provider-contract/blob/master/v1.0/resource-api-reference.md),
`managedBy`, `managedByExtended`, `identity`, `kind`, `zones`, `systemData`, `extendedLocation`. Per [ARM guidelines](https://github.com/cloud-and-ai-microsoft/resource-provider-contract/blob/master/v1.0/resource-api-reference.md),
top level properties of a resource should be only ones from the allowed set.

Please refer to [body-top-level-properties.md](./body-top-level-properties.md) for details.
Expand Down
6 changes: 6 additions & 0 deletions packages/rulesets/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log - @microsoft.azure/openapi-validator-rulesets

## 2.2.1

### Patches

- Add managedByExtended to allowed body top-level properties
Comment thread
mikeharder marked this conversation as resolved.
Outdated

## 2.2.0

### Minor changes
Expand Down
2 changes: 1 addition & 1 deletion packages/rulesets/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@microsoft.azure/openapi-validator-rulesets",
"version": "2.2.0",
"version": "2.2.1",
"description": "Azure OpenAPI Validator",
"main": "dist/index.js",
"scripts": {
Expand Down
4 changes: 3 additions & 1 deletion packages/rulesets/src/native/functions/arm-resource-validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ export function* armResourcePropertiesBag(openapiSection: any, options: {}, ctx:
"sku",
"etag",
"managedby",
"managedbyextended",
"identity",
"kind",
"zones",
Expand Down Expand Up @@ -144,6 +145,7 @@ export function* bodyTopLevelProperties(openapiSection: any, options: {}, ctx: R
"sku",
"etag",
"managedby",
"managedbyextended",
"identity",
"kind",
"zones",
Expand All @@ -155,7 +157,7 @@ export function* bodyTopLevelProperties(openapiSection: any, options: {}, ctx: R
if (!allowedBodyTopLevelProperties.includes(propName.toLowerCase())) {
yield {
location: ["definitions", re.modelName],
message: `Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition '${re.modelName}' has extra properties ['${propName}'].`,
message: `Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, managedByExtended, identity, kind, zones, systemData, extendedLocation. Model definition '${re.modelName}' has extra properties ['${propName}'].`,
}
}
}
Expand Down
7 changes: 7 additions & 0 deletions packages/rulesets/src/native/tests/resources/body-top-level-properties-real-swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,13 @@
"type": "string",
"description": "The escaped name of the namespace."
},
"managedByExtended": {
"type": "array",
"items": {
"type": "string"
},
"description": "The fully qualified resource IDs of the resources that manage this resource"
},
"classification": {
"$ref": "#/definitions/NamespaceClassification",
"description": "Kind of namespace"
Expand Down
⚡