Azure / Azure/openapi-diff

[RULE 1041] AddedPropertyInResponse shoul suggest adding "readonly true"

Open
#99 0 comments 0 reactions 0 assignees View on GitHub
Enhancement planned
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

"Adding optional property in response" will cause SDK breaking changes only in case of GET-PUT. It's possible to avoid such scenario if the property is marked as "read only = true". The error/warning message should suggest adding it.

Contributor guide

Open the contributing guide

Research direction

Start with the implementation of RULE 1041, AddedPropertyInResponse, and locate where its error or warning message is assembled. Update the diagnostic so it suggests marking the added response property as read-only, then verify the message using the repository's existing rule or command-line checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.