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

Removing `readOnly: true` on response-only property is flagged as error

Open
#349 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp, openapi
Domain
cli, devtools

Research direction

Start by reviewing the linked Key Vault migration commit, OpenAPI diff build log, and the referenced pull-request review thread to understand how response-only properties are compared. Reproduce the reported false error and determine the expected result for removing readOnly: true; done means the diff no longer flags this valid change while still detecting genuine breaking changes.

Written by the indexing model from the issue text.

Description

While migrating Key Vault specs from Swagger to TSP, we removed a readOnly designation for a property on a response-only type. This was flagged as an error by the OpenAPI diff; per context in this review thread, this error doesn't seem to be correct.

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.