Azure / Azure/openapi-diff

Wrong example about the https://github.com/Azure/openapi-diff/blob/master/docs/rules/1029.md

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

Description

Hi team,

In the doc https://github.com/Azure/openapi-diff/blob/master/docs/rules/1029.md,
the Example is:
```
Example: readonly of property message **removed** in the new version.
```

However compared with the old specification, the new specification **added** "readonly" property

Contributor guide

Open the contributing guide

Research direction

Open docs/rules/1029.md and compare the example with the rule's described change between the old and new OpenAPI specifications. Correct the example so it accurately says whether the readonly property was added or removed, then verify the rendered Markdown wording is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.