False positives when readOnly property using referenced enum

未关闭

#286 创建于 2023年11月17日 1 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 4/5
预计耗时: 3-5 天
新手友好度: 42/100

Issue 类型: 缺陷
描述清晰度: 基本清楚
活跃度: 停滞
技术栈: csharp, openapi
领域: cli

调研方向

首先检查 Azure/azure-rest-api-specs-pr#15631 中描述的比较，使用 Trial 模型和所引用的 TrialStatus enum 作为复现用例。跟踪 diff 在哪里将之前的 inline enum schema 与新的 $ref schema 和 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 小时
30 天内合并 PR: 10

贡献指南

打开贡献指南

从这里开始

先读完整个 Issue，再读项目的贡献指南。
在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
Fork 仓库，在一个分支上完成修改。
提交 Pull Request，并在描述里引用这个 Issue 编号。

Azure/openapi-diff 的其他 Issue

Crash if inherited property is structurally equal but not reference identical 未关闭

Azure/openapi-diff#482 · 已指派 1 人 · 2026年5月5日创建
Crash if duplicate model names (across files) used in allOf 未关闭

Azure/openapi-diff#479 · 2 条评论 · 已指派 1 人 · 2026年5月5日创建
Remove dependency `autorest` 未关闭

Azure/openapi-diff#456 · 已指派 1 人 · 2026年3月3日创建
Error: Invalid reference token: /Tables(\'{tableName}\') 未关闭

难度 4/5 3-5 天新手友好度 35/100

Azure/openapi-diff#445 · 2026年1月27日创建
OpenAPI-diff should flag changes in the tags for an operation 未关闭

Azure/openapi-diff#371 · 7 条评论 · 已指派 1 人 · 2025年9月1日创建

查看 Azure/openapi-diff 的全部 Issue

相似的 Issue

Sticky banners hide under the fixed mobile header while scrolling 未关闭

bug

难度 2/5 1-3 小时新手友好度 75/100

nightscout/nocturne#1425 · 2026年9月23日创建
Loading of namespaces states "no records found" 未关闭

enhancement

难度 2/5 1-3 小时新手友好度 75/100

miracum/vfps#357 · 2026年9月23日创建
Login Screen always ask for password 未关闭

难度 2/5 1-3 小时新手友好度 65/100

jellyfin/jellyfin#18175 · 2026年9月23日创建
Add Cake DSL examples to BuildSystem and CI provider APIs 未关闭

Documentation

难度 2/5 1-3 小时新手友好度 75/100

cake-build/cake#5024 · 2026年9月23日创建
Gå gjennom ESLint-suppressions 未关闭

Frontend status/draft TechnicalDebt

难度 2/5 1-2 天新手友好度 75/100

Altinn/altinn-auth#4143 · 2026年9月23日创建

更多 C# Issue