Path Templating with multiple parameters allows for ambiguous parsing
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- openapi
- 領域
- api
研究方向
從此 issue 中的 path-template 範例開始,檢視 OpenAPI 規範關於路徑參數和作業比對的規則。當規範為諸如 /a🅱️c/update 這樣的 URL 定義出明確且無歧義的解釋,包括參數限制如何影響比對時,這項工作就完成了。
由索引模型根據 Issue 內容生成。
描述
Currently the support for path segments is ambiguous even in simple cases:
Consider:
paths:
/{foo}:{bar}/update:
post:
summary: Example API with multiple parameters
parameters:
- name: foo
in: path
description: Foo
required: true
schema:
type: string
- name: bar
in: path
description: Bar
required: true
schema:
type: string
If the URL /a:b:c/update is received, there are two possible parses which, as far as I can tell, the spec doesn't state which is correct.
foo=a,bar=b:cfoo=a:b,bar=c
This means that two different implementations may have different interpretations of how parameters map through.
Note, from an implementation perspective, this gets more challenging, as in order to parse the URL to work out which operation it is, you need to know the full structure of the path parameter, as that may break the ambiguity (e.g. if bar is an enum which can only take values c, or d, then the parse collapses into the second option).
- 主要語言
- Markdown
- 星號
- 31.3k
- 分支
- 9.2k
- 平均合併
- 2 天 3 小時
- 30 天內合併 PR
- 8
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
OAI/OpenAPI-Specification 的其他 Issue
-
Housekeeping
難度 1/5 1 小時以內 新手友好度 8/100
OAI/OpenAPI-Specification#5571 ·
維護者通常 1 天內回覆
-
難度 5/5 一週以上 新手友好度 15/100
OAI/OpenAPI-Specification#5570 ·
維護者通常 1 天內回覆
-
Housekeeping
難度 1/5 1 小時以內 新手友好度 45/100
OAI/OpenAPI-Specification#5566 · 5 則留言 ·
維護者通常 1 天內回覆
-
Housekeeping
難度 1/5 1 小時以內 新手友好度 35/100
OAI/OpenAPI-Specification#5562 · 4 則留言 ·
維護者通常 1 天內回覆
-
v3.2.1 release可能重新可做 @lornajane 於 36 天前認領,目前沒有進行中的 PR。 未關閉
OAI/OpenAPI-Specification#5460 · 11 則留言 · 1 個 reaction · 已指派 1 人 ·
維護者通常 1 天內回覆
查看 OAI/OpenAPI-Specification 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
debpalash/VoiceStudio#2936 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 76/100
melgarafael/DeskcommCRM#3000 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
components-web-app/docs#243 ·
-
OFN writer emits `DocIRI` as a bare IRI, which becomes a version IRI or a parse error on re-read未關閉
難度 2/5 1-3 小時 新手友好度 72/100
phillord/horned-owl#338 ·
維護者通常 1 天內回覆