Consider additional guidance on Server Objects
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- openapi
研究方向
從 Learn Site 的 Server Object 頁面開始，檢視 PR #4389 中提出的疑慮，尤其是關於相對伺服器 URL、擷取 URI 和伺服器變數的說明。完成的標準是決定這些指引應放置在哪裡，並在 Learn Site 或規格文件中清楚記錄相關注意事項。
由索引模型根據 Issue 內容生成。
描述
@karenetheridge and @notEthan raised various points about confusion and usage of the Server Object and its url field in PR #4389.
From @karenetheridge
We can also offer caution that if server urls are not absolute, then the retrieval URI will be used to resolve them, which might not be desirable because if the scheme+host of the retrieval URI may not actually be the same scheme+host as where the APIs are being hosted, the result will be that any matching of API HTTP requests against path-items in the OpenAPI document will fail.
This caveat is not new with these changes, but a user might think that an absolute $self is sufficient to ward off this problem, which it isn't.
From @notEthan (the part about server variables vs relative server URLs being the most relevant to this issue, see #4541 for other concerns raised in this quote):
I certainly agree/understand that the URIs of the API description and objects within are quite different than (or unrelated to) API server/endpoint URLs. My hesitation is on the idea that the retrieval URI for the OAD is likely to be more closely related to the server URL than $self (I've generally seen the OAD served from one place accompanying documentation, not with each deployment, and aren't server variables the better mechanism for deployment-specific URLs?).
Or rather, my hesitation as an implementer of tooling is on whether that difference is worth implementing - I have one base URI for objects in the OAD (including servers), which will be changing to inherit from $self, and no place to put another base URI. It's not difficult to implement but it adds some complexity in a place I have doubts on the real utility of it.
Note that some of this guidance could go on the Learn Site, which already has a substantial page on the Server Object.
- 主要語言
- Markdown
- 星號
- 31.3k
- 分支
- 9.2k
- 平均合併
- 2 天 9 小時
- 30 天內合併 PR
- 17
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
OAI/OpenAPI-Specification 的其他 Issue
-
Housekeeping
難度 1/5 1 小時以內 新手友好度 45/100
OAI/OpenAPI-Specification#5566 · 2 則留言 ·
維護者通常 1 天內回覆
-
Housekeeping
難度 1/5 1 小時以內 新手友好度 35/100
OAI/OpenAPI-Specification#5562 · 4 則留言 ·
維護者通常 1 天內回覆
-
Housekeeping
難度 5/5 一週以上 新手友好度 10/100
OAI/OpenAPI-Specification#5556 · 3 則留言 ·
維護者通常 1 天內回覆
-
v3.2.1 release可能重新可做 @lornajane 於 34 天前認領，目前沒有進行中的 PR。 未關閉
OAI/OpenAPI-Specification#5460 · 11 則留言 · 1 個 reaction · 已指派 1 人 ·
維護者通常 1 天內回覆
-
param serialization
難度 5/5 一週以上 新手友好度 25/100
OAI/OpenAPI-Specification#5366 · 12 則留言 ·
維護者通常 1 天內回覆
查看 OAI/OpenAPI-Specification 的全部 Issue
相似的 Issue
-
approved Good First Issue scope: docs
難度 1/5 1 小時以內 新手友好度 85/100
hiero-ledger/hiero-sdk-python#2730 · 3 則留言 ·
維護者通常 1 天內回覆
-
bug needs-triage
難度 1/5 1 小時以內 新手友好度 78/100
mattpocock/skills#1281 ·
維護者通常 1 天內回覆
-
sync-en
難度 1/5 1-3 小時 新手友好度 68/100
維護者通常 4 天內回覆
-
[oblt-aw][autodoc] Update PR Actions Detective E2E prerequisites and fix dashboard-format table typo未關閉documentation
難度 2/5 1-3 小時 新手友好度 75/100
elastic/oblt-aw#2382 · 1 則留言 ·
維護者通常 1 天內回覆
-
Перевод устарел
難度 2/5 半天 新手友好度 62/100