Skip to content

Latest commit

 

History

History
34 lines (18 loc) · 847 Bytes

patch-in-operation-name.md

File metadata and controls

34 lines (18 loc) · 847 Bytes
Raw

PatchInOperationName

Category

SDK Warning

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

'PATCH' operation '{0}' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.

Description

Verifies whether value for operationId is named as per ARM guidelines.

Why the rule is important

Per ARM SDK guidelines, each 'PATCH' operation on a resource should have "update" in the name. Guidelines are in place for a more consistent customer experience among ARM services SDKs.

How to fix the violation

Make sure that operationId is in the form of NOUN_Update or Update.

Impact on generated code

Operation name in the generated SDK will be named based on this.

Examples

  • Resources_Update
  • Update