Azure / Azure/azure-rest-api-specs

[Resources] `ManagementLockProperties` contains Azure-internal `owner` property

Open
#19,252 0 comments 0 reactions 0 assignees View on GitHub
Resource Authorization Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

The swagger of `locks`'s `ManagementLockProperties` contains an `owner` property which is only for Azure internal usage according to https://github.com/Azure/azure-cli/issues/22528:

https://github.com/Azure/azure-rest-api-specs/blob/b2de552d860a5cc148c7a0b7a739fd0dacb5b5a4/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json#L971-L977

This makes the `owner` property publicly available in

- REST API doc: https://docs.microsoft.com/en-us/rest/api/resources/management-locks/create-or-update-at-resource-group-level#managementlockobject
![image](https://user-images.githubusercontent.com/4003950/170689266-d07d33f6-84a7-4b29-9d96-cbfacd8898db.png)
- ARM template doc: https://docs.microsoft.com/en-us/azure/templates/microsoft.authorization/locks?tabs=json
![image](https://user-images.githubusercontent.com/4003950/170689132-f7e7cbff-2026-4840-b64a-55286bb7fbd0.png)
- Python SDK: https://github.com/Azure/azure-sdk-for-python/blob/830ccf6ab129bdd6b7343cfae39e4e8e4b3bfd4d/sdk/resources/azure-mgmt-resource/azure/mgmt/resource/locks/v2016_09_01/models/_models_py3.py#L68-L69

The swagger should either hide this property or clarifies its internal usage.

Contributor guide

Open the contributing guide

Research direction

Start with specification/resources/resource-manager/Microsoft.Authorization/stable/2016-09-01/locks.json at the ManagementLockProperties definition and inspect the owner property and surrounding swagger metadata. Check how this definition feeds the REST documentation, ARM template documentation, and Python SDK, then confirm whether the owner property should be hidden or explicitly marked for internal use.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.