Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Nobody has claimed this yet.

Assessment

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

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.

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

Dominant language
C#
Stars
290
Forks
50
Avg merge
2d 21h
Merged PRs (30d)
10

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/openapi-diff

All issues in Azure/openapi-diff

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.