[RFC] Handle OpenAPI 3.1 BC Breaks
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- openapi, php
- Área
- api, backend-api-design
Línea de trabajo
Empieza leyendo los archivos de especificación existentes de OpenAPI 3.0 y los cambios de pull request 128; después, compáralos con los breaking changes indicados de OpenAPI 3.1 y las release notes enlazadas. Este RFC solo estará terminado cuando los maintainers hayan elegido y documentado un enfoque para representar 3.1 sin romper el soporte de 3.0 ya completado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
It's nice to see the work for the OpenAPI 3.1 standard. I think a big part are the deprecated fields or type changes like:
- The nullable keyword has been removed from the Schema Object (null can be used as a type value).
- the type can be now an array with the type and
null - exclusiveMaximum and exclusiveMinimum cannot accept boolean values (following JSON Schema).
- See more at Stoplight Blog and OpenAPI Release Notes
How would you like to handle these breaking changes?
My first idea was to duplicate the spec files into a 3.0 and 3.1 Folder and use them according to the given OpenAPI version.
The positive parts are that static code analysis or the IDE knows which type of Object is used and the user don't have to handle multiple types. For example the type as string in OpenAPi 3.0 and type as array in OpenAPI 3.1 with null item. Also the spec could be validated and it's not necessary to add version switches for fields that are required or not.
The second Idea is to "convert" the Structure into the existing Spec Files. So a type with two items in OpenAPI would be an oneOf or if the type includes null the nullable flag would be added. But then you need to convert the items back to the new structure if you want to write a OpenAPI 3.1 file. The other part is, that you then support a converter from OpenAPI 3.0 to OpenAPI 3.1 and i don't think this is a feature to maintain in this library.
The last solution is to try to handle both versions into a single file. But that could be hard because of the breaking changes in OpenAPI 3.1. Even OpenAPI 3.1 didn't make a release without breaking changes. It could be complex to handle it here.
My preferred solution is version one because of the strict types and the clear break between Version 3.0 and 3.1
The Version and Specs for Version 3.0 are already feature complete and all changes effects only the new Spec files and couldn't break anything.
I look forward to your opinion. Maybe this should be clear before we make more changes into https://github.com/cebe/php-openapi/pull/128 ?
- Lenguaje dominante
- PHP
- Estrellas
- 500
- Forks
- 99
- Métricas de merge de PR
- 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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de cebe/php-openapi
-
Deprecated warnings in PHP 8.2 Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
cebe/php-openapi#250 ·
-
BC break in 1.8 Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
cebe/php-openapi#247 · 1 comentario · 1 reacción ·
-
php 8.4 deprecations Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 58/100
cebe/php-openapi#245 · 3 comentarios ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 52/100
cebe/php-openapi#242 · 6 comentarios · 1 reacción ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 55/100
cebe/php-openapi#238 ·
Todos los issues de cebe/php-openapi
Issues similares
-
needs-triage Platform(Default)
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
-
bug No Code Attached Yet
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
joomla/joomla-cms#48501 ·
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
sync-en
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
Перевод устарел
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100