Output in text and markdown not equivalent (text output incomplete)
還沒有人認領這個 Issue。
評估
研究方向
從產生所示文字輸出的 CLI 路徑開始，並將其與 markdown formatter 進行比較。使用提供的 spec1.yaml 和 spec2.yaml 範例，驗證 stdout 是否識別出已變更的屬性和 enum 值，或者是否提供了明確的輸出格式選項。
由索引模型根據 Issue 內容生成。
描述
The text output which is printed by default by the CLI doesn't show all the information that the markdown output shows:
spec1.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
spec2.yaml
components:
schemas:
SomeDTO:
someProperty:
type: string
enum:
- ENUM_VALUE_1
- ENUM_VALUE_2
- ENUM_VALUE_3
markdown output
#### What's Changed
---
##### `GET` /resources1/{id}/resources2
###### Return Type:
Changed response : **200 OK**
> OK
* Changed content type : `application/json`
Changed items (object):
* Changed property `someProperty` (string)
Added enum value:
* `ENUM_VALUE_3`
text output
==========================================================================
== API CHANGE LOG ==
==========================================================================
API for Umetrics Core Project Management Service
--------------------------------------------------------------------------
-- What's Changed --
--------------------------------------------------------------------------
Return Type:
- Changed 200 OK
Media types:
- Changed application/json
Schema: Broken compatibility
- GET /resources1/{id}/resources2
API changes broke backward compatibility
--------------------------------------------------------------------------
text output tells nothing about what actually broke backwards compatibility, but since it's the stdout of the process it should show everything that's needed to determine the reason of the problem.
Alternative solution: give an option to decide which kind of output: text/markdown/json should be printed to stdout.
- 主要語言
- Java
- 星號
- 1.1k
- 分支
- 190
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
OpenAPITools/openapi-diff 的其他 Issue
-
enhancement
難度 2/5 1-3 小時 新手友好度 68/100
OpenAPITools/openapi-diff#506 ·
-
good first issue help wanted
難度 2/5 1-3 小時 新手友好度 68/100
OpenAPITools/openapi-diff#364 ·
-
bug OpenAP 3.1.0 Support
難度 3/5 1-2 天 新手友好度 68/100
OpenAPITools/openapi-diff#910 · 1 則留言 ·
-
Render capabilities
難度 3/5 1-2 天 新手友好度 55/100
OpenAPITools/openapi-diff#893 · 1 則留言 ·
-
[Bug] Backward compatibility check fails on reordered discriminator mappings可能已有人在做 @MoChiUaena 於 19 天前認領。 未關閉Breaking/Non-Breaking classification
難度 3/5 1-2 天 新手友好度 55/100
OpenAPITools/openapi-diff#886 ·
查看 OpenAPITools/openapi-diff 的全部 Issue
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 74/100
refinedmods/refinedstorage2#1421 ·
-
StepExamBenchmarkTest runs a loop and prints a timing but asserts nothing可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉jules
難度 1/5 1 小時以內 新手友好度 82/100
open-learning-exchange/myplanet#18199 · 1 則留言 ·
維護者通常 4 天內回覆
-
難度 2/5 1-3 小時 新手友好度 65/100
維護者通常 1 天內回覆
-
Scheme-less stream URLs throw NullPointerException instead of URISyntaxException可能已有人在做 @blihio 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 82/100
pedroSG94/RootEncoder#2218 ·
維護者通常 3 天內回覆
-
[Bug] The producer summary calls a multi-group client a duplicate可能已有人在做 關聯的 PR 仍在進行中或已合併。 未關閉
難度 2/5 1-3 小時 新手友好度 68/100
apache/rocketmq-dashboard#6872 ·
維護者通常 3 天內回覆