False positives when readOnly property using referenced enum
まだ誰も着手していません。
評価
調査の方向性
Azure/azure-rest-api-specs-pr#15631 で説明されている比較の調査から始め、Trial モデルと参照されている TrialStatus enum を再現ケースとして使用します。diff が以前の inline enum スキーマと新しい $ref スキーマおよび readOnly 値を比較している箇所を追跡します。この同等の変更が readOnly の breaking 変更として報告されなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Describe the bug
I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 and there are a lot of false positives with a message of `The read only property has changed from 'true' to 'false'.
To Reproduce
As an example from that PR:
@doc("Subscription trial availability")
model Trial {
@doc("Trial status")
@visibility("read")
status?: TrialStatus;
It does produce readOnly.
"status": {
"$ref": "#/definitions/TrialStatus",
"description": "Trial status",
"readOnly": true
},
But before it was not a $ref, it was inline:
"status": {
"description": "Trial status",
"type": "string",
"enum": [
"TrialAvailable",
"TrialUsed",
"TrialDisabled"
],
"readOnly": true,
"x-ms-enum": {
"name": "TrialStatus",
"modelAsString": true
}
},
Expected behavior
It is not marked as a breaking change.
- 主要言語
- C#
- スター
- 290
- フォーク
- 50
- 平均マージ
- 2日 21時間
- マージ済み PR(30日)
- 10
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Azure/openapi-diff のほかの issue
-
Azure/openapi-diff#482 · 担当者 1 名 ·
-
Azure/openapi-diff#479 · コメント 2 件 · 担当者 1 名 ·
-
Azure/openapi-diff#456 · 担当者 1 名 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
Azure/openapi-diff#445 ·
-
Azure/openapi-diff#371 · コメント 7 件 · 担当者 1 名 ·
Azure/openapi-diff の issue をすべて見る
似ている issue
-
Documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
cake-build/cake#5024 ·
-
Frontend status/draft TechnicalDebt
難易度 2/5 1〜2日 初心者へのやさしさ 75/100
Altinn/altinn-auth#4143 ·
-
.NET Flaky Test Testing Tests
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
getsentry/sentry-dotnet#5617 · コメント 1 件 ·
-
:watch: Not Triaged dotnet-fsharp/svc
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
Client customer-reported needs-team-attention question Service Attention WebPubSub
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Azure/azure-sdk-for-net#63292 · コメント 3 件 · リアクション 1 件 ·