Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

use 'OpenAPI link' to detect relations between entities

Aberta
#129 1 comentário 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
openapi, typescript

Direção de pesquisa

Leia primeiro a seção relation-convention do README e a especificação OpenAPI Links vinculada. A issue não indica nenhum arquivo de implementação, critério de aceitação ou teste; esclareça como os Links devem fornecer metadados de relação e qual comportamento existente da convenção precisa ser coberto. Não é possível verificar a conclusão até que esse escopo e seus testes sejam definidos.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
113
Forks
80
Merge médio
2d 18h
PRs com merge (30d)
3

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de api-platform/api-doc-parser

Todas as issues de api-platform/api-doc-parser

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.