Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

use 'OpenAPI link' to detect relations between entities

Abierto
#129 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
20/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
openapi, typescript
Área
api, backend-api-design

Línea de trabajo

Lee primero la sección relation-convention del README y la especificación OpenAPI Links enlazada. El issue no indica ningún archivo de implementación, criterios de aceptación ni pruebas; aclara cómo deben proporcionar los Links los metadatos de relación y qué comportamiento existente de la convención debe quedar cubierto. No se puede verificar que esté terminado hasta que se definan ese alcance y sus pruebas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
TypeScript
Estrellas
113
Forks
80
Sin PR fusionados en 30 d

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de api-platform/api-doc-parser

Todos los issues de api-platform/api-doc-parser

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.