api-platform / api-platform/api-doc-parser

use 'OpenAPI link' to detect relations between entities

Open
#129 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
113
Forks
80
PR merge metrics
No merged PRs in 30d

Description

**Description**
Why do you not use [OpenAPI links](https://swagger.io/docs/specification/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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.