Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

use 'OpenAPI link' to detect relations between entities

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
openapi, typescript

調査の方向性

まず README の relation-convention セクションと、リンクされている OpenAPI Links 仕様を読んでください。この issue には実装ファイル、受け入れ条件、テストのいずれも指定されていません。Links が関係メタデータをどのように提供すべきか、また既存の convention のどの動作をカバーする必要があるかを明確にしてください。そのスコープとテストが定義されるまで、完了したことは検証できません。

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

説明

Description
Why do you not use OpenAPI links to detect relations between entities instead of use the current conventions name based?

See:
https://github.com/api-platform/api-doc-parser/blob/895cd81e4208c8c70a7383f65cefc31f1706c353/README.md?plain=1#L57

In order to reference the resources between themselves (embeddeds or relations), the library guesses embeddeds or references from property names.
For instance if a book schema has a reviews property, the library tries to find a Review resource.
If there is, a relation or an embedded between Book and Review resources is made for the reviews field.
The property name can also be like review_id, reviewId, review_ids or reviewIds for references.

I'm discussing about this possibility on platformatic repository, here:
https://github.com/platformatic/platformatic/pull/446

主要言語
TypeScript
スター
113
フォーク
80
PR マージ指標
30日以内にマージされた PR はありません

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

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

api-platform/api-doc-parser のほかの issue

api-platform/api-doc-parser の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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