Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

use 'OpenAPI link' to detect relations between entities

Aperta
#129 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
openapi, typescript
Ambito
api, backend-api-design

Direzione di ricerca

Leggi prima la sezione relation-convention del README e la specifica OpenAPI Links collegata. L’issue non indica alcun file di implementazione, criterio di accettazione o test; chiarisci come i Links debbano fornire i metadati della relazione e quale comportamento esistente della convenzione debba essere coperto. Il completamento non può essere verificato finché questo ambito e i relativi test non sono definiti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
113
Fork
80
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di api-platform/api-doc-parser

Tutte le issue di api-platform/api-doc-parser

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.