OAI / OAI/OpenAPI-Specification

More example `same hierarchy` in path templating

オープン
#2,015 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

clarification examples request matching
主要言語
Markdown
スター
31.2k
フォーク
9.2k
平均マージ
6時間 37分
マージ済み PR(30日)
27

説明

We can't describe different templated name with same hierarchy.

Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical.

But I can't understand what the same hierarchy means.

We can't describe these path templates

  /pets/{petId}
  /pets/{name}

But we can describe these?

  /pets/{petId}
  /pets/{name}/hello

These depth of the hierarchy is different but these is different templated name in same depth of hierarchy.
When we get /pets/1/hello we can match bottom paths and name=1.
These is partially the same, but the whole is different.

So I want to add more example to this section.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

引用されている「same hierarchy」ルールを含む仕様のセクションを見つけ、その周辺にあるパスのテンプレート化に関するガイダンスを読んでください。/pets/{petId} と /pets/{name} が競合する一方で、より深い /pets/{name}/hello パスは異なる理由を明確にする例を追加し、その文言がルールと一致していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
openapi
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。