Add missing documentation for linting rules#4001
Open
timotheeguerin wants to merge 8 commits intoAzure:mainfrom
Open
Add missing documentation for linting rules#4001timotheeguerin wants to merge 8 commits intoAzure:mainfrom
timotheeguerin wants to merge 8 commits intoAzure:mainfrom
Conversation
microsoft-github-policy-service
bot
added
the
lib:azure-resource-manager
commit: |
Collaborator
|
All changed packages have been documented.
Show changes
|
Collaborator
|
You can try these changes here
|
markcowl
reviewed
Mar 13, 2026
| @azure-tools/typespec-azure-resource-manager/arm-common-types-version | ||
| ``` | ||
|
|
||
| ARM services must specify the ARM common-types version using the `@armCommonTypesVersion` decorator. This decorator should be applied either on the service namespace or on each version enum member. |
Member
There was a problem hiding this comment.
Suggested change
| ARM services must specify the ARM common-types version using the `@armCommonTypesVersion` decorator. This decorator should be applied either on the service namespace or on each version enum member. | |
| ARM services must specify the ARM common-types version using the `@armCommonTypesVersion` decorator. If the same common types version is used across all service versions, this decorator should be applied either on the service namespace. If the common types version is updated in later versions, the decorator should appear on each version enum member. |
| @azure-tools/typespec-azure-resource-manager/arm-resource-operation | ||
| ``` | ||
|
|
||
| Validate ARM Resource operations. All resource operations must be defined inside an interface, include an `api-version` parameter, and use the correct decorator for the HTTP verb. |
Member
There was a problem hiding this comment.
Suggested change
| Validate ARM Resource operations. All resource operations must be defined inside an interface, include an `api-version` parameter, and use the correct decorator for the HTTP verb. | |
| Validate that all ARM Resource operations are defined inside an interface, include an `api-version` parameter, and use the correct decorator for the HTTP verb. |
| @azure-tools/typespec-azure-resource-manager/empty-updateable-properties | ||
| ``` | ||
|
|
||
| Resources with update operations should have updateable properties. The RP-specific properties of the resource (as defined in the `properties` property) should have at least one updateable property. Properties are updateable if they do not have a `@visibility` decorator, or if they include `update` in the `@visibility` decorator arguments. |
Member
There was a problem hiding this comment.
Suggested change
| Resources with update operations should have updateable properties. The RP-specific properties of the resource (as defined in the `properties` property) should have at least one updateable property. Properties are updateable if they do not have a `@visibility` decorator, or if they include `update` in the `@visibility` decorator arguments. | |
| Resources with update operations should have updateable properties. The RP-specific properties of the resource (as defined in the `properties` property) should have at least one updateable property. Properties are updateable if they do not have a `@visibility` decorator, or if they include `Lifecycle.Update` in the `@visibility` decorator arguments. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.