Add support for $schema and jsonSchemaDialect

Aberta
#2,963 5 comentários 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
35/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
csharp, openapi
Domínio
api, backend-api-design

Direção de pesquisa

Comece rastreando os desserializadores e serializadores de OpenAPISchema e identificando onde a suposição 2020-12 é aplicada. Defina o serviço JSON Schema em torno do registro de dialetos, da resolução de fallback, do tratamento recursivo de schemas desconhecidos e das restrições de segurança; considera-se concluído quando $schema e jsonSchemaDialect selecionarem o dialeto conhecido ou carregado correto sem quebrar o comportamento existente.

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

Descrição

help wanted

In today's implementation (2.11.0, 3.9.0), the deserialization and serialization of JSON Schemas is effectively hard-coded to 2020-12.

However, starting with OpenAPI 3.1, people can set the $schema property of any given schema to a different dialect (default being documented here.

This entails a couple of things:

  1. parsing that keyword first if it exists, or falling back on the document dialect property, or falling back to the default value for the OpenAPI version.
  2. if that value is known (like https://spec.openapis.org/oas/3.1/dialect/base using the parsing logic associated with that entry
  3. if that value is unknown, we need to load the corresponding schema, and read its schema (recursively) until we find a known value. (note be careful of the security considerations here)

Note: ideally we'd make the OpenAPISchema type generic and allow the caller to provide new registrations of schemas uris with the corresponding parsing logic and data type, but that'd introduce major breaking changes, making the cost prohibitive.

That update will most likely require introducing a JSON Schema service of some kind in charge of mapping the known schemas with their deserialization logic, and having the OpenAPISchema deserializers call into that service.

Linguagem predominante
C#
Estrelas
1.6k
Forks
286
Merge médio
6h 38min
PRs com merge (30d)
35

Guia de contribuição

Abrir o guia de contribuição

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 microsoft/OpenAPI.NET

Todas as issues de microsoft/OpenAPI.NET

Issues semelhantes

Mais issues de C#

Receba novas issues na sua caixa de entrada

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